Void

RuneScape Revived

Rediscover 2011 RuneScape with modern server emulation at your fingertips.

Features  •  Quick setup  •  Development  •  Blog  •  Documentation  •  Bugs

Features

• High-performance: Capable of supporting thousands of concurrent players.
• Rich content: Offers a wide range of emulated content.
• AI player characters: Introduced intelligent player bots to enhance immersion.
• User-friendly: Simplifies content creation with kotlin scripting eliminating the need for complex integration.
• Lighweight: Memory usage under 300MB in low-memory mode.
• Customisable: Personalise your gameplay by tweaking settings in the game.properties file or modifying the code to suit your preferences.

Quick setup

1. Make sure you have java 19 or above installed. (java --version on command line)

2. Extract the latest void.zip released bundle into a directory.

3. Extract the latest pre-modified game files cache.zip into /void/data/cache/.

4. Run either the run-server.bat on Windows, or run-server.sh on Linux.

   You should see [Main] - Void loaded in 2349ms to show the server is up and running correctly.

   Ctrl + C to exit and shutdown the server when running from a command line terminal.

5. Run the latest client.jar and login with any username and password to create a new account.

Note

For common problems see the Troubleshooting Guide.

Development

It is recommended to use IntelliJ IDEA to develop with Void. The community edition can be downloaded for free from the jetbrains website. See the installation guide for more instructions.

Once opened the IDE click the Clone Repository button or File | New | Project from version control... | if in the full application.

Selecting git version control and entering the void project URL Found under the <> Code button on the GitHub page.

• [email protected]:GregHib/void.git if you have GitHub authentication setup.
• https://github.com/GregHib/void.git if you don't have SSH authentication.

Note

When git is not installed it will display an error and the option to "Download and install", click this and retry the previous step. Click "Trust Project" if also asked.

Press "clone" and after the download is complete the project will be opened for you.

Under Project Structure... | Project settings set SDK to JDk 19+ (download as needed) and let it index.

Run the following command in the terminal to set up Gradle or close and re-open the project to trigger IntelliJ's Open as Gradle Project popup.

./gradlew build -x test

Extract the cache files into a new directory called /cache/ inside of the /data/ directory.

From here you can navigate in the left panel to /game/src/main/kotlin/world/gregs/voidps/ (Or Ctrl/Cmd + N for class search) where you will find Main.kt which you should be able to right-click and run.

You can also run in the command line using the gradle wrapper.

./gradlew run

Once the server is up and running; download one of the prebuilt client.jars or set up the void-client repository and run to log into the game.

Don't forget to check out our Contributing guidelines before submitting your first pull request!

Tip

There are instructions on how to build your own client and build your own cache!

Documentation

For further guides on how to write content please refer to the Void Wiki.

Bugs

If you run into any problems or find any bugs please report them by creating a New Issue on our Issues Page describing the problem, so it can be fixed.

Thanks to

• All contributors
• Kris - osrs-docs
• Ebp90
• Jarryd
• Tomm - RSMod Pathfinder
• Graham - OpenRS2