Open-source multiplayer game server compatible with the RuneScape client https://www.openrs2.org/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Graham 8a7ca33aa4 Fix CacheDownloader locking up indefinitely if connect() fails 1 month ago
.github/workflows Re-add support for deploying with CI 9 months ago
.idea Update run configurations 2 years ago
all Replace use of deprecated buildDir property 9 months ago
archive Fix CacheDownloader locking up indefinitely if connect() fails 1 month ago
asm Make enabled transformers and their order configurable in profile 4 months ago
buffer Update Guice 9 months ago
buffer-generator Add blank line between is blocks 2 years ago
cache Fix Js5MasterIndex creation if the LENGTHS format is used 4 months ago
cache-550 Update Guice 9 months ago
cache-cli Add tool for unpacking OpenNXT caches 2 years ago
cli Add Gradle 7 version catalog 3 years ago
compress Add blank line between is blocks 2 years ago
compress-cli Preserve timestamps in unpack200 command 10 months ago
conf Add support for dedicated activity flag 8 months ago
crc32 Add Logback configuration file 3 years ago
crypto Rename XteaKey to SymmetricKey 9 months ago
db Update dependencies 2 years ago
decompiler Update Guice 9 months ago
deob Update Guice 9 months ago
deob-annotations Rename dev.openrs2 package to org.openrs2 4 years ago
deob-ast Update Guice 9 months ago
deob-bytecode Convert IntValueSet.Unknown to a data object 4 months ago
deob-processor Add blank line between is blocks 2 years ago
deob-util Update Guice 9 months ago
etc Implement world list packet 3 years ago
game Remove urgent requests from prefetch queue 5 months ago
gradle Update dependencies 5 months ago
http Update Guice 9 months ago
inject Add assisted injection extension 2 years ago
json Update Guice 9 months ago
log Switch to Ktor's Jetty backend 1 year ago
net Update Guice 9 months ago
patcher Use getArgumentExpressions in HighDpiTransformer 7 months ago
protocol Format WorldListResponseCodec 7 months ago
share Make enabled transformers and their order configurable in profile 4 months ago
util Add ZipInputStreamExtensions 10 months ago
xtea-plugin Remove PF4J 9 months ago
yaml Update Guice 9 months ago
.editorconfig Ignore ktlint rules we're not compatible with yet 9 months ago
.gitignore Remove Drone configuration 9 months ago
.mailmap Map old Git author emails to openrs2.org 4 years ago
CONTRIBUTING.md Make CONTRIBUTING.md slightly more accurate 3 years ago
DCO Move DCO to a separate file 4 years ago
LICENSE Update copyright year 1 year ago
README.md Replace Drone badge with GitHub Actions 9 months ago
build.gradle.kts Fix path in publishDokka task 9 months ago
gradle.properties Update Dokka to 1.4.0-rc 4 years ago
gradlew Update Gradle 8 months ago
gradlew.bat Update Gradle 1 year ago
settings.gradle.kts Update dependencies 5 months ago

README.md

OpenRS2

GitHub Actions Discord ISC license

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
└── share
    ├── cache
    │   ├── 0
    │   │   ├── 0.dat
    │   │   └── ...
    │   ├── ...
    │   └── 255
    │       ├── ...
    │       └── 28.dat
    └── keys.json

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

CRC-32 checksum SHA-256 digest File
-1418094567 d39578f4a88a376bcb2571f05da1939a14a80d8c4ed89a4eb172d9e525795fe2 jaggl.pack200
-2129469231 31182683ba04dc0ad45859161c13f66424b10deb0b2df10aa58b48bba57402db loader_gl.jar
-1516355035 ccdfaa86be07452ddd69f869ade86ea900dbb916fd853db16602edf2eb54211b loader.jar
-132784534 4a5032ea8079d2154617ae1f21dfcc46a10e023c8ba23a4827d5e25e75c73045 runescape_gl.pack200
1692522675 0ab28a95e7c5993860ff439ebb331c0df02ad40aa1f544777ed91b46d30d3d24 runescape.jar
-1911426584 7c090e07f8d754d09804ff6e9733ef3ba227893b6b639436db90977b39122590 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.

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.