Skip to content

Latest commit

 

History

History
106 lines (66 loc) · 5.21 KB

README.md

File metadata and controls

106 lines (66 loc) · 5.21 KB
Raw

Void

void

Release Docker Codecov Kotlin License

RuneScape Revived

Rediscover 2011 RuneScape with modern server emulation at your fingertips.

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

void in game picture

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 inside the IDE, you can create a new project by going to File | New | Project from version control... |

Selecting git version control and entering the void project URL git@github.com:GregHib/void.git found under the <> Code button on the GitHub page.

Press clone and after a little while the project will be opened for you, the JDK indexed and gradle setup.

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/ 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; setup the void-client repository or download one of the prebuilt client.jars 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

image