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 .NET
- Ability to work with Realm if necessary
- Basic knowledge of "reverse engineering," specifically reading packet captures and (rarely) reading the game executable for the LBP series.
- .NET 7 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).
In order to use Git you must set up your configuration, this should ideally match your GitHub account's name and email.
You can use GitHub Desktop or the IDE of your choice to help you with this! Or if you're more technically inclined, follow the CLI instructions below.
This will modify the global config, which will allow you to contribute to multiple projects with the same name and email with ease.
$ git config --global user.name Your Name
$ git config --global user.email you@example.com
It's almost time to clone Refresh! Create a fork by pressing the "Fork" button at the base of this repository.
Afterwards, 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, simply write:
$ dotnet run --project Refresh.GameServer
Or use your IDE to do this for you!
Make sure to add the upstream Refresh repository as the "upstream" remote using your IDE or GitHub Desktop. Happy hunting!