This document details the steps and other important information on how to contribute to Refresh. Feel free to skip sections if you believe you're already set.
- Basic knowledge of C# and .NET 8
- Ability to work with Realm, our database engine, when necessary. You can use Realm Studio to inspect the database file.
- Basic knowledge of reverse engineering. In particular, reading packet captures and sometimes reading the game executable.
- .NET 8 SDK
- Git
- An IDE that supports .NET; Visual Studio, Visual Studio Code, JetBrains Rider, it's up to you!
- Any legally acquired PS3 or PSV LBP game, excluding Karting.
- Access to HEN/CFW (PS3), Henkaku/Enso (PSV), and/or RPCS3 (PS3 on PC).
Create a fork by pressing the "Fork" button at the base of this repository.
Afterward, open a terminal to your working directory and clone the new fork using Git.
This is usually done with the following command:
$ git@github.com:<YOUR_USERNAME>/Refresh.git
Now, open the folder/workspace/solution with the IDE you chose. Explore the codebase, experiment, and have fun!
To run the server software in Debug mode correctly, use these commands:
$ mkdir -p bin/Debug/net8.0$ cd bin/Debug/net8.0$ dotnet run --project ../../../Refresh.GameServer.csproj
To run in release mode, simply append --configuration Release to the dotnet run invocation.
You can also use your IDE to run the project for you.
Make sure to add the upstream Refresh repository as the "upstream" remote using your IDE or GitHub Desktop. Happy hunting!
You can either use the website front-end called refresh-web to test the API, or you can connect using a game.
Here's how to identify the URL to patch to: https://docs.littlebigrefresh.com/get-url.html
You can use these guides to find out how to patch your game: