Skip to content

Commit

Permalink
Clarify CONTRIBUTING.md terminal instructions, improve guide in general
Browse files Browse the repository at this point in the history
  • Loading branch information
jvyden committed Sep 6, 2024
1 parent e21a158 commit 47dfffb
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,45 @@
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.

## Requirements:
- Basic knowledge of [.NET](https://learn.microsoft.com/dotnet/)
- Ability to work with [Realm](https://realm.io) if necessary
- Basic knowledge of "reverse engineering," specifically reading packet captures and (rarely) reading the game executable for the LBP series.
- Basic knowledge of [C# and .NET 8](https://learn.microsoft.com/dotnet/)
- Ability to work with [Realm](https://realm.io), our database engine, when necessary. You can use [Realm Studio](https://github.com/realm/realm-studio/releases/) to inspect the database file.
- Basic knowledge of reverse engineering. In particular, reading packet captures and sometimes reading the game executable.

## Software prerequisites
- [.NET 7 SDK](https://dotnet.microsoft.com)
- [.NET 8 SDK](https://dotnet.microsoft.com)
- [Git](https://git-scm.com)
- 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](https://www.psx-place.com/threads/tutorial-ps3hen-the-great-ps3-hen-all-in-one-guide.24369/)/CFW (PS3), [Henkaku/Enso](https://vita.hacks.guide) (PSV), and/or [RPCS3](https://rpcs3.net) (PS3 on PC).

# Preparing your system
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](https://desktop.github.com) 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 [email protected]`

# Preparing your new development environment
It's almost time to clone Refresh! Create a fork by pressing the "Fork" button at the base of this repository.
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.
Afterward, open a terminal to your working directory and clone the new fork using Git.

This is usually done with the following command:
` $ [email protected]:<YOUR_USERNAME>/Refresh.git`
`$ [email protected]:<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:
To run the server software in Debug mode correctly, use these commands:

`$ dotnet run --project Refresh.GameServer`
- `$ mkdir -p bin/Debug/net8.0`
- `$ cd bin/Debug/net8.0`
- `$ dotnet run --project ../../../Refresh.GameServer.csproj`

Or use your IDE to do this for you!
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](https://github.com/LittleBigRefresh/Refresh) as the "**upstream**" remote using your IDE or GitHub Desktop. Happy hunting!

### Follow up in the patching documentation for connecting using your choice of device, TBW
# Connecting locally
You can either use the website front-end called [refresh-web](https://github.com/LittleBigRefresh/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:
- https://docs.littlebigrefresh.com/ps3.html
- https://docs.littlebigrefresh.com/rpcs3.html
- https://docs.littlebigrefresh.com/psp.html
- https://docs.littlebigrefresh.com/vita.html

0 comments on commit 47dfffb

Please sign in to comment.