Skip to content

2004Scape/Client2

Repository files navigation

2004Scape Client2 - May 18, 2004

Website | Discord | Rune-Server

status: completely ported

The client code was source ported to TypeScript by us.
Jagex has never had any source code leaks.

Site Index

Client

Try out the client hosted on Github! It is 100% source ported and available to use. Create your account on the 2004scape website.

World High Detail Low Detail Members
1 (Central USA) Play Now! Play Now! No
2 (Central USA) Play Now! Play Now! Yes
3 (Germany) Play Now! Play Now! Yes
4 (Germany) Play Now! Play Now! No

Playground - An Interactive Model Viewer

Items Viewer - View All the Items

Message Animation Viewer - A Chat Message Animation Editor

Sounds Viewer - Sounds Viewer & Listener

Viewer - A Cache Viewer (WIP)

Interface Editor - An Interface Editor (WIP)


Commands

::debug Shows performance metrics (FPS, frame times and more).

::chat Changes between 3 different chat font eras.

::fps Set a targeted FPS (ex. ::fps 30)

A developer can utilize the debug command for development purposes. debugging


First Time Installation

npm install
npm run prepare
npm run build:dev

If you are on a Mac:

chmod ug+x .husky/*
chmod ug+x .git/hooks/*

Local

Local development should be done with: npm run dev

The client will automatically launch connecting to World 1. Local world is hosted on World 0. You have the ability to connect to live servers from the local client by changing the param.

https://localhost:8080/?world=0&detail=high&method=0 (TypeScript)

This is not to be confused with the Java TeaVM client which is hosted here if the local server is running:

https://localhost/client?world=0&detail=high&method=0 (Java)

Web Worker server and WebRTC peer to peer connections

A web worker server will start when loading world 999. This works as a no install, offline, singleplayer version of the server. You will need to self host in order to load saves.

How to use:

  1. Run npm run build and then npm run bundle in the server, this copies all required files to ../Client2/public. Start client with npm run prod.
  2. A save dialog will open on logout, you should save to /public/data/players.
  3. Optional: To host on github uncomment the lines starting with !/public in the .gitignore.

Combined with WebRTC connections you'll be able to host servers using just your browser by manually exchanging a message for each peer. Players that want to join will have to be on world 998 which won't start a web worker server.

Clicking New user on login screen or additionally ::peer ingame for hosts will open a prompt and write either an offer (host) or answer (peer) to clipboard automatically. This message can contain your public IP. Pass the offer to the peer, peer returns the answer and you'll be connected! Closing the prompt will reset the process and allows for any amount of peers.