manula.md add images, fix typos, improve quality.

manual.md

@@ -23,6 +23,14 @@ Click a link to jump to that section of the document.
 
 [Download the mod](#download-the-mod)
 
+> [Which version to use?](#which-version-to-use)
+
+> [Download on Itch.io](#download-on-itchio-paid)
+
+> [Download on Discord](#download-on-discord-free)
+
+> [Download on GitHub](#download-on-github-free)
+
 [Install the mod](#install-the-mod)
 
 > [Windows](#windows)
@@ -35,6 +43,14 @@ Click a link to jump to that section of the document.
 
 > [Hosting and Joining](#hosting-and-joining)
 
+> > [Server Codes](#playing-using-server-codes)
+
+> > [Over LAN](#playing-over-lan)
+
+> > [Over VPN](#playing-over-fake-lan-vpn)
+
+> > [Port Forwarding](#playing-over-the-internet-port-forwarding)
+
 > [Console commands](#console-commands)
 
 [Troubleshooting](#troubleshooting)
@@ -58,7 +74,7 @@ SRMP works on all PC versions of the game except for the Microsoft Store version
 |       GoG       |  🟢 Compatible  | 🟡 Kinda works  |   ⚪ Unknown    | 🔴 Incompatible |
 | Microsoft Store | 🔴 Incompatible | 🔴 Incompatible | 🔴 Incompatible | 🔴 Incompatible |
 
-Unknown just means that the original author didn't have enough data to say if the platform would work or not.
+Unknown just means that I didn't have enough data to say if the platform would work or not.
 
 If you want an explanation to a specific entry in the table, select the operating system and platform below:
 
@@ -131,7 +147,7 @@ By using the SRML version of SRMP, it is possible to play with other mods. Keep
 <details>
 <summary>SRMP+SRML mod compability list</summary>
 
-**_This list may be outdated, it is currently based on information found [here](https://docs.google.com/document/d/1JsofvJNLPK5r3XIF-MHBLWBKDzB8GUmGcia9eVnYvJ4)._** I will update it with new information as I receive it. If you want to help, please follow the testing procedure described in the document I just linked. Feel free to contact give us any information you have to contribute with on discord, or contribute directly to this document if you feel comfortable doing that.
+**_This list may be outdated, it is currently based on information found [here](https://docs.google.com/document/d/1JsofvJNLPK5r3XIF-MHBLWBKDzB8GUmGcia9eVnYvJ4)._** I will update it with new information as I receive it. If you want to help, please follow the testing procedure described in the document I just linked. Feel free to give us any information you have to contribute with on discord, or contribute directly to this document if you feel comfortable doing that.
 
 | Mod Name                                                                     | Compatible | Date Updated | Mod Ver. | SRMP Ver. | Tested By  | Notes                    |
 | :--------------------------------------------------------------------------- | :--------- | :----------: | :------: | :-------: | :--------: | :----------------------- |
@@ -213,7 +229,7 @@ Now that you have downloaded the mod it is time to install it. Remember that the
 <summary>1. Finding the game installation directory</summary>
 The first step to installing the mod is to know where to install it to. We need to find the game installation directory (we will refer to it as GID from now on). This is done a little different depending on which platform (aka launcher) you have the game on. If you have it on multiple and one of them is steam, use steam. If you pirated the game, get out of my manual. Read the section for your launcher.
     <details>
-    <summary>1.a. Steam</summary>
+    <summary>> 1.a. Steam</summary>
     It is really easy to find the GID on Steam, it only takes a few clicks. Open your library and find Slime Rancher in the list. Rightclick it, hover over ‘Manage’ and click ‘Browse local files’. This should open the explorer (or your default file explorer) in the GID. You know it is the correct directory if it contains a folder called SlimeRancher_Data.
     </details>
     <details>
@@ -241,31 +257,44 @@ Now to test if everything has installed correctly. Start the game from your laun
 <!-- Unless someone else does it, I will update this section to be a lot more detailed and easier to understand in the future. -->
 
 <details>
-    <summary>TL;DR</summary>
-    Find the game installation directory, extract the downloaded zip file into that directory replacing files inside. Done.
+<summary>TL;DR</summary>
+Find the game installation directory, extract the downloaded zip file into that directory replacing files inside. Done.
+
+![smrpInstallShortLinux](./screenshots/srmp-install-short-linux.jpg)
+
 </details>
 
 <details>
-    <summary>1. Getting the game to run</summary>
-    In case you haven't already, it is strongly recommended to get the game running properly without issues before moving on to modding. I won't go into detail on how to do that here, but if you have it on steam        then use proton. If you have it on Epic Games or GoG then use Lutris, Heroic Games Launcher or a similar solution. Tweak until it runs properly.
+<summary>1. Getting the game to run</summary>
+In case you haven't already, it is strongly recommended to get the game running properly without issues before moving on to modding. I won't go into detail on how to do that here, but if you have it on steam        then use proton. If you have it on Epic Games or GoG then use Lutris, Heroic Games Launcher or a similar solution. Tweak until it runs properly.
 </details>
 
 <details>
-    <summary>2. Finding the game installation directory</summary>
-    This will be quite different depending on where you have the game.
-    For steam: find slime rancher in your library, right click 'Manage' > 'Browse local files'.
-    For other launchers, the paths may vary drastically. Most of them have an option to browse files though.
-    You know it's the correct directory if it contains another directory called "SlimeRancher_Data".
+<summary>2. Finding the game installation directory</summary>
+
+![srmpInstallIdentifyGID](./screenshots/srmp-install-identify-gid.jpg)
+
+This will be quite different depending on where you have the game.
+
+For steam: find slime rancher in your library, right click 'Manage' > 'Browse local files'.
+For other launchers, the paths may vary drastically. Most of them have an option to browse files though.
+
+You know it's the correct directory if it contains another directory called "SlimeRancher_Data".
+
 </details>
 
 <details>
-    <summary>3. Installing the mod</summary>
-    Once you know the GID (game installation directory) of your game you can move on to actually installing the mod. First up, make sure you have your GID open in a file explorer. Again the GID can be identified by containing a folder called SlimeRancher_Data. Next, open the directory containing the downloaded mod zip archive (probably Downloads). Copy or move the zip into the GID, not into SlimeRancher_Data or another folder inside of the GID, but the GID itself, the directory containing SlimeRancher_Data and such. Now that the zip archive is in place, extract it into this directory. It should replace a file in SlimeRancher_Data, if it does then select yes, if it doesn’t then you have extracted it to the wrong directory or you just need to move it out of a folder first. Once extracted correctly, it should have replaced a file in SlimeRancher_Data and created a new folder called Mods (do not put other mods in here). That’s it! Now move on to step 4.
+<summary>3. Installing the mod</summary>
+
+![srmpInstallBigLinux](./screenshots/srmp-intall-big-linux.jpg)
+
+Once you know the GID (game installation directory) of your game you can move on to actually installing the mod. First up, make sure you have your GID open in a file explorer. Again the GID can be identified by containing a folder called SlimeRancher_Data. Next, open the directory containing the downloaded mod zip archive (probably Downloads). Copy or move the zip into the GID, not into SlimeRancher_Data or another folder inside of the GID, but the GID itself, the directory containing SlimeRancher_Data and such. Now that the zip archive is in place, extract it into this directory. It should replace a file in SlimeRancher_Data, if it does then select yes, if it doesn’t then you have extracted it to the wrong directory or you just need to move it out of a folder first. Once extracted correctly, it should have replaced a file in SlimeRancher_Data and created a new folder called Mods (do not put other mods in here). That’s it! Now move on to step 4.
+
 </details>
 
 <details>
-    <summary>4. Verifying the install</summary>
-    Now to test if everything has installed correctly. Start the game from your launcher and wait for it to load. If installed correctly a console window will also open that probably takes focus from the game. Do not panic, this is a feature and the game is still running in another window. Once in the main menu, you should see a gray box in the top-right. If you do, you did everything correctly. If you don’t, try pressing f4 and if it still doesn’t show up then you did something wrong, go back. Now that you have the mod installed correctly, you can enter a username in the gray box, it can be anything and will be the name shown in-game. Now that the mod is installed and working you can move on to using the mod.
+<summary>4. Verifying the install</summary>
+Now to test if everything has installed correctly. Start the game from your launcher and wait for it to load. If installed correctly a console window will also open that probably takes focus from the game. Do not panic, this is a feature and the game is still running in another window. Once in the main menu, you should see a gray box in the top-right. If you do, you did everything correctly. If you don’t, try pressing f4 and if it still doesn’t show up then you did something wrong, go back. Now that you have the mod installed correctly, you can enter a username in the gray box, it can be anything and will be the name shown in-game. Now that the mod is installed and working you can move on to using the mod.
 </details>
 
 ### Mac
@@ -287,15 +316,34 @@ Note down the port before attempting any of the methods, or use a method with a
 #### Playing using Server Codes
 
 Server Codes is the easiest and quickest thing to try. To put it simply: it works like port forwarding but isn't port forwarding, and doesn't require any of the work.
-All the host has to do is to load a save, host and give the server code to players. The players then use that code to join. Done.
-Note that the success of server codes heavily depends on the host's router and other factors If you run in to many connection-related issues, let someone else host or try using another method.
+All the host has to do is to load a save, host and give the server code to players.
+
+![srmpUseHostServercode](./screenshots/srmp-use-host-servercode.jpg)
+
+The players then use that code to join.
+
+![srmpUseJoinServercode](./screenshots/srmp-use-join-servercode.jpg)
+
+Done! Note that the success of server codes heavily depends on the host's router and other factors. If you run in to many connection-related issues, let someone else host or try using another method.
 
 #### Playing over LAN
 
-This method only works if you and the other player/s are on the same local network (or same wifi, in incorrect terminology aka Layer 8 lingo). One player takes the role as the host. The host needs to load a save, it can be an old one or a new one it doesn’t matter just enter a save. Now in the game, the host checks the menu top right. There will be a few options there. Now the host notes down the port and clicks ‘Host’. The host now needs to find their local IP address. The fastest way to do this is probably through a terminal. On windows: open command prompt, enter ‘ipconfig’ (no ‘ signs) and press enter. Find the correct network adapter in the list and then the local ip. On linux, open a terminal and enter ‘ifconfig’, then do kinda the same thing as on windows. If you don't have net-tools use ´ip a´. Players now from the main menu choose to join a game and join by IP address, entering it into the correct field, and then the port into the correct field and then joining. It’s that simple.
+This method only works if you and the other player/s are on the same local network (or same wifi, in incorrect terminology aka Layer 8 lingo). One player takes the role as the host. The host needs to load a save, it can be an old one or a new one it doesn’t matter. Now in the game, the host pauses and checks the menu top right. Now the host notes down the port and clicks ‘Host’.
+
+![srmpUseHost](./screenshots/srmp-use-host.jpg)
+
+Now for the players to join. There is a simple way to do that using the local discovery feature of srmp.
+
+![srmpUseJoinLocalDiscovery](./screenshots/srmp-use-join-local-discovery.jpg)
+
+If the game is found automatically, you're done! If not, the host needs to find their local IP address. The fastest way to do this is probably through a terminal. On windows: open command prompt, enter ‘ipconfig’ (no ‘ signs) and press enter. Find the correct network adapter in the list and then the local ip. On linux, open a terminal and enter ‘ifconfig’, then do kinda the same thing as on windows. If you don't have net-tools use ´ip a´. Players now from the main menu choose to join a game and join by IP address, entering it into the correct field, and then the port into the correct field and then joining. It’s that simple.
+
+![srmpUseJoinLocalIP](./screenshots/srmp-use-join-local-ip.jpg)
 
 #### Playing over "fake" LAN (VPN)
 
+<!-- I will update this with images as well soon -->
+
 If you aren’t on the same network then there is still a pretty simple way to do it. Introducing, Hamachi! Before you get too exited you should know there is a drawback with this method, two actually. The first one is that you have to sign up for an account, the second one is that Hamachi has a rate limit, meaning that you could run into issues like not being able to see other players and falling through the map. Now the first step to using Hamachi is to getting an account (NOTE: these hamachi instructions are for Windows/Mac, if you are using linux you know better than to use hamachi but you still can, however it is through commandline so you won’t get any help here). You can create an account by going here. Once your account is created and verified and whatnot, download hamachi from their homepage. Now you need to setup and join a hamachi network, which is described pretty well here, skipping the ‘Host a Server’ section and the other game specific part at the end. Once all players are connected to the hamachi network, you just host and join as if you were on the same local network as described in the ‘Playing over LAN’ section above. If Hamachi fails you can try an alternative called Radmin. Hamachi local Ips may be different, if they are then google how to find them or something. I will update this to include instructions for that at some point.
 
 #### Playing over the Internet (port forwarding)
@@ -303,29 +351,79 @@ If you aren’t on the same network then there is still a pretty simple way to d
 The third and most advanced option is port forwarding, but it is also the one giving the best results if all players aren’t on the same network. There are two ways to port forward: via your router’s admin interface or through a UPnP portmapping client. The second one is easiest and most convenient, but not all routers support it, it could also pose a potential security risk. I would recommend trying UPnP first as it is pretty easy with the client I will be using, and try to do it via the admin interface if UPnP doesn’t work. Using a UPnP client doesn't make the security problems with UPnP bigger, because if it works then it is already enabled in your router which means the security flaws are already present.
 
 <details>
-<summary>Via the router's admin interface</summary>
+<summary>Option 1: Via the router's admin interface</summary>
     
 This method of port forwarding is the most complicated of the two, to be honest the UPnP client I used in those instructions isn’t even complicated at all so try that one first if you haven’t already. Now, to get started with this method you need login credentials for your router. They are usually found on a sticker on the back of the router. There might be one for wifi credentials and one for admin credentials so doublecheck that you have the right one. If you are lucky there is a default address listed on the sticker as well (usually called “internal address” or just “ipv4 address”) that will save you some time by skipping the next part of the instruction, finding your router’s local ip.
 
-To find your router’s local ip on windows: open command prompt and run ‘ipconfig’. Look for something that says ‘default gateway’, that should be your router ip. On Linux: open a terminal and run ‘ip route’. The first thing that is displayed should be something like “default via 192.168.1.1”, that ip address at the end is the one you are looking for. On mac: open System Preferences, navigate to Network > Advanced > TCP/IP, and find the IP address listed next to “Router”, that is the one you are looking for.
+<details>
+<summary>On Windows..</summary>
+Open command prompt and run ‘ipconfig’. Look for something that says ‘default gateway’, that should be your router ip.
 
-Now that you have the IP of your router, open a web browser and put it into the address field (do not search for it, enter it as an address). It should open a webpage, if it doesn’t and just searches instead, put http:// in front of the address. Now log in with the credentials you found earlier, some routers display a default status page and requires you to press something before showing the login prompt. Once you are logged in try to find the port forwarding section, for me it was under “NAT/QoS”. Add a new rule. Below are the values you should input, each field might be called something different in your router and there might be extra fields, or less. Generally the other fields can be left empty, otherwise just google them. If you get confused, look up a video or image of port forwarding.
-
-Application name: can be whatever, I will use ‘srmp’
-Source net: can be left empty
-Protocol: UDP
-External start port: the port you noted down earlier
-External end port: same as above
-Internal port: same as above
-IP Address: the IP of your machine (instructions on how to find in ‘Playing over LAN’)
-Enable: yes
-
-Now that the rule is complete, save and/or apply it. You should now be able to exit the admin interface of your router and test the rule. Host the save in the game if you haven’t already. Your friends join with your public IP and the port as described in the intro to this section. If you are unsure you can find your public IP at [https://whatismyipaddress.com](https://whatismyipaddress.com) or similar websites. No they don’t “doxx” you, your public IP address is just as the name suggests publically accessable and is necessary to access the internet. If you are using a VPN, turn it of as it "changes" your public IP to something where you can't map ports.
+![srmpUseHostPortforwardFindrouterWindows](./screenshots/srmp-use-host-portforward-findrouter-windows.jpg)
 
 </details>
 
 <details>
-<summary>Via an UPnP client</summary>
+<summary>On Linux..</summary>
+Open a terminal and run ‘ip route’. The first thing that is displayed should be something like “default via 192.168.1.1”, that ip address at the end is the one you are looking for.
+
+![srmpUseHostPortforwardFindrouterLinux](./screenshots/srmp-use-host-portforward-findrouter-linux.jpg)
+
+</details>
+
+<details>
+<summary>On Mac..</summary>
+Open System Preferences, navigate to Network > Advanced > TCP/IP, and find the IP address listed next to “Router”, that is the one you are looking for.
+
+![srmpUseHostPortforwardFindrouterMac](./screenshots/srmp-use-host-portforward-findrouter-mac.jpg)
+
+</details>
+‎
+
+Now that you have the IP of your router, open a web browser and put it into the address field (do not search for it, enter it as an address). It should open a webpage, if it doesn’t and just searches instead, put http:// in front of the address. Now log in with the credentials you found earlier, some routers display a default status page and requires you to press something before showing the login prompt.
+
+![srmpUseHostPortforwardLogin](./screenshots/srmp-use-host-portforward-login.jpg)
+
+Once you are logged in try to find the port forwarding section, for me it was under “NAT/QoS”. It will look a little different on every router. Add a new rule.
+
+![srmpUseHostPortforwardAdd](./screenshots/srmp-use-host-portforward-add.jpg)
+
+Below are the values you should input, each field might be called something different in your router and there might be more fields, or less. Generally the other fields can be left empty, otherwise just google them.
+
+![srmpUseHostPortforwardFill](./screenshots/srmp-use-host-portforward-fill.jpg)
+
+_Application name_: can be whatever, I will use ‘srmp’
+
+_Source net_: can be left empty
+
+_Protocol_: UDP
+
+_External start port_: the port you noted down earlier
+
+_External end port_: same as above
+
+_Internal port_: same as above
+
+_IP Address_: the IP of your machine (instructions on how to find in ‘Playing over LAN’)
+
+_Enable_: yes
+
+Now that the rule is complete, save and/or apply it. You should now be able to exit the admin interface of your router and test the rule. Host the save in the game if you haven’t already.
+
+![srmpUseHost](./screenshots/srmp-use-host.jpg)
+
+Your friends join with your public IP and the port as described in the intro to this section.
+
+![srmpUseJoinPublicIP](./screenshots/srmp-use-join-public-ip.jpg)
+
+If you are unsure you can find your public IP at [https://whatismyipaddress.com](https://whatismyipaddress.com) or similar websites. No they don’t “doxx” you, your public IP address is just as the name suggests publicly accessible and is necessary to access the internet. If you are using a VPN, turn it of as it "changes" your public IP to something where you can't map ports.
+
+Didn't work? Make sure the port is open using a website such as [portchecker](https://portchecker.co/)
+
+</details>
+
+<details>
+<summary>Option 2: Via an UPnP client</summary>
 
 If you are lucky and your router supports UpnP and it is enabled this method will work for you. Using a special program you can utilize UPnP to create port forwards without having access to your router’s admin interface. To do this we will use a program called portmapper, download the .jar file from Assets [here](https://github.com/kaklakariada/portmapper/releases). You need to have java installed on your system. Once you have downloaded the jar file, run it and a window with a bunch of stuff will show up.
 
@@ -334,27 +432,49 @@ If you have a VPN active, deactivate it before continuing. It can cause issues w
 First you need to connect portmapper to your router, this will also tell you if your router has UPnP enabled or not.
 Click the '_Connect_' button in the '_Router_' box. Give it a while.
 If it works, you will see '_External address_' and '_Internal address_' change from '_(not connected)_' to an IP.
+
+NOTE: If the external address shows up as 100.xx.xx.xx, it is a bogon address and portmappings won't work. In that case you need to change config either in portmapper, your computer or your router. There are a lot of things that could be causing that to happen.
+
+![srmpUsePortmapperConnect](./screenshots/srmp-use-portmapper-connect.jpg)
+
 If it doesn't work, click '_PortMapper Settings..._' and change '_UPnP library_' to something else. NOTE: Don't set it to the dummy one.
+
+![srmpUsePortmapperLibswitch](./screenshots/srmp-use-portmapper-libswitch.jpg)
+
 If none of them worked, then UPnP isn't enabled in your router. The dummy option will always look like it works, but it's for testing and doesn't actually work.
 
 **2. Create port mapping.**
 Click '_Create_' in the '_Port mapping presets_' box. A new window will open.
-In '_Description_', put whatever you want. I put srmp. NOTE: Illegal characters may cause issues on some routers.
-The '_Remote host_' field can be left empty, but you can also put your friend's public IP for improved security. If you encounter issues later on, try emptying this field and do the next steps again.
+
+![srmpUsePortmapperMapping](./screenshots/srmp-use-portmapper-mapping.jpg)
+
+'_Description_' can be whatever you want. I put srmp. NOTE: Illegal characters may cause issues on some routers.
+
+'_Remote host_' can be left empty, but you can also put your friend's public IP for improved security.
+
 For '_Internal Client_' check the '_Use local host_' button. It should select your local network IP, if not make sure you have vpn and tunnels disabled.
+
 Now in the '_Ports_' box click the '_Add_' button.
-Change Protol to UDP. Set both Internal and External port to the one you noted down earlier. If you didn't note down a port, set it to something like 16530 and change in the game later.
+
+Sete Protocol to UDP. Set both Internal and External port to the one you noted down earlier. If you didn't note down a port, set it to something like 16530 and change in the game later.
+
 Now click '_Save_'. Then click '_Use_' in the '_Port mapping presets_' box.
 
 **3. Hosting.**
-Host with the port that you should know by know.
-Your public IP by which other players will join can be found in portmapper (tends to be wrong), or with websites like [this](https://whatismyipaddress.com/).
+Host with the port that you either noted down or just chose.
+
+![srmpUseHost](./screenshots/srmp-use-host.jpg)
+
+Your public IP by which other players will join can be found in portmapper (might be wrong), or with websites like [this](https://whatismyipaddress.com/).
 You usually don't have to worry about removing these portmappings once you're done, as most routers do it on reboot.
 If you want to remove or edit records, use the corresponding buttons in portmapper.
 
 **4. Joining.**
 Players join by the port that you either got or chose, and your public IP.
-If it doesn't work and you put filled the '_Remote host_' field while creating the record: edit the record, clear that field, save it, and click the use button again.
+
+![srmpUseJoinPublicIP](./screenshots/srmp-use-join-public-ip.jpg)
+
+If it doesn't work and you filled the '_Remote host_' field while creating the record: edit the record, clear that field, save it, and click the use button again.
 If it doesn't work and that field is already empty, use a [port checker](https://portchecker.co) to determine if the port is open.
 If it still doesn't work, make sure the external address in portmapper and the one found [here](https://whatismyipaddress.com/) are the same. If not, ask for assistance.
 If you still need more help, ask for help in the discord.
@@ -382,7 +502,7 @@ This window can be quite handy for debugging, and can also be used to enter comm
 
 Here is a bunch of scenarios where some things with the mod might not work for different reasons, and how to solve those issues. Not all issues are listed here, and if this doesn’t help you, ask in the [Discord](https://discord.gg/NtB7baV). The main README file has an up-to-date list of known issues.
 
-**_Before driving yourself insane trying to find a solution to your problem_**, if it's your first time starting an SRMP session, get all players to restart the game entirely. This can fix some common issues. Restarting the game can also fix issues you may encounter later on.
+**_Before driving yourself insane trying to find a solution to your problem_**, if it's your first time starting an SRMP session, get all players to restart the game entirely. This can fix some common issues. Restarting the game can also fix issues you may encounter later on. If you are playing with other mods, they could also be causing issues.
 
 <details>
 <summary>Players are invisible</summary>

screenshots/placeholder

@@ -1 +0,0 @@
-