OpenRS2

Introduction

OpenRS2 is an open-source multiplayer game server and suite of associated tools. It is compatible with build 550 of the RuneScape client, which was released in late 2009.

Prerequisites

OpenRS2 requires version 11 or later of the Java Development Kit.

The JDK is required even if a pre-built copy of OpenRS2 is used, as it depends on JDK-only tools, such as jarsigner, at runtime.

Non-free components

OpenRS2 requires the original RuneScape client code, data and location file encryption keys, which we cannot legally distribute.

These files must be manually placed in the nonfree directory (directly beneath the root of the repository), in the following structure:

nonfree
└── lib
    ├── jaggl.pack200
    ├── loader_gl.jar
    ├── loader.jar
    ├── runescape_gl.pack200
    ├── runescape.jar
    └── unpackclass.pack

The CRC-32 checksums and SHA-256 digests of the correct files are:

CRC-32 checksum	SHA-256 digest	File
-1418094567	d39578f4a88a376bcb2571f05da1939a14a80d8c4ed89a4eb172d9e525795fe2	nonfree/lib/jaggl.pack200
-2129469231	31182683ba04dc0ad45859161c13f66424b10deb0b2df10aa58b48bba57402db	nonfree/lib/loader_gl.jar
-1516355035	ccdfaa86be07452ddd69f869ade86ea900dbb916fd853db16602edf2eb54211b	nonfree/lib/loader.jar
-132784534	4a5032ea8079d2154617ae1f21dfcc46a10e023c8ba23a4827d5e25e75c73045	nonfree/lib/runescape_gl.pack200
1692522675	0ab28a95e7c5993860ff439ebb331c0df02ad40aa1f544777ed91b46d30d3d24	nonfree/lib/runescape.jar
-1911426584	7c090e07f8d754d09804ff6e9733ef3ba227893b6b639436db90977b39122590	nonfree/lib/unpackclass.pack

The .gitignore file includes the nonfree directory to prevent any non-free material from being accidentally included in the repository.

Building

Run ./gradlew to download the dependencies, build the code, run the unit tests and package it.

Contributing

OpenRS2 is still in the early stages of development. The current focus is on building underlying infrastructure, such as the deobfuscator, rather than game content. This approach will make it much quicker to build game content in the long run, but it does mean OpenRS2 won't be particularly useful in the short term.

If you're interested in contributing new features, you should discuss your plans in our Discord server first. I have rough plans in my head for the future development direction. Communicating beforehand will avoid the need for significant changes to be made at the code review stage and make it less likely for your contribution to be dropped entirely.

Code style

All source code must be formatted with IntelliJ IDEA's built-in formatter before each commit. The 'Optimize imports' option should also be selected. Do not select 'Rearrange entries'.

OpenRS2's code style settings are held in .idea/codeStyles/Project.xml in the repository, and IDEA should use them automatically after importing the Gradle project.

Kotlin code must pass all of ktlint's tests.

Always use // for single-line comments and /* for multi-line comments.

Commit messages

Commit messages should follow the 'seven rules' described in 'How to Write a Git Commit Message', with the exception that the summary line can be up to 72 characters in length (as OpenRS2 does not use email-based patches).

You should use tools like interactive rebase to ensure the commit history is tidy.

Developer Certificate of Origin

OpenRS2 uses version 1.1 of the Developer Certificate of Origin (DCO) to certify that contributors agree to license their code under OpenRS2's license (see the License section below). To confirm that a contribution meets the requirements of the DCO, a Signed-off-by: line must be added to the Git commit message by passing --signoff to the git commit invocation.

If you intend to make a large number of contributions, run the following commands from the repository root to add Signed-off-by: line to all your commit messages by default:

echo -e "\n\nSigned-off-by: $(git config user.name) <$(git config user.email)>" > .git/commit-template
git config commit.template .git/commit-template

The full text of the DCO is available in the DCO file.

OpenRS2 does not distribute any of Jagex's intellectual property, and care should be taken to avoid inadvertently including any in contributions.

Versioning

OpenRS2 uses Semantic Versioning.

Links

• Discord
• KDoc
• Website

License

OpenRS2 is available under the terms of the ISC license, which is similar to the 2-clause BSD license. The full copyright notice and terms are available in the LICENSE file.