Welcome to the 2011Scape installation guide, in this guide we will discuss the steps required to install 2011Scape to your local machine and begin the process of developing content, or playing single-player.
Things to keep in mind when installing 2011Scape are that there is no officially supported single-player mode, and that if you choose to play single-player with the bleeding edge commit activity, you are risking your game progress with possible game-breaking bugs. All commits to the official world are not uploaded until quality assured to the best of our ability.
To begin, you'll need to make sure you have the following files downloaded, and installed.
Note: JDK 11 is required for the RS-Client repository, using newer versions of the Java Development Kit is currently untested, and Java 11 is the recommended option
You can skip any of these downloads if you have them already installed, or saved somewhere.
The first step of installation is the game server. To begin, we'll need to clone the repository. To begin, head to the game repository and fork the repository.
Feel free to name the fork whatever you wish, in my case I'll call it 2011Scape-game to make sure that I can recognize it when sifting through my personal repositories.
Next, install and open up GitHub Desktop and start by signing in. Once you are signed in, you should see a screen like this.
Now we'll want to clone the repository we just forked, click on "File" and then "Clone repository..."
Go ahead and search for the repository you just forked, and click "Clone"
You should finally come to a screen that looks like this, go ahead and keep the selection "To contribute to the parent project" active and click continue. Congratulations, you just finished forking and cloning the game server!
Next up we'll want to install the game server on IntelliJ. Make sure you have your cache and xteas downloaded, and IntelliJ installed. To make life easier for you, you can open up the project from GitHub desktop into IntelliJ like so.
You should get a screen that looks like this. Allow some time for Gradle to download the required libraries and to set-up the project, for some computers this can take awhile so be patient!
Once Gradle has finished installing and indexing properly, you'll want to get the files from your cache download and place them in data/cache/
Simply locate and extract the files from the cache.zip you downloaded, you want to make sure you're grabbing the raw files and not the folders.
Next up, make sure xteas.json is downloaded and place the file in data/xteas/
You should now have all the required files in place, which means next up is adding a Gradle run configuration. Follow the next 3 pictures and make sure your Run task is exactly how I wrote it. This is important to ensure that plugins are properly being built when running the server.
Once you've done that, you can now run the server! Simply click on the "Play" button and if you've installed everything correctly, you should see a screen that looks like this.
---
If you are still having issues installing the game server, then we implore you to join our Discord at 2011Scape Discord for further help.
In order to run 2011Scape locally, you need to run the File Server as well.
To do this, you must first clone the File Server:
git clone https://github.com/2011Scape/file-server
Next, you'll need to copy the cache files into file-server/cache like we did earlier with the Game Server.
After you have copied the cache to the File Server, you must cd into it:
cd file-server
Now you need to run the File Server via Gradle.
If you are on Windows, you need to run this command via the command-line:
gradlew.bat run
If you are on Linux, you need to run this command via the command-line:
./gradlew run
After that, you should see the File Server running and ready to serve files to your local client.
Once you have the Game Server and File Server up and running, you need to start the client.
To do this, you must first clone the client:
git clone https://github.com/2011Scape/rs-client
After that, you should open the rs-client folder in IntelliJ, then find RS2Loader.java in the file list and right click it, then select Run RS2Loader.main():
Now you should be able to log in to your local server.