mirror of
https://github.com/EpinelPS/EpinelPS.git
synced 2025-12-12 23:14:34 +01:00
improve readme
This commit is contained in:
12
README.md
12
README.md
@@ -12,7 +12,9 @@
|
|||||||
[](https://discord.gg/Ztt6Y9vQjF)
|
[](https://discord.gg/Ztt6Y9vQjF)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
Private/local server for a 2d anime rpg game. The goal of this project is to replicate the functionality of the official server. Discord server: https://discord.gg/Ztt6Y9vQjF
|
Private/local server for a 2d anime rpg game. The goal of this project is to replicate the functionality of the official server.
|
||||||
|
|
||||||
|
Discord server: https://discord.gg/Ztt6Y9vQjF
|
||||||
|
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
> Please note this GitHub repository (https://github.com/EpinelPS/EpinelPS/) is the only official source for EpinelPS. **If you bought it from someone, you got scammed. Do not download EpinelPS from other sources.** Download link: https://nightly.link/EpinelPS/EpinelPS/workflows/dotnet-desktop/main/Server%20and%20Server%20selector.zip
|
> Please note this GitHub repository (https://github.com/EpinelPS/EpinelPS/) is the only official source for EpinelPS. **If you bought it from someone, you got scammed. Do not download EpinelPS from other sources.** Download link: https://nightly.link/EpinelPS/EpinelPS/workflows/dotnet-desktop/main/Server%20and%20Server%20selector.zip
|
||||||
@@ -21,16 +23,18 @@ Private/local server for a 2d anime rpg game. The goal of this project is to rep
|
|||||||
> This project is in an early state so many functions in the game do not work. It is recommended to download the latest build from GitHub actions.
|
> This project is in an early state so many functions in the game do not work. It is recommended to download the latest build from GitHub actions.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Download the latest release/GitHub actions build, and run ServerSelector.Desktop.exe as administrator (to modify DNS hosts file and install a CA cert). Make sure to close the game and launcher first. Select Local server, and then click save. After that, start EpinelPS.exe to start the actual server.
|
Download the [GitHub actions build](https://nightly.link/EpinelPS/EpinelPS/workflows/dotnet-desktop/main/Server%20and%20Server%20selector.zip), and run ServerSelector.Desktop.exe as administrator (to modify DNS hosts file and install a CA cert). Make sure to close the game and launcher first. Select Local server, and then click save. After that, start EpinelPS.exe to start the actual server.
|
||||||
<br>
|
<br>
|
||||||
<img src="https://github.com/MishaProductions/nikke-server/assets/106913236/b01194ef-aec5-4de9-b982-1253757655f8" width="192" height="108">
|
<img src="https://github.com/MishaProductions/nikke-server/assets/106913236/b01194ef-aec5-4de9-b982-1253757655f8" width="192" height="108">
|
||||||
<br>
|
<br>
|
||||||
You should be able to register an new account in the launcher (you can enter any email verification code).
|
You should be able to register an new account in the launcher (you can enter any email verification code).
|
||||||
|
|
||||||
To access the admin panel, go to https://127.0.0.1/admin/ and sign in. Note that IsAdmin needs to be true for the user account. Note that this interface does not have anything yet.
|
|
||||||
|
|
||||||
To skip stages, a basic command line interface is implemented.
|
To access the admin panel, go to https://127.0.0.1/admin/ and sign in. Note that IsAdmin needs to be true for the user account. You can skip stages and add all characters using that link for example.
|
||||||
|
|
||||||
|
|
||||||
|
> [!Note]
|
||||||
|
> Before updating the game, make sure to switch back to the official server to ensure that the game is properly patched.
|
||||||
|
|
||||||
## What is implemented or missing?
|
## What is implemented or missing?
|
||||||
See the todo list at https://github.com/orgs/EpinelPS/projects/1 and https://github.com/EpinelPS/EpinelPS/issues
|
See the todo list at https://github.com/orgs/EpinelPS/projects/1 and https://github.com/EpinelPS/EpinelPS/issues
|
||||||
|
|||||||
Reference in New Issue
Block a user