SRMP-Public/README.md

# srmp-public
This is the code for the Slime Rancher MultiPlayer Mod (SRMP) by SatyPardus.

You can join our discord here: https://discord.gg/Qp8SmuQ 

Check out the #srmp-github channel for collaboration!

The user manual which includes compatability information, download and installation instructions and standard troubleshooting can be found [here](/manual.md).

## How to setup your development enviroment
- Clone the repository and open it in VS2022
- Go to the project properties->Reference Paths
- Add your Slime Rancher managed path to it (Example: C:\Program Files (x86)\Steam\steamapps\common\Slime Rancher\SlimeRancher_Data\Managed\)

To build, select either the "Standalone" or "SRML" build option, depending on which modloader you got installed.

## Bug Status 
Note: Bug list compiled from last known bug list of version 1488

FIXED:
- Multiplayer window doesn't show up on resolutions < 1920x1080
- Exchange sometimes skips rewards if multiple players put items in at the same time
- Exchange chest disappears without rewards
- 
IN PROGRESS: N/A

Known Bugs:
- Plort collectors don't work properly sometimes (Playing effect but not pulling anything)
- Nutcracker doesn't spit out right amount, or spits out "babies"
- Slimes sometimes appear "angry" for other players
- Game stutters when placing/removing gadgets
- First time using the mod can apparently break a lot of things (falling through world, slimes not eating) - Restarting the game fixes it
- DLCs don't seem to be loaded correctly when leaving and joining
- DLC are not initialized on game start, making the "You need following DLCs:" message pop up (Can be fixed by loading the "Manage DLCs" menu and trying again)
- Gordos don't drop things sometimes
- Slimes sometimes dont produce plorts
- Drones get stuck in place sometimes
- Chat sometimes empty for remote players
- Upgrades sometimes does not get applied to All players


## Current Status
[@Twirlbug](https://github.com/Twirlbug)
- Currently working on going through the code, adding notes and fixing some of the bugs in my free time. 
- I adore this mod and want to give both credit and a huge thank you to Saty for the origional creation of the mod. 
I am slowly working my way through the list of bugs as seen above.

### Notation Status
Files in the following folders still need more notation:
- Networking
- Packets
- Patches
Create README.md 2023-05-29 22:37:59 +02:00			`# srmp-public`
Update README.md 2023-07-02 23:38:24 +02:00			`This is the code for the Slime Rancher MultiPlayer Mod (SRMP) by SatyPardus.`
Update README.md 2023-07-01 04:00:26 +02:00
Update README.md 2023-07-07 20:24:01 +02:00			`You can join our discord here: https://discord.gg/Qp8SmuQ`

			`Check out the #srmp-github channel for collaboration!`

Update README.md Fix small grammar error 2023-08-02 21:09:30 +02:00			`The user manual which includes compatability information, download and installation instructions and standard troubleshooting can be found [here](/manual.md).`
Update README.md 2023-07-01 04:00:26 +02:00
Update README.md 2023-07-07 16:59:37 +02:00			`## How to setup your development enviroment`
			`- Clone the repository and open it in VS2022`
			`- Go to the project properties->Reference Paths`
			`- Add your Slime Rancher managed path to it (Example: C:\Program Files (x86)\Steam\steamapps\common\Slime Rancher\SlimeRancher_Data\Managed\)`

			`To build, select either the "Standalone" or "SRML" build option, depending on which modloader you got installed.`
Update README.md Updated Read me with current code status 2023-07-01 06:34:16 +02:00
Finished notation for UI folder 2023-07-02 23:33:55 +02:00			`## Bug Status`
Update README.md 2023-07-02 23:39:06 +02:00			`Note: Bug list compiled from last known bug list of version 1488`
Update README.md Updated Read me with current code status 2023-07-01 06:34:16 +02:00
			`FIXED:`
			`- Multiplayer window doesn't show up on resolutions < 1920x1080`
Update README.md 2023-07-01 04:00:26 +02:00			`- Exchange sometimes skips rewards if multiple players put items in at the same time`
			`- Exchange chest disappears without rewards`
Merging readme 2023-07-06 04:03:15 +02:00			`-`
			`IN PROGRESS: N/A`
Update README.md Updated Read me with current code status 2023-07-01 06:34:16 +02:00
			`Known Bugs:`
Update README.md 2023-07-01 04:00:26 +02:00			`- Plort collectors don't work properly sometimes (Playing effect but not pulling anything)`
			`- Nutcracker doesn't spit out right amount, or spits out "babies"`
			`- Slimes sometimes appear "angry" for other players`
			`- Game stutters when placing/removing gadgets`
			`- First time using the mod can apparently break a lot of things (falling through world, slimes not eating) - Restarting the game fixes it`
			`- DLCs don't seem to be loaded correctly when leaving and joining`
			`- DLC are not initialized on game start, making the "You need following DLCs:" message pop up (Can be fixed by loading the "Manage DLCs" menu and trying again)`
			`- Gordos don't drop things sometimes`
			`- Slimes sometimes dont produce plorts`
			`- Drones get stuck in place sometimes`
			`- Chat sometimes empty for remote players`
			`- Upgrades sometimes does not get applied to All players`
Added more notes and orgamized the files again 2023-07-01 21:57:32 +02:00

Update README.md 2023-07-02 23:38:24 +02:00			`## Current Status`
Update README.md 2023-07-02 23:42:33 +02:00			`[@Twirlbug](https://github.com/Twirlbug)`
Finished notation for UI folder 2023-07-02 23:33:55 +02:00			`- Currently working on going through the code, adding notes and fixing some of the bugs in my free time.`
			`- I adore this mod and want to give both credit and a huge thank you to Saty for the origional creation of the mod.`
			`I am slowly working my way through the list of bugs as seen above.`

Update README.md 2023-07-02 23:38:24 +02:00			`### Notation Status`
Finished notation for UI folder 2023-07-02 23:33:55 +02:00			`Files in the following folders still need more notation:`
Added more notes and orgamized the files again 2023-07-01 21:57:32 +02:00			`- Networking`
			`- Packets`
			`- Patches`