SRMP-Public/README.md
ZervóTheProtogen d73f1a5d73
Update README.md
Fix small grammar error
2023-08-02 21:09:30 +02:00

52 lines
2.3 KiB
Markdown

# 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