ORSC/Linux Getting Started Guide.md

Guide for running OpenRSC on Linux

Using the built-in installation script with Docker

** Note: It is suggested to only run the installation scripts on a fresh Ubuntu install or within a VM. These are used for the production server hosting. **

Installing Java

You will need to have Java 8 or above installed in order to run the game server and client. We recommend the latest version of OpenJDK.

Starting the game

You are now ready to run "./Start-Linux.sh"

You must have the game server fully running before the game client. You can verify it is running after starting it up by typing "screen -r" and pressing enter. To "minimize" the screen instance of the running game server and not close it, type "CTRL + A + D" and it will return to your previous console view.

Once you open the game client, you will need to click "New User" to create a player. If you become stuck on Tutorial Island or just wish to skip it, there is a link in the in-game options menu above the log out that reads "skip tutorial".

Changing game features and configuration

At this point, you may wish to use different game features than the default RSC ones. This requires you to fully exit the game client and the game server (use choice #2 to exit in the command prompt window) to fully shut it down.

Now navigate to "server" and delete the existing file named "local.conf", then make a copy of "rsccabbage.conf", renaming the duplicate file "local.conf". Same applies for "preservation.conf" and the other files in that directory. If "local.conf" exists, the game server will override the settings that are in "default.conf". Think of "preservation.conf" and "rsccabbage.conf" as ready to go config presets.

Depending on server configuration, your server port may differ. If 43594 is instead now 43595 because "rsccabbage.conf" is being used, and you do not wish to edit it any, you will need to go into "core -> Client_Base -> Cache" and edit "port.txt" to reflect the new port being used by the game server.

Developers should avoid editing "default.conf" and instead make a copy the chosen .conf file, rename it to "local.conf" and use that instead. That way, they always have working config to fall back on if something doesn't work the way they expect.

Last but not least, always restart the game server after fully exiting it when you have made changes to your "local.conf" in order to have them be applied. An already running server will not read any changes to the file.

Changing a player's role

Are you ready to set a player role as an admin, moderator, or back to a player? It is possible to set the role / group ID while in-game using a command but you can also use the make command of:

make rank db=cabbage group=0 username=wolf