From 88d306113233ae2341bdf4374c6e85cc515e9618 Mon Sep 17 00:00:00 2001 From: Mikhail Tyukin Date: Sat, 12 Jul 2025 16:28:06 +0100 Subject: [PATCH] improve readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 598c1a0..5568b8b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ [![Discord](https://img.shields.io/discord/1261717212448952450?style=flat-square)](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 +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] > 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. ## 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.

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? See the todo list at https://github.com/orgs/EpinelPS/projects/1 and https://github.com/EpinelPS/EpinelPS/issues