slashx124/project-gielinor

Project Gielinor is a community driven fork of RS Mod, an open source emulator for Old School RuneScape style game servers, written in Kotlin. The goal stated by the creator is to build a faithful, modern recreation of the classic game as a shared community effort rather than a commercial product, since a project of this size and history is too large for one person to keep up with alone. The project currently focuses on recreating game revision 239 as mechanically accurately as possible, along with matching cache and network protocol files from that era. It builds directly on top of RS Mod for its core server architecture and plugin system, and also credits several other open source projects it depends on: RSProt for the low level OSRS networking protocol, RSProx as a recommended proxy and client bridge for connecting to private servers, and OpenRS2 for cache archive tools. To run the project you need Java 21 or newer. It can be set up either through IntelliJ by cloning the repository directly from version control and running the included GameServer configuration, or from the command line using Gradle commands to install dependencies and start the server. The first time the server starts it downloads required game data files, so later starts are faster. If you edit certain map or spawn configuration files, the project needs a separate cache repacking command run before starting the server again for those changes to take effect. For connecting a game client, the project recommends RSProx, a free proxy tool that also supports inspecting network packets, and it ships a ready made configuration file so players do not need to write their own connection settings by hand. The project keeps the same ISC license as its upstream RS Mod project, a short permissive license that lets anyone use, copy, and modify the code as long as the original copyright and permission notice stay attached.