jadeite/README.md

69 lines
5.4 KiB
Markdown
Raw Normal View History

2023-06-05 21:23:08 +00:00
### Games and regions
2023-10-01 08:04:01 +00:00
- **3rd**: glb/sea/tw/kr/jp **v6.9.0+**, cn **v7.0.0+**
2023-10-09 16:27:24 +00:00
- **SR**: os/cn **v1.4.0** (potentially unsafe, but no bans were reported since v1.1.0)
2023-06-08 19:33:37 +00:00
You can expect newer versions to work immediately after release with the same jadeite binary if the version is specified with a + above (currently none).
2023-06-05 21:23:08 +00:00
### Information
2023-07-07 11:14:28 +00:00
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`).
2023-06-05 21:23:08 +00:00
2023-06-10 10:07:47 +00:00
**SR-specific**: this tool disables the use of DirectX shared resources in a rather hacky way. It is required, as there is no (and most likely never will be) shared resources support in DirectX translation layers (WineD3D/DXVK). Refer to [configuration](#configuration) if you wish to run the game without the fix.
**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.
2023-06-05 21:23:08 +00:00
### Usage
2023-07-02 17:50:49 +00:00
**Refer to [third-party launchers](#third-party-launchers)** for convenient usage. If you don't want to (or can't) use third-party launchers, continue reading the section below.
2023-06-05 21:23:08 +00:00
**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.**
2023-09-11 19:30:52 +00:00
**3rd-specific**:
- ~~In some cases, and if you're not using Proton GE, a fix for Media Foundation may be required to play videos. The Game may crash without it. You can download it from [here](https://github.com/z0z0z/mf-install).~~ **Unfortunately, it appears like the fix is no longer available, please use [Wine-GE-Proton](https://github.com/GloriousEggroll/wine-ge-custom) instead.**
- You might need to [limit the number of cores available to the game](https://github.com/z0z0z/mf-install/issues/44) if your CPU has more than 8.
2023-06-05 21:23:08 +00:00
Manual usage instructions:
- Download the game you want to run
2023-08-06 16:26:02 +00:00
- Download the latest release from this repository
2023-06-05 21:23:08 +00:00
- Extract the archive (**NOT INTO THE GAME DIRECTORY! THIS IS IMPORTANT!**)
2023-08-06 16:32:29 +00:00
- 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
2023-06-09 18:10:44 +00:00
- Run `wine jadeite.exe 'Z:\wine\path\to\game.exe'`
2023-06-05 21:23:08 +00:00
2023-06-09 18:10:44 +00:00
This tool is capable of starting the games from a different process. This may be useful for spoofing the parent process (SR is known to report it). Use `wine jadeite.exe 'Z:\wine\path\to\game.exe' 'Z:\wine\path\to\launcher.exe'`. `explorer.exe` is used as the default.
2023-06-05 21:23:08 +00:00
To pass commandline arguments to the game, append them after the launcher path: `wine jadeite.exe 'Z:\wine\path\to\game.exe' 'Z:\wine\path\to\launcher.exe' -arg1 -arg2 -arg3`. To use the default launcher process, use `--`: `wine jadeite.exe 'Z:\wine\path\to\game.exe' -- -arg1 -arg2 -arg3`.
2023-06-08 19:33:37 +00:00
### Configuration
2023-07-07 11:14:28 +00:00
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.
2023-06-08 19:33:37 +00:00
2023-06-10 16:24:07 +00:00
- `WAIT_BEFORE_RESUME=1` - show a messagebox and wait for user input before resuming the game process. Useful on my side for debugging
2023-06-10 15:23:43 +00:00
2023-06-10 10:07:47 +00:00
**SR-exclusive**:
2023-07-07 11:14:28 +00:00
- `SRFIX_DISABLE=1` - disable shared resources fix. Not recommended. Doing so will most likely cause the game to not run at all
2023-06-08 19:33:37 +00:00
2023-06-05 21:23:08 +00:00
### Internals
2023-07-07 11:14:28 +00:00
This tool consists of three parts: the main injector (`injector/src/exe.c`), the launcher payload (`injector/src/dll.c`) and the game payload (`game_payload`).
2023-06-05 21:23:08 +00:00
I am very bad at explaining, so just take a look at the source code. Maybe I'll write a detailed explanation in the future.
2023-07-27 22:51:04 +00:00
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.
2023-06-05 21:23:08 +00:00
### 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
2023-07-02 17:51:49 +00:00
- Honkers Launcher — Linux launcher for 3rd ([GitHub](https://github.com/an-anime-team/honkers-launcher) | [Codeberg](https://codeberg.org/an-anime-team/honkers-launcher))
- The Honkers Railway Launcher — Linux launcher for SR ([GitHub](https://github.com/an-anime-team/the-honkers-railway-launcher) | [Codeberg](https://codeberg.org/an-anime-team/the-honkers-railway-launcher))
2023-06-05 21:23:08 +00:00
### Credits
- mkrsym1 — project leader, reverse engineering
2023-07-02 20:48:54 +00:00
- [EternalStudentDesuKa](https://github.com/EternalStudentDesuKa) — major help with analyzing network activity
- [An Anime Team](https://github.com/an-anime-team) — Honkers Launcher and The Honkers Railway Launcher
2023-06-05 21:23:08 +00:00
- Some others credited in the source code
License: MIT