Cultivation/README.md

# Client Patching Notice

For game versions 2.8 and above, Cultivation automatically makes a small patch to your game client when launching using Grasscutter, and restores it upon closing the game. In theory, you should still be totally safe, however it would be dishonest to not explicitly state that **modifying the game client could, theoretically, lead to a ban if you connect to official servers with it**. It is extremely unlikely AND there are no instances known of it happening, but the possibility exists.

EN | [简中](README_zh-CN.md)

# Cultivation

A game launcher designed to easily proxy traffic from anime game to private servers.

While the Cultivation repository is **open**. This does **not** mean it has released.
Please do **NOT install, download, or use pre-compiled versions of Cultivation found elsewhere**. Only use releases from this GitHub repository.

# Table Of Contents

- [Download](#download)
- [Developer Quick-start](#developer-quickstart)
  - [Setup](#setup)
  - [Building](#building)
  - [Code Formatting and Linting](#code-formatting-and-linting)
  - [Generating Update Artifacts](#generating-update-artifacts)
- [Theming](#theming)
- [Screenshots](#screenshots)
- [Credits](#credits)

# Download

[Find release builds here!](https://github.com/Grasscutters/Cultivation/releases)

Once downloaded, extract somewhere and open as administrator.

# Developer Quickstart

### Setup

- Install [NodeJS >12](https://nodejs.org/en/)
- Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install) (cry about it `npm` lovers)
- Install [Rust](https://www.rust-lang.org/tools/install)
- `yarn install`
- `yarn start:dev`

### Building

For a release build,

- `yarn build`

For a debug build,

- `yarn build --debug`

### Code Formatting and Linting

Formatting:

- `yarn format`

Check Lints, fix (some) lints:

- `yarn lint`, `yarn lint:fix`

### Generating Update Artifacts

- Add the `TAURI_PRIVATE_KEY` as an environment variable with a path to your private key.
- Add the `TAURI_KEY_PASSWORD` as an environment variable with the password for your private key.
- `yarn build`

The update will be at `src-tauri/target/(release|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip`

# Theming

A full theming reference can be found [here!](/THEMES.md)

# Screenshots

![image](https://user-images.githubusercontent.com/25207995/173211603-e5e85df7-7fd3-430b-9246-749ebbc1e483.png)
![image](https://user-images.githubusercontent.com/25207995/173211543-b7e88943-cfd2-418b-ac48-7f856868129b.png)
![image](https://user-images.githubusercontent.com/25207995/173211561-a1778fdc-5cfe-4687-9a00-44500d29e470.png)
![image](https://user-images.githubusercontent.com/25207995/173211573-8cedfa9a-51c9-4670-a4f7-a334a2fabec5.png)
![image](https://user-images.githubusercontent.com/25207995/173211590-6a2242b5-1e8f-4db9-a5c7-06284688b131.png)

## Credits

- [SpikeHD](https://github.com/SpikeHD): For originally creating **GrassClipper** and creating the amazing UI of Cultivation.
- [KingRainbow44](https://github.com/KingRainbow44): For building a proxy daemon from scratch and integrating it with Cultivation.
- [Benj](https://github.com/4Benj): For assistance in client patching.
- [lilmayofuksu](https://github.com/lilmayofuksu): For assistance in client patching.
- [Tauri](https://tauri.app): For providing an amazing, efficient, and simple desktop application framework/library.
Clean up readme 2022-07-19 06:42:27 +08:00			`# Client Patching Notice`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Update README.md 2022-07-17 05:43:29 +08:00			`For game versions 2.8 and above, Cultivation automatically makes a small patch to your game client when launching using Grasscutter, and restores it upon closing the game. In theory, you should still be totally safe, however it would be dishonest to not explicitly state that modifying the game client could, theoretically, lead to a ban if you connect to official servers with it. It is extremely unlikely AND there are no instances known of it happening, but the possibility exists.`
Add pre-release notes to the README. 2022-06-29 13:32:07 +08:00
Updated instructions 2022-08-05 21:22:40 +08:00			`EN \| [简中](README_zh-CN.md)`

Update README.md 2022-05-09 06:44:42 +08:00			`# Cultivation`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Add pre-release notes to the README. 2022-06-29 13:32:07 +08:00			`A game launcher designed to easily proxy traffic from anime game to private servers.`
Initialize project using Create React App 2022-05-09 06:11:43 +08:00
Update README.md 2022-07-17 05:43:29 +08:00			`While the Cultivation repository is open. This does not mean it has released.`
			`Please do NOT install, download, or use pre-compiled versions of Cultivation found elsewhere. Only use releases from this GitHub repository.`

Update README.md 2022-06-12 10:22:48 +08:00			`# Table Of Contents`
Clean up readme 2022-07-19 06:42:27 +08:00
Run prettier formatter 2022-07-19 17:37:38 +08:00			`- [Download](#download)`
			`- [Developer Quick-start](#developer-quickstart)`
			`- [Setup](#setup)`
			`- [Building](#building)`
			`- [Code Formatting and Linting](#code-formatting-and-linting)`
			`- [Generating Update Artifacts](#generating-update-artifacts)`
			`- [Theming](#theming)`
			`- [Screenshots](#screenshots)`
			`- [Credits](#credits)`
Update README.md 2022-06-12 10:22:48 +08:00
			`# Download`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Add pre-release notes to the README. 2022-06-29 13:32:07 +08:00			`[Find release builds here!](https://github.com/Grasscutters/Cultivation/releases)`
Update README.md 2022-06-12 10:22:48 +08:00
Add pre-release notes to the README. 2022-06-29 13:32:07 +08:00			`Once downloaded, extract somewhere and open as administrator.`
Update README.md 2022-06-12 10:22:48 +08:00
			`# Developer Quickstart`

			`### Setup`
Run prettier formatter 2022-07-19 17:37:38 +08:00
			`- Install [NodeJS >12](https://nodejs.org/en/)`
			- Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install) (cry about it `npm` lovers)
			`- Install [Rust](https://www.rust-lang.org/tools/install)`
			- `yarn install`
			- `yarn start:dev`
Update README.md 2022-06-12 10:22:48 +08:00
			`### Building`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			`For a release build,`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			- `yarn build`
Update README.md 2022-06-12 10:22:48 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			`For a debug build,`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			- `yarn build --debug`
Update README.md 2022-06-12 10:22:48 +08:00
Document how to run formatting and linting scripts 2022-07-13 12:19:59 +08:00			`### Code Formatting and Linting`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Add `lint:fix` script 2022-07-20 07:33:16 +08:00			`Formatting:`

Clean up readme 2022-07-19 06:42:27 +08:00			- `yarn format`
Add `lint:fix` script 2022-07-20 07:33:16 +08:00
			`Check Lints, fix (some) lints:`

			- `yarn lint`, `yarn lint:fix`
Document how to run formatting and linting scripts 2022-07-13 12:19:59 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			`### Generating Update Artifacts`
Run prettier formatter 2022-07-19 17:37:38 +08:00
			- Add the `TAURI_PRIVATE_KEY` as an environment variable with a path to your private key.
			- Add the `TAURI_KEY_PASSWORD` as an environment variable with the password for your private key.
			- `yarn build`
Add information regarding the update system 2022-06-29 06:16:41 +08:00
Clean up readme 2022-07-19 06:42:27 +08:00			The update will be at `src-tauri/target/(release\|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip`
Update README.md 2022-06-12 10:22:48 +08:00
theming documentation 2022-07-03 12:06:14 +08:00			`# Theming`

			`A full theming reference can be found [here!](/THEMES.md)`

Update README.md 2022-06-12 10:22:48 +08:00			`# Screenshots`
Run prettier formatter 2022-07-19 17:37:38 +08:00
Update README.md 2022-06-12 10:22:48 +08:00			`![image](https://user-images.githubusercontent.com/25207995/173211603-e5e85df7-7fd3-430b-9246-749ebbc1e483.png)`
			`![image](https://user-images.githubusercontent.com/25207995/173211543-b7e88943-cfd2-418b-ac48-7f856868129b.png)`
			`![image](https://user-images.githubusercontent.com/25207995/173211561-a1778fdc-5cfe-4687-9a00-44500d29e470.png)`
			`![image](https://user-images.githubusercontent.com/25207995/173211573-8cedfa9a-51c9-4670-a4f7-a334a2fabec5.png)`
			`![image](https://user-images.githubusercontent.com/25207995/173211590-6a2242b5-1e8f-4db9-a5c7-06284688b131.png)`

Add pre-release notes to the README. 2022-06-29 13:32:07 +08:00			`## Credits`
Run prettier formatter 2022-07-19 17:37:38 +08:00
			`- [SpikeHD](https://github.com/SpikeHD): For originally creating GrassClipper and creating the amazing UI of Cultivation.`
			`- [KingRainbow44](https://github.com/KingRainbow44): For building a proxy daemon from scratch and integrating it with Cultivation.`
			`- [Benj](https://github.com/4Benj): For assistance in client patching.`
			`- [lilmayofuksu](https://github.com/lilmayofuksu): For assistance in client patching.`
			`- [Tauri](https://tauri.app): For providing an amazing, efficient, and simple desktop application framework/library.`