Grasscutters/Cultivation
1
0
Fork 0
mirror of https://github.com/Grasscutters/Cultivation.git synced 2024-11-23 20:09: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.
386 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%
bb383c5c0a
Go to file
SpikeHD bb383c5c0a manual proxy cert install
2022-07-16 16:59:16 -07: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 manual proxy cert install 2022-07-16 16:59:16 -07:00
src-tauri manual proxy cert install 2022-07-16 16:59:16 -07:00
.editorconfig Configure and run rustfmt 2022-07-12 20:10:05 -05:00
.eslintrc.json Fix tsc and ESLint warnings 2022-07-12 20:10:05 -05:00
.gitignore crossplatform build scripts that move lang folder 2022-05-28 21:14:15 -07:00
LICENSE Create LICENSE 2022-05-27 12:07:45 -04:00
package.json Add format and lint scripts 2022-07-12 20:10:05 -05:00
README.md Update README.md 2022-07-16 14:43:29 -07: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 cleanup and yarn update 2022-07-12 17:21:03 -07:00

README.md

Cient 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

Building

npm run build or yarn build

Add --release or --debug depending on what release you are creating. This defaults to --release

Code Formatting and Linting

Format the code with npm format or yarn format. Run the lints with npm lint or yarn lint.

Updating

  • 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.
  • Run npm run update or yarn build
  • The update will be in src-tauri/target/(release|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip

Troubleshooting

TODO. Collect common issues before updating.

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.
  • Tauri: For providing an amazing, efficient, and simple desktop application framework/library.