2004scape Server Documentation

To set up and run the server, follow these steps:

1. Download: Download and extract this repository to a local directory.
2. Install Dependencies: Ensure you have NodeJS 22 and Java 17 (or later LTS versions) installed.
3. Run Quickstart: Open the downloaded folder and run the quickstart script. Follow the on-screen prompts (you may disregard severity warnings).
4. Wait for Startup: Do not attempt to play until the script indicates that the world has started.

Note: The server includes its own web client, so no separate client download is required.

Depending on your role, use the following commands to start the development environment:

Content Developers

Run npm start. The server will watch for changes to scripts and configs, then automatically repack everything.

Engine Developers

Run npm run dev. This performs the same watching/repacking as npm start, but also performs a complete server restart whenever engine code changes.

# For content development
npm start

# For engine development
npm run dev

To use the WebAssembly-compiled bzip2 implementation in Node.js or the browser, install the package using npm:

$ npm install bzip2-wasm

The server requires the following runtime environments:

• NodeJS 22
• Java 17 (later LTS versions are also acceptable)

If you are developing using VS Code, it is recommended to install the 2004scape.runescriptlanguage extension from the marketplace.

The client tracks mouse interactions to determine which tile a user has clicked. This is handled during the drawTileUnderlay process.

When V.takingInput is true, the system checks if the mouse coordinates (V.mouseX, V.mouseY) fall within the projected triangle of a tile's underlay using this.pointInsideTriangle. If a match is found, V.clickTileX and V.clickTileZ are updated with the clicked tile's coordinates.

The level system is organized into a multi-level grid structure. Each tile at a specific level can contain multiple types of data:

1. Layers: The world is divided into multiple levels (e.g., ground level, bridge level, etc.).
2. Tile Composition: A single tile (Z0) acts as a container for:
   • underlay: A r0 object defining base colors/textures.
   • overlay: A y object defining top-layer shapes and textures.
   • wall: A L_ object defining structural walls.
   • locs: A collection of G_ objects representing specific entities or interactive objects.
   • groundDecoration: A b_ object for ground-level items.
   • objStack: An N_ object for stacked items.

This hierarchical approach allows for complex environments where objects can be placed on top of each other or within different vertical layers of the same coordinate.

The client uses specialized classes to manage the rendering and animation of NPCs and Players.

NPC Rendering (I_ class)

Extends s0 (a base entity class). It manages npcType and handles the drawing of sequenced models. It supports spotanim (spot animations) which can be applied as transformations to the base model.

Player Rendering (K0 class)

Manages player appearances, including gender, head icons, and a collection of 12 appearance slots (clothing/equipment).

• Appearance Hashing: Uses an appearanceHashcode to cache models in K0.modelCache to avoid redundant computations.
• Recoloring: Applies specific color palettes for torso and design IDs during model construction.
• Sequences: Supports primary and secondary animation sequences (e.g., walking, turning, running).

To avoid ESLint errors for unused variables, parameters, or caught errors, prefix them with an underscore (_). This is specifically configured for:

• Variables: varsIgnorePattern: '^_'
• Arguments/Parameters: argsIgnorePattern: '^_' (useful for router methods like (req, res) => ... where req might be unused)
• Caught Errors: caughtErrorsIgnorePattern: '^_'

// Example of ignoring an unused parameter
const routerMethod = (_req: Request, res: Response) => {
    res.send('Hello');
};

// Example of ignoring an unused variable
const _unusedVar = 10;