mirror of
https://github.com/LBPUnion/ProjectLighthouse.git
synced 2025-07-29 08:28:39 +00:00
Update README.md
This commit is contained in:
parent
6266d3907b
commit
e5fed738db
1 changed files with 9 additions and 13 deletions
22
README.md
22
README.md
|
@ -1,19 +1,17 @@
|
||||||
# Project Lighthouse
|
# 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.
|
||||||
|
This project is the main server component that LittleBigPlanet games connect to.
|
||||||
|
|
||||||
## WARNING!
|
## WARNING!
|
||||||
|
This is beta software, and thus is not ready for public use yet.
|
||||||
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.
|
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!
|
|
||||||
|
That said, feel free to develop privately!
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
This will be written when we're out of beta. Consider this your barrier to entry ;).
|
This will be written when we're out of beta. Consider this your barrier to entry ;).
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
Lighthouse requires a MySQL database at this time.
|
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.
|
For Linux users running docker, one can be set up using the `docker-compose.yml` file in the root of the project folder.
|
||||||
|
|
||||||
|
@ -25,21 +23,21 @@ you will need to change this.
|
||||||
Once you've gotten MySQL running you can run Lighthouse. It will take care of the rest.
|
Once you've gotten MySQL running you can run Lighthouse. It will take care of the rest.
|
||||||
|
|
||||||
## Connecting
|
## 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.
|
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.
|
||||||
|
You can also follow this guide if you want to learn how to modify your EBOOT.
|
||||||
|
|
||||||
*Note: This requires a modified copy of RPCS3. You can find a working patch [here](https://gist.github.com/jvyden/0d9619f7dd3dbc49f7583486bdacad75).*
|
*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).
|
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.
|
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 can be found by reading the README.md file.
|
Next, download [UnionPatcher](https://github.com/LBPUnion/UnionPatcher/). Binaries can be found by reading the README.md file.
|
||||||
|
|
||||||
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`.
|
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`.)
|
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.
|
Now that you have your decrypted eboot, open UnionPatcher and 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`.
|
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.
|
Now, copy the `EBOOTlocalhost.elf` file to where you got your `EBOOT.elf` file from, and you're now good to go.
|
||||||
|
@ -48,15 +46,13 @@ To launch the game with the patched EBOOT, open up RPCS3, go to File, Boot SELF/
|
||||||
|
|
||||||
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.
|
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.
|
Finally, take a break. Chances are that took a while.
|
||||||
|
|
||||||
## Contributing Tips
|
## Contributing Tips
|
||||||
|
|
||||||
### Database
|
### Database
|
||||||
|
|
||||||
Some modifications may require updates to the database schema. You can automatically create a migration file by:
|
Some modifications may require updates to the database schema. You can automatically create a migration file by:
|
||||||
|
|
||||||
1. Making sure the tools are installed. You can do this by running `dotnet tool restore`.
|
1. Making sure the tools are installed. You can do this by running `dotnet tool restore`.
|
||||||
2. Making sure `LIGHTHOUSE_DB_CONNECTION_STRING` is set correctly. See the `Running` section for more details.
|
2. Making sure `LIGHTHOUSE_DB_CONNECTION_STRING` is set correctly. See the `Running` section for more details.
|
||||||
3. Making your changes to the database. I wont cover this since if you're making database changes you should know what you're doing.
|
3. Making your changes to the database. I won't cover this since if you're making database changes you should know what you're doing.
|
||||||
4. Running `dotnet ef migrations add <NameOfMigrationInPascalCase> --project ProjectLighthouse`.
|
4. Running `dotnet ef migrations add <NameOfMigrationInPascalCase> --project ProjectLighthouse`.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue