diff --git a/README.md b/README.md index bb6e89e..e0e8606 100644 --- a/README.md +++ b/README.md @@ -64,13 +64,16 @@ Before you start, you'll need the following software downloaded and installed: 1. The latest version from [Steam](https://steamcommunity.com/app/868270). + > [!WARNING] + > The latest version of The Cycle: Frontier does not work with Windows 11 24H2! + 1. Season 2 client downloaded from SteamDB using a depot downloader. For example, [version 2.7.2](https://steamdb.info/depot/868271/history/?changeid=M:4623363103423775682). ### 2. Unpack `Prospect.Server.Api` Use your favorite ZIP archiver and unzip the `Prospect.Server.Api.zip` downloaded from this repository. -### 3. Patch hosts +### 3. Patch the `hosts` file To be able to connect to the locally running server, you must replace the IP address of `2EA46.playfabapi.com` that the game uses. Do the following: @@ -78,7 +81,7 @@ To be able to connect to the locally running server, you must replace the IP add 1. Click **File** > **Open...** and select `C:\Windows\System32\drivers\etc\hosts`. -1. At the end of the file, add `127.0.0.1 2EA46.playfabapi.com` on a new line. +1. At the end of the file, add `127.0.0.1 2EA46.playfabapi.com` on a new line. Do not add the `#` character! ### 4. Generate and import SSL certificate @@ -128,7 +131,12 @@ to successfully communicate with the local server. Do the following: ### 7. Run the server -Now you are all set! Open the folder with `Prospect.Server.Api` and run `Prospect.Server.Api.exe`. +Now you are all set! Open the folder with `Prospect.Server.Api` and run `Prospect.Server.Api.exe`. It will open a console if it runs successfully. + +> [!IMPORTANT] +> Do not close the console when you run the game. +> +> If the console does not open, make sure you have [.NET Runtime 8.0](https://aka.ms/dotnet-core-applaunch?missing_runtime=true&arch=x64&rid=win-x64&os=win10&apphost_version=8.0.11) and [ASP.NET Core 8.0](https://aka.ms/dotnet-core-applaunch?framework=Microsoft.AspNetCore.App&framework_version=8.0.0&arch=x64&rid=win-x64&os=win10) installed. ### 8. Run the game @@ -157,6 +165,39 @@ This application is a simple certificate generator and you can find its source c Currently, the server loads body part IDs for Season 2 by default, so this is expected. You can fix this by going to station and changing your character appearance. This will store the updated body part IDs for your character. +#### Prospect.Server.Api does not start + +Make sure you have [.NET Runtime 8.0](https://aka.ms/dotnet-core-applaunch?missing_runtime=true&arch=x64&rid=win-x64&os=win10&apphost_version=8.0.11) and [ASP.NET Core 8.0](https://aka.ms/dotnet-core-applaunch?framework=Microsoft.AspNetCore.App&framework_version=8.0.0&arch=x64&rid=win-x64&os=win10) installed. + +#### Login Failed. Error code: 3 + +Make sure that: + +* You have Steam running. +* You have created and **saved** the `steam_appid` file as described in step 6. +* The `steam_appid` file type is "TXT File". + +#### Login Failed. Error code: 5 + +Make sure that: + +* `Prospect.Server.Api` server is running. +* The `C:\Windows\System32\drivers\etc\hosts` file contains `127.0.0.1 2EA46.playfabapi.com` and that the file is **saved**. + +If the server works and the `hosts` file is saved, `Alt+Tab` to a game console that opens when you start the game and check for the following: + +* `libcurl error 7 (Couldn't connect to server)` - indicates that the `Prospect.Server.Api` is not running. + ![](./_assets/connection_refused_error.png) + +* `InvalidAPIEndpoint` - indicates that the `hosts` file was not updated properly. + ![](./_assets/invalid_api_endpoint.PNG) + +* `libcurl error 60 (Peer certificate cannot be authenticated with given CA certificates)` - indicates that the certificate was not installed correctly. Make sure that the certificate is present in `certmgr.msc` and there is only one certificate. Try removing the certificate and importing it again by following step 4. + ![](./_assets/certificate_error.PNG) + +* `HTTP error code 500` - usually indicates that MongoDB is not running. Make sure that MongoDB is installed and and that `MongoDB Server` is running in `services.msc`. + ![](./_assets/mongodb_error.PNG) + ## Development TBD \ No newline at end of file diff --git a/_assets/certificate_error.PNG b/_assets/certificate_error.PNG new file mode 100644 index 0000000..04be178 Binary files /dev/null and b/_assets/certificate_error.PNG differ diff --git a/_assets/connection_refused_error.png b/_assets/connection_refused_error.png new file mode 100644 index 0000000..8420f67 Binary files /dev/null and b/_assets/connection_refused_error.png differ diff --git a/_assets/invalid_api_endpoint.PNG b/_assets/invalid_api_endpoint.PNG new file mode 100644 index 0000000..8d2ef4c Binary files /dev/null and b/_assets/invalid_api_endpoint.PNG differ diff --git a/_assets/mongodb_error.PNG b/_assets/mongodb_error.PNG new file mode 100644 index 0000000..21d97f1 Binary files /dev/null and b/_assets/mongodb_error.PNG differ