Add connecting & running instructions to README.md

This commit is contained in:
jvyden 2021-10-18 16:04:31 -04:00
parent 92b7fa6efe
commit b55e06b74c
No known key found for this signature in database
GPG key ID: 18BCF2BE0262B278
2 changed files with 49 additions and 1 deletions

View file

@ -9,6 +9,7 @@
<Path>DatabaseMigrations</Path>
<Path>ProjectLighthouse.sln.DotSettings</Path>
<Path>ProjectLighthouse.sln.DotSettings.user</Path>
<Path>README.md</Path>
<Path>docker-compose.yml</Path>
<Path>global.json</Path>
</explicitIncludes>

View file

@ -1,3 +1,50 @@
# Project Lighthouse
Project Lighthouse is an umbrella project for all work to investigate and develop private servers for LittleBigPlanet.
Project Lighthouse is an umbrella project for all work to investigate and develop private servers for LittleBigPlanet.
## WARNING!
This is beta software, and thus is insecure.
We're not responsible if someone connects and hacks your entire machine and deletes all your files.
Even so, this is not ready for public use yet. That said, feel free to develop privately!
## Building
This will be written when we're out of beta. Consider this your barrier to entry ;).
## Running
Lighthouse requires a MySQL database at this time.
For Linux users running docker, one can be set up using the `docker-compose.yml` file in the root of the project folder.
Once you've gotten MySQL running you can create the schema by running all of the `.sql` files in the `DatabaseMigrations` folder against the database.
Then, you can finally run Lighthouse. It will connect using a connection string stored in `LIGHTHOUSE_DB_CONNECTION_STRING` by default.
The connection string is `server=127.0.0.1;uid=root;pwd=lighthouse;database=lighthouse` by default. You can modify it if you'd like to,
but you shouldn't need to if you're using docker since the docker-compose file matches this by default.
## Connecting
PS3 is difficult to set up, so I will be going over how to set up RPCS3 instead. A guide will be coming for PS3 closer to release.
*Note: This requires a modified copy of RPCS3. You can find a working patch [here](https://gist.github.com/jvyden/0d9619f7dd3dbc49f7583486bdacad75).*
Start by getting a copy of LittleBigPlanet 2 installed. It can be digital (NPUA80662) or disc (BCUS98245).
I won't get into how because if you got this far you should already know what you're doing. For those that don't, the [RPCS3 Quickstart Guide](https://rpcs3.net/quickstart) should cover it.
Next, download and compile [UnionPatcher](https://github.com/LBPUnion/UnionPatcher/). Binaries will be coming shortly, but for now just compile it. If there are binaries, feel free to patch this line out.
You should have everything you need now, so open up RPCS3 and go to Utilities -> Decrypt PS3 Binaries. Point this to `rpcs3/dev_hdd0/game/(title id)/USRDIR/EBOOT.BIN`.
This should give you a file named `EBOOT.elf` in the same folder. Next, fire up UnionPatcher (making sure to select the correct project to start, e.g. on Mac launch `UnionPatcher.Gui.MacOS`.)
You can start patching now. Select the `EBOOT.elf` you got earlier in the top box, enter `http://localhost:10060/LITTLEBIGPLANETPS3_XML` in the second, and the output filename in the third.
For this guide I'll use `EBOOTlocalhost.elf`.
Now, copy the `EBOOTlocalhost.elf` file to where you got your `EBOOT.elf` file from, and you're now good to go.
To launch the game with the patched EBOOT, open up RPCS3, go to File, Boot SELF/ELF, and open up `EBOOTlocalhost.elf`.
Assuming you are running the patched version of RPCS3, you patched the file correctly, the database is migrated, and Lighthouse is running, the game should now connect.
Take a break.