endernon/FireflySR-goober-edition
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
endernon 2024-05-27 12:42:56 +00:00
parent 9bf120fb43
commit 5cbb646bde
1 changed files with 4 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,7 +4,7 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e
![screenshot](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/screenshot.png) ![screenshot](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/screenshot.png)
...BUT I edited this text to make it easier to compile for goobers. ...BUT I edited this text to make it easier to compile for goobers.
## I just want to run the server! I don't care about modifying the code. # I just want to run the server! I don't care about modifying the code.
- First, get [MongoDB](https://www.mongodb.com/try/download/community) - First, get [MongoDB](https://www.mongodb.com/try/download/community)
- Go to [Reversedrooms FireflySR Releases Tab](https://git.xeondev.com/reversedrooms/FireflySR/releases) - Go to [Reversedrooms FireflySR Releases Tab](https://git.xeondev.com/reversedrooms/FireflySR/releases)
- On that page download "FireflySR-win64.zip". DO NOT DOWNLOAD SOURCE CODE!!! - On that page download "FireflySR-win64.zip". DO NOT DOWNLOAD SOURCE CODE!!!
@ -17,21 +17,15 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e
#### Requirements # I want to edit the code and build the project to how I like it!
First, get these prerequesites:
- [Rust](https://www.rust-lang.org/tools/install) - [Rust](https://www.rust-lang.org/tools/install)
- [MongoDB](https://www.mongodb.com/try/download/community-edition) - [MongoDB](https://www.mongodb.com/try/download/community-edition)
- [Protobuf Compiler (protoc)](https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-win64.zip). You should manually extract it to somewhere and add `bin` subfolder to the system environment variable `PATH`. - [Protobuf Compiler (protoc)](https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-win64.zip) (ONLY IF YOU ARE USING MICROSOFT WINDOWS). You should manually extract it to somewhere and add `bin` subfolder to the system environment variable `PATH`. Look online for how to add a folder to "path"
#### Building #### Building
#### Using xtasks (recommended)
```sh
git clone https://git.xeondev.com/reversedrooms/FireflySR.git
cd FireflySR
cargo xtask run
```
##### To run it with automatic recompilation when any Rust files are changed ##### To run it with automatic recompilation when any Rust files are changed