usodst / 2009Scape

Open source 2009 Runescape Remake

2009Scape - The most complete Runescape Emulation server. Pull requests welcome!

Join our Discord server: https://discord.gg/43YPGND

We also have a live game in the Releases section that always runs the latest code.

For information about what data we store, read over this.

Running your own instance

Please follow this self hosting guide

Setting up the project for debugging

Requirements:

• General knowledge of git
• General knowledge of SQL
• Intellij

Be sure to check the debugging section when something goes wrong.

Step 1:

Fork this repository to your repo

Step 2: Setting up IntelliJ

• Open IntelliJ
• Click File > New > Project from Version Control
  • Paste the URL of your forked repository in the URL field, click Done
  • Wait for the repository to clone
• Click File > Project Structure > Modules > 2009scape > Paths > Inherit project compile output path
  • Hit OK
• Click File > Project Structure > Project > Change the Project Compiler Output to the folder where the project exists on your computer
• In the bottom right of IntelliJ, where it specifies the branch, make sure you are developing on the development branch.

Step 3: Setting up the Database

Since this portion of the guide is operating-system specific, you will either need basic database knowledge or a bit of help. Below are the things that need to be configured.

Windows & Linux GUI:

• Download and install xampp
• Start the Apache and MySQL modules
• Navigate to http://localhost/phpmyadmin/
• Create a new database called global
• ImportServer/global.sql into that database
  • Refer here for help importing the .sql files

Linux Command Line

• Something along these lines should do the trick: mysql -u root -p global < global.sql

Step 4: Running the Server & Client

• YOU ONLY HAVE TO DO THIS ONCE: Copy the contents of Server/data/cache/ to:
  • (WINDOWS) C:\Users\You\.runite_rs\runescape
  • (LINUX) ~/.runite_rs/runescape
• Run the management-server
  • In IntelliJ, navigate to Management-Server/src/main/java/ms/Management.java, right click > Run Image
• Run the server
  • In IntelliJ, navigate to Server/src/main/java/Server/core/Server.kt, right click > Run Image
• Run the client
  • In IntelliJ, navigate to Client/src/main/java/org/runite/Client.java, right click > Run Image

You should now be set up!

Debugging

Errors could not find library:

• Click File > Project Structure > Modules > 2009scape > Paths > Inherit project compile output path
  • Now click Dependencies
  • Click the + on the right-hand side > JARs or directories
  • Add the following things:
    • Client/lib directory
    • Client/clientlibs.jar file
    • Management-server/lib directory

Errors regarding java.nio.BufferUnderflowException in server:

• Reclone the repository. This happened to me (Red Bracket) once, could never reproduce.

CRC Mismatch

• You forgot to copy the cache.

Bridges not working/general compilation issues

• This project uses JDK/OpenJDK 8. Make sure you are on version 8. Anything besides JDK or OpenJDK we will not help you troubleshoot.