docs: update README
This commit is contained in:
parent
8c6f563c06
commit
92a206ba33
1 changed files with 75 additions and 1 deletions
76
README.md
76
README.md
|
@ -1,3 +1,77 @@
|
|||
# HollowPS
|
||||
|
||||
Zenless Zone Zero server emulator
|
||||
A Server emulator for the game [`Zenless Zone Zero`](https://zenless.hoyoverse.com/en-us/)
|
||||
|
||||
## Installation
|
||||
|
||||
### From Source
|
||||
|
||||
#### Requirements
|
||||
|
||||
- [Rust](https://www.rust-lang.org/tools/install)
|
||||
|
||||
**NOTE**: Nightly Rust is required to build the project. To install it, first install Rust itself, then run the following command:
|
||||
|
||||
```sh
|
||||
rustup toolchain install nightly
|
||||
rustup default nightly
|
||||
```
|
||||
|
||||
#### Building
|
||||
|
||||
```sh
|
||||
git clone https://git.xeondev.com/reversedrooms/HollowPS.git
|
||||
cd HollowPS
|
||||
cargo install --path gameserver
|
||||
cargo install --path sdkserver
|
||||
```
|
||||
|
||||
### From Prebuilt Binaries
|
||||
|
||||
Navigate to the [Releases](https://git.xeondev.com/reversedrooms/HollowPS/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 source, Rust's installer should have added .cargo/bin to your
|
||||
path, so simply run the following:
|
||||
|
||||
```sh
|
||||
nap-gameserver
|
||||
nap-sdkserver
|
||||
```
|
||||
|
||||
If you installed from prebuilt binaries, navigate to the directory where you downloaded
|
||||
the binaries and run the following:
|
||||
|
||||
```sh
|
||||
./nap-gameserver
|
||||
./nap-sdkserver
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The game server can be configured using a `.env` file. The file contains one configurable
|
||||
option, `SKIP_TUTORIAL`, which is set to 0 by default.
|
||||
|
||||
If you have a `.env` file in the **same** directory as your executable, then this
|
||||
is the file that will be loaded. Otherwise, upon _first_ running the `gameserver`
|
||||
executable, it will create `{FOLDERID_RoamingAppData}\nap-gameserver\.env`
|
||||
(`C:\Users\{user}\AppData\Roaming\nap-gameserver\.env`) for you, and will source
|
||||
from this config instead.
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue