jadeite/README.md
2024-02-02 12:13:03 +02:00

5.1 KiB

Jadeite Autopatcher

Current game support:

  • 3rd: glb/sea/tw/kr/jp v7.2.0+, cn v7.3.0+
  • SR: os/cn v1.6.0*

You can expect newer versions to work immediately after release with the same jadeite binary if the version is specified with a + above.

Note: you can test the experimental version-independent patching method for SR. See #37.

Information

The anticheat the games use is fundamentally incompatible with Wine in multiple ways. This tool launches the game without it (injector) and imitates it's behaviour (game_payload).

Using third-party software (such as this tool) with the games violates their Terms of Service. Therefore, you may receive a ban. No bans were ever reported with 3rd, however the legacy patch for SR did cause many. Use at your own risk and only if you understand all the possible consequences.

This is not a cheating tool. Using it with Windows is not possible, and Windows support is not planned or intended in any way. However, as it does not perform any on-disk file modifications, you may reuse the same game install for Windows if you have a dual-boot setup.

Usage

Refer to third-party launchers for convenient usage. If you don't want to (or can't) use third-party launchers, continue reading the section below

Wine 8.0+ is recommended, as lower versions leak "The Wine project" as the device identifier. Not critical, but taking a precaution never hurt anyone. DXVK is strongly recommended

3rd-specific:

Manual usage instructions:

  • Download the game you want to run
  • Download the latest release from this repository
  • Extract the archive (NOT INTO THE GAME DIRECTORY! THIS IS IMPORTANT!)
  • Run ./block_analytics.sh from the archive to block the games from accessing analytics servers (you might have to do a chmod +x block_analytics.sh first). This will require superuser privileges
  • Run wine jadeite.exe 'Z:\wine\path\to\game.exe'

Detailed command line interface reference: jadeite.exe [game path] <launcher path> <game args...>, where:

  • game path - Wine path to the game (required)
  • launcher path - Wine path to the launcher process (optional, default is C:\Windows\explorer.exe). The launcher process will be used to start the game. You can specify the path to the official launcher here. Specifying anything other than explorer.exe or the official launcher is not recommended. Specify -- to skip this argument and use the default
  • game args... - arguments to pass to the game process (optional)

Example command: jadeite.exe 'Z:\path\to\game.exe' -- -screen-fullscreen 1

Configuration

These environment variables can be used to configure the behaviour of the tool. Any value except empty string counts as set. 1 will be used in all examples.

Global:

  • WAIT_BEFORE_RESUME=1 - show a messagebox and wait for user input before resuming the game process. Useful on my side for debugging

SR-specific:

  • BREAK_CRYPTCAT=1 - use the experimental patching method. See #37 for details

Internals and building

To compile jadeite, you will need meson, mingw and nasm. You can probably install all three using your repository's package manager. Once all dependencies are installed, run ./build.sh in this directory. The compiled files will be located in ./out.

A part of the source code is witheld (game_payload/src/core.c). This is a forced measure to make abuse more difficult. However, a precompiled blob is provided in the repo. build.sh will use it automatically.

All source code except core.c is available in this repository. You can take look around.

Guildelines

  1. Please don't share this project in public. This might attract unnecessary attention from either the Game Company or the Anticheat Company
  2. Please don't abuse this project for cheating. We're just trying to play the games through Wine

Troubleshooting

Please do not report any issues with the Game to the official channels. Use the issue tracker of this repository

Third-party launchers

  • Honkers Launcher — Linux launcher for 3rd (GitHub | Codeberg)
  • The Honkers Railway Launcher — Linux launcher for SR (GitHub | Codeberg)

Credits

  • mkrsym1 — project leader, reverse engineering
  • EternalStudentDesuKa — major help with analyzing network activity
  • An Anime Team — Honkers Launcher and The Honkers Railway Launcher
  • Some others (credited in the source code)

License: MIT