Grasscutters/Cultivation
1
0
Fork 0
mirror of https://github.com/Grasscutters/Cultivation.git synced 2024-11-23 03:49:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A custom launcher designed to make it as easy as possible to proxy anime game traffic to private servers.
450 Commits 18 Branches 21 Tags 30 MiB
TypeScript 53.1%
Rust 27.5%
C 8.3%
CSS 7.3%
C++ 3.6%
Other 0.2%
e9df0f17db
Go to file
Brian Bowman e9df0f17db Tweak .editorconfig and line endings 
- Use `lf` line endings everywhere. This works fine even on Windows, and is more common for git repos. It also matches prettier's default.

For .editorconfig:

- Remove `insert_final_newline = false`: Omitting the final newline isn't supported by prettier or rustfmt.
- Remove `trim_trailing_whitespace = false`: The formatters will remove trailing whitespace anyways. I can't think of a good reason to want to keep trailing whitespace.
- Remove other redundant options.
2022-07-19 20:42:43 -05:00
.github/workflows Add rustfmt CI check 2022-07-12 20:10:05 -05:00
.idea Add allowed http URLs 2022-07-01 16:25:38 -04:00
docs remove hover and disabled state docs for bigbutton class 2022-07-05 20:48:34 +02:00
public QoL changes & code formatting 2022-06-01 17:28:48 -04:00
src set proxy addr only when launching with proxy 2022-07-19 17:52:17 -07:00
src-tauri Tweak .editorconfig and line endings 2022-07-19 20:42:43 -05:00
.editorconfig Tweak .editorconfig and line endings 2022-07-19 20:42:43 -05:00
.eslintrc.json Add prettier formatter 2022-07-19 20:42:43 -05:00
.gitattributes Tweak .editorconfig and line endings 2022-07-19 20:42:43 -05:00
.gitignore Move things to file_helpers 2022-07-12 14:28:08 +08:00
.prettierignore Add prettier formatter 2022-07-19 20:42:43 -05:00
.prettierrc.json Add prettier formatter 2022-07-19 20:42:43 -05:00
LICENSE Create LICENSE 2022-05-27 12:07:45 -04:00
package.json Add prettier formatter 2022-07-19 20:42:43 -05:00
README.md Clean up readme 2022-07-18 18:01:08 -05:00
THEMES.md Merge pull request #15 from TukanDev/main 2022-07-05 11:49:53 -07:00
tsconfig.json Get background file name 2022-05-14 02:18:20 -04:00
yarn.lock Add prettier formatter 2022-07-19 20:42:43 -05:00

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.

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

Find release builds here!

Once downloaded, extract somewhere and open as administrator.

Developer Quickstart

Setup

  • Install NodeJS >12
  • Install yarn (cry about it npm lovers)
  • Install Rust
  • yarn install
  • yarn start:dev

Building

For a release build,

  • yarn build

For a debug build,

  • yarn build --debug

Code Formatting and Linting

  • yarn format
  • yarn lint

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!

Screenshots

image image image image image

Credits

  • SpikeHD: For originally creating GrassClipper and creating the amazing UI of Cultivation.
  • KingRainbow44: For building a proxy daemon from scratch and integrating it with Cultivation.
  • Benj: For assistance in client patching.
  • lilmayofuksu: For assistance in client patching.
  • Tauri: For providing an amazing, efficient, and simple desktop application framework/library.