diff --git a/README.md b/README.md index 9cad24e..348f842 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -# castorice-sr +# CastoriceSR +#### Honkai: Star Rail server emulator (3.2 beta) written in Zig. +![screenshot](https://git.xeondev.com/castorice-sr/castorice-sr/screenshot.png) -Honkai: Star Rail server emulator (3.2 beta) \ No newline at end of file +## Requirements +[Zig 0.13.0](https://ziglang.org/download/) + +## Running +### From source + +Windows: +``` +git clone https://git.xeondev.com/castorice-sr/castorice-sr.git +cd castorice-sr +start zig build run-dispatch +start zig build run-gameserver +``` + +Linux: +``` +git clone https://git.xeondev.com/castorice-sr/castorice-sr.git +cd castorice-sr +zig build run-dispatch & zig build run-gameserver +``` + +## Connecting +[Get 3.1.54 client](https://gofile.io/d/rNKxW6), + +## Functionality (work in progress) +- Login and player spawn +- Test battle via calyx +- MOC/PF/AS simulator +- Gacha simulator +- Support command for Sillyism + +## 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. \ No newline at end of file diff --git a/Screenshot.png b/Screenshot.png new file mode 100644 index 0000000..23bc10c Binary files /dev/null and b/Screenshot.png differ