An Open-Source Oldschool Runescape Private Server
Visit Our Forum »
Explore the docs
·
Report Bug
·
Request Feature
RSBox is an Open-Source Runescape Private Server running the latest OSRS revision. It aims to provide a very simple and documented way to build your own custom content in OSRS using our documented API.
Here's What RSBox Offers:
- Streamlined plugin system with Bukkit style API design. The API layer stits on top of the engine so no matter what OSRS revision you use, plugins should not break.
- Drag and drop plugin installation through compiled JAR files.
- No development knowledge needed for server setup. If you just want to run your own RSPS server, we offer download and run solutions to get your server running quickly.
Of course, this is an ongoing long-term project run primarily by our community on discord. If you are at all interested it playing with RSBox, please join our discord by clicking the discord badge at the top.
A list of core contributions can be found in the acknowledgements section at the bottom.
This project relies on a couple of core software and libraries. They are listed below.
You can setup RSBox two different ways, either in an IDE if you plan on adding content.
Or you can download the server JAR executable from the releases page.
Below is a quick guide on how to setup the project both ways. You can always find more information on the Wiki or by joining our discord server.
- Download the latest rsbox-server-.jar from the releases page. You can click on the badge above for quick navigation.
- Before you can start your server for the first time, you must run the setup wizard. This downloads everything needed for RSBox to function properly.
java -Xmx1G -Xms1G -jar rsbox-server-0.1.jar --setup
After the setup wizard completes, You may start your server with the following command.
java -Xmx1G -Xms1G -jar rsbox-server-0.1.jar
- Clone the repository into a directory.
git clone https://github.com/rsbox/rsbox
To run the setup wizard within an IDE, run the gradle setup task.
You can now start the server by just executing `gradle run`.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Kyle Escobar - @KyleEscobar
Project Link: https://github.com/rsbox/rsbox