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 13:03:45 +00:00
parent 32dd1abb30
commit 750905ea9e
1 changed files with 10 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -13,7 +13,7 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e
- Run "start_all.bat"
- Allow admin permission for all three tabs that should open
- Now, scroll down to [Connecting](https://git.endernon.com/endernon/FireflySR-goober-edition#connecting)
On later occasions, if you want to run the server again, run "start_all.bat" again.
@ -21,23 +21,21 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e
First, get these prerequesites:
- [Rust](https://www.rust-lang.org/tools/install)
- [MongoDB](https://www.mongodb.com/try/download/community-edition)
- [Git](https://git-scm.com/download/win)
- [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"
Then, open file explorer and create a new folder somewhere. Make sure it's empty. Then, at the file path thing at the top of file explorer, click it, delete the text, replace with "cmd" and click enter.
Now, you should have Command Prompt running. Inside this window, run
```
git clone https://git.endernon.com/endernon/FireflySR-goober-edition ./FireflySR
```
Now, Git will start cloning the repo locally. Once it's done, open the newly created "FireflySR" folder. You now have a local copy of the code.
#### Building
Now, make your changes to the code.
When you wish to compile, run the `BUILD.bat` I provided in the root folder of FireflySR. You will need to run the script again every time you make a change to the code and want to run your changes.
##### To run it with automatic recompilation when any Rust files are changed
```sh
cargo xtask watch
```
### From Pre-built Binaries
Navigate to the [Releases](https://git.xeondev.com/reversedrooms/FireflySR/releases)
page and download the latest release for your platform.
## Usage
To begin using the server, you need to run three servers: `sdkserver`, `dispatch` and `gameserver`