Neptune is a free, open-source multiplayer game server and toolset primarily targeting Old School RuneScape.
- Java 17
- Kotlin 2.1.0
The primary goal for this project is to have a development environment similar to the real thing. The follow is a brief overview of the overall goals of the project.
- Accurate game server replicating the majority of the core mechanics.
- Cache tooling for making additions and modifications to the game cache.
- ClientScript compiler
- Config type packers (
obj,npc,struct, etc.)
- And more...
Some modules may have more information in their README.
- clientscript-compiler - An implementation of
runescript-compilerthat targets ClientScript 2. - runescript-compiler - A base compiler implementation intended to be used for ClientScript 2 and RuneScript 2.
- runescript-parser - A parser for the RuneScript language.
- runescript-runtime - A simple bytecode interpreter for RuneScript.
To build the project run ./gradlew build.
Pull requests are welcome on GitHub.
- All contributions must follow the style guidelines, for checking you can use
./gradlew check. - Commit messages must follow conventional commits. If a commit message doesn't follow what we would like, we will request changes or modify it ourselves if the PR allows it.
Neptune is licensed under the MIT license. See LICENSE for the full text.