misc(server/game): update the readme

This commit is contained in:
capyb2222 committed 2026-09-10 21:15:26 -07:00
1 parent 4e09c12742
commit b7a93f250e
1 file changed
+9 -3
+9 -3
View File
@@ -1,10 +1,16 @@
# CapySR - WIP # CapySR - WIP
A Star Rail private server in C++. Targets the `4.5.51/4.6 beta`. This server is in WIP, but you can still use it. A server reimplementation written in C++ for a certain anime game with star and rails. Targets the `4.5.5x beta` (usually the latest). This server is in WIP, but you can still use it.
## Requirements ## Requirements
Needs Visual Studio with the C++ workload, CMake, Ninja, Python 3 (with `py -m pip install protobuf`) and `protoc` on PATH. 1. Visual Studio 2026 Community (or the smaller Build Tools): https://visualstudio.microsoft.com/downloads/
In the installer, tick "Desktop development with C++". That brings the compiler, the Windows SDK, CMake and Ninja; keep "C++ CMake tools for Windows" ticked, which it is by default.
2. Python 3: https://www.python.org/downloads/windows/
Tick "Add python.exe to PATH" during install.
3. protoc: https://github.com/protocolbuffers/protobuf/releases
Download protoc-<version>-win64.zip, unzip it, and add its bin folder to PATH. Pick the newest normal release, not an -rc one.
4. The Python protobuf package, which is required. tools/gen_proto.py imports google.protobuf, so the build fails without it. Install it with: `py -m pip install protobuf`
## Build ## Build
@@ -16,7 +22,7 @@ Then find the outputs at `build\bin\`
## Running it ## Running it
Supports both `CN` and `OS` client. You can get it here: [CN](https://gofile.io/d/vtV5JfkO) and [OS](https://gofile.io/d/wAT1UiJj). Recommends you use 7z to extract. Supports both `CN` and `OS` client. You can get the latest client here: [CN](https://gofile.io/d/vtV5JfkO) or [OS](https://gofile.io/d/wAT1UiJj). Recommends you use 7z to extract.
1. Copy `launcher.exe` and `hkrpg.dll` from launcher folder inside CapySR and paste them inside your client folder (Thank you Reversed Rooms) 1. Copy `launcher.exe` and `hkrpg.dll` from launcher folder inside CapySR and paste them inside your client folder (Thank you Reversed Rooms)
2. Start the server: `build\bin\capysr.exe`. 2. Start the server: `build\bin\capysr.exe`.