# JadeSR
(i want to protect this from search indexing please don't mention the animegame or company
### A Server emulator for the game `Hon Aki: Railway Game`
### except, it's a fork with some more features

## Installation

### From Source

#### Requirements

- [Rust](https://www.rust-lang.org/tools/install)

#### Building

##### Manually

```sh
git clone https://git.xeondev.com/reversedrooms/JadeSR.git
cd JadeSR
cargo build --bin gameserver
cargo build --bin dispatch
cargo build --bin sdkserver
```

##### Using xtasks (use this if stupid)

```sh
cargo xtask run
```

##### To run it with automatic recompilation when any Rust files are changed

```sh
cargo xtask watch
```

### ~~From Pre-built Binaries~~
I haven't got prebuilt binaries. Build it yourself using above commands. Or, just use RUNPS.bat
~~Navigate to the [Releases](https://git.xeondev.com/reversedrooms/JadeSR/releases) 
page and download the latest release for your platform.~~

## Usage

To begin using the server, you need to run both the SDK server and the game server.

If you installed from pre-built binaries, navigate to the directory where you downloaded
the binaries and either a) double-click on the following executable names or b)
run the following in a terminal:

```sh
./gameserver
./dispatch
./sdkserver
```

##### Note: the `assets` folder should be in the same directory with the `gameserver`, otherwise it will panic.

## Connecting

[Get 2.3 beta client](https://autopatchos.starrails.com/client/Beta/20240501125700_dUBAjS7YiX9nF7mJ/StarRail_2.2.51.zip),
replace [mhypbase.dll](https://git.xeondev.com/reversedrooms/JadeSR/raw/branch/master/mhypbase.dll)
file in your game folder, it will redirect game traffic (and disable in-game censorship)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss
what you would like to change, and why.

## Bug Reports

If you find a bug, please open an issue with as much detail as possible. If you
can, please include steps to reproduce the bug.

Bad issues such as "This doesn't work" will be closed immediately, be _sure_ to
provide exact detailed steps to reproduce your bug. If it's hard to reproduce, try
to explain it and write a reproducer as best as you can.