Skip to content

LostCityRS/Engine-TS

Repository files navigation

Lost City - November 23, 2004

Note

Learn about our history and ethos on our forum: https://lostcity.rs/t/faq-what-is-lost-city/16

Reverse-engineered engine code designed to accurately simulate the cycle behaviors of early RS2. Contains the necessary data tools and compatible network protocol.

Game data is in the Content repository.

The project organizes historical versions into branches. You will need matching engine and content branches together to run the project.

Getting Started

Important

If you run into issues, please see our common issues.

The Server repository will simplify setup for most users. Download that repository and follow the instructions there.

Manual Setup

In absence of the Server scripts, download the specific engine and content repositories/branches you desire and extract them to the same parent folder.

git clone https://github.com/LostCityRS/Engine-TS -b 274 --single-branch engine
git clone https://github.com/LostCityRS/Content -b 274 --single-branch content
cd engine
npm start

* use --single-branch when you don't need to track the commit history of all versions

Open http://localhost:8898/setup to configure world settings. This page reads and writes data/config/world.json through the management server.

Client

Client-Java is available for all versions. This is a research project to decompile and understand the original code. It has minor fixes for OS and Java compatibility.

Client-TS may be available depending on the version. This is a human-driven port of the original code to modern browsers. This gets prebuilt and included in this repository if available.

You can use the original obfuscated compiled applet from this time period with these arguments: java -cp runescape.jar client 10 0 highmem members 32
Be aware it may have compatibility issues (that are addressed in the Client-Java repository).

Dependencies

Tip

If you're using VS Code (recommended), we have an extension to install on the marketplace.

Workflow

Content developers should run npm start. The server will watch for changes to scripts and configs, then automatically repack everything.

Engine developers should run npm run dev. This does what npm start does above, but also completely restarts the server when engine code has changed.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

RS engine behavior in TypeScript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors