GregHib/void — Gitpedia

<h1>RuneScape Revived</h1> <p>Rediscover 2011 RuneScape with modern server emulation at your fingertips.</p>

<a href="#features">Features</a> •
<a href="#quick-setup">Quick setup</a> •
<a href="#development">Development</a> •
<a href="https://rune-server.org/runescape-development/rs-503-client-and-server/projects/697260-void-634-a.html" target="_blank">Blog</a> •
<a href="https://github.com/GregHib/void/wiki">Documentation</a> •
<a href="https://github.com/GregHib/void/issues">Bugs</a> •
<a href="https://greghib.github.io/void-map/">World Map</a>

void in game picture

</div>

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: Scripts let you add content without touching engine internals.
Lightweight: 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

Make sure you have java 21 or above installed. (java --version on command line)
Extract the latest void.zip released bundle into a directory.
Extract the latest pre-modified game files cache.zip into /data/cache/.
Run either the run-server.bat on Windows, or run-server.sh on Linux.

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

Ctrl + C to exit and shutdown the server when running from a command line terminal.
Run the latest client.jar and login with any username and password to create a new account.

For more details see the full Installation Guide.

[!NOTE]
For common problems see the Troubleshooting Guide.

Development

Use IntelliJ (which is free to use) to develop with Void.
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.

Select git and enter the project URL (Found under the <> Code button on the GitHub page).

git@github.com: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 21+ (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.

bash
./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/ (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.

bash
./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.

Remember to check out our Contributing guidelines before submitting your first pull request!

Run spotless before commiting to ensure formatting is correct:

bash
./gradlew spotlessApply

[!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.

AI Policy

The vast majority of this project was written by hand. AI-assisted contributions are welcome but held to the same bar as any other submission:
keep changes small and focused, ensure they are well tested, and make sure the code follows the style of the surrounding codebase.
Low-effort or bulk-generated PRs will not be accepted.