Table of Contents

Information

Media

Prerequisites

Resources

Web

Dependencies

Git

Java

Node.js

Firewall

LAN

netsh advfirewall firewall add rule name="2004Scape Server" dir="in" action="allow" protocol="tcp" localport="80,43594,43595" remoteip="localsubnet"

Download Source

git clone --branch "main" --depth "1" --recurse-submodules "https://github.com/2004Scape/Server.git" "%UserProfile%\Projects\2004scape-server\src"
explorer "%UserProfile%\Projects\2004scape-server\src"

Launcher Scripts

MKDIR "%UserProfile%\Projects\2004scape-server\scripts\"

Server Start

notepad "%UserProfile%\Projects\2004scape-server\scripts\localhost-server-start.bat"
@echo off

CD "%UserProfile%\Projects\2004scape-server\src\"
npm start

:: End

Server Update

notepad "%UserProfile%\Projects\2004scape-server\scripts\localhost-server-update.bat"
@echo off

start "" "https://github.com/2004Scape/Server/commits/main/"
git -C "%UserProfile%\Projects\2004scape-server\src" reset --hard
git -C "%UserProfile%\Projects\2004scape-server\src" pull origin "main" --rebase

echo If there are no updates, Ctrl + C to terminate, or Press any key to continue.
pause

CD "%UserProfile%\Projects\2004scape-server\src\"
npm run "clean" && pause

:: End

Streamlined

notepad "%UserProfile%\Projects\2004scape-server\scripts\localhost-server-update.bat"
@echo off

git -C "%UserProfile%\Projects\2004scape-server\src" reset --hard
git -C "%UserProfile%\Projects\2004scape-server\src" pull origin "main" --rebase

CD "%UserProfile%\Projects\2004scape-server\src\"
npm run "clean" && pause

:: End

Save Data Back-up

notepad "%UserProfile%\Projects\2004scape-server\scripts\localhost-save-backup.bat"
@echo off

tar -cvzf "%UserProfile%\Downloads\%RANDOM%-2004Scape-Server-localhost-Saves.tar.gz" -C "%UserProfile%\Projects\2004scape-server\src\data" "players"

echo 2004Scape Save Data Backed-up Successfully to Downloads
explorer "%UserProfile%\Downloads\"

pause

:: End

Launcher Shortcuts

Desktop

Server Start

"%UserProfile%\Projects\2004scape-server\scripts\localhost-server-start.bat"
2004Scape localhost Start

Client

http://localhost:80
2004Scape localhost

Icon

"%UserProfile%\Projects\2004scape-server\src\public\favicon.ico"

Start Menu

MKDIR "%AppData%\Microsoft\Windows\Start Menu\Programs\2004Scape\"

Shortcuts

explorer "%AppData%\Microsoft\Windows\Start Menu\Programs\2004Scape\"

Server Start

"%UserProfile%\Projects\2004scape-server\scripts\localhost-server-start.bat"
localhost Server Start

Client

http://localhost:80
localhost Client
Icon

"%UserProfile%\Projects\2004scape-server\src\public\favicon.ico"

Update

"%UserProfile%\Projects\2004scape-server\scripts\localhost-server-update.bat"
localhost Server Updater

Save Backup

"%UserProfile%\Projects\2004scape-server\scripts\localhost-save-backup.bat"
localhost Save Data Back-up

Install Notes

https://wiki.realmofespionage.xyz/games;windows;2004scape_localhost
localhost Install Notes

Quick Commands

Execute

Server

CD "%UserProfile%\Projects\2004scape-server\src\" && npm start
"%UserProfile%\Projects\2004scape-server\scripts\localhost-server-start.bat"

Client

Update

git -C "%UserProfile%\Projects\2004scape-server\src" reset --hard && git -C "%UserProfile%\Projects\2004scape-server\src" pull origin "main" --rebase && CD "%UserProfile%\Projects\2004scape-server\src\" && npm run "clean"
"%UserProfile%\Projects\2004scape-server\scripts\localhost-server-update.bat"

Save Data

Back-up

explorer "%UserProfile%\Projects\2004scape-server\src\data\players\"
tar -cvzf "%UserProfile%\Downloads\2004Scape-Server-localhost-Saves.tar.gz" -C "%UserProfile%\Projects\2004scape-server\src\data" "players"
"%UserProfile%\Projects\2004scape-server\scripts\localhost-save-backup.bat"

Restore

DEL /Q "%UserProfile%\Projects\2004scape-server\src\data\players\*"
tar -xvzf "%UserProfile%\Downloads\2004Scape-Server-localhost-Saves.tar.gz" -C "%UserProfile%\Projects\2004scape-server\src\data" "players"

npm

CD "%UserProfile%\Projects\2004scape-server\src\" && npm run

File Manager

Root

explorer "%UserProfile%\Projects\2004scape-server\src\"

Save Data

explorer "%UserProfile%\Projects\2004scape-server\src\data\players\"
3)
RSPS/RuneScape Private Server based on cache 225 from May 18th, 2004
4)
later use of tar commands for Save Data requires Windows 10 1803+; presumably fine on W11; can apparently run on XP too
5)
contents should look like \Downloads\2004Scape-Server-localhost-Saves.tar.gz\2004Scape-Server-localhost-Saves.tar\players\espionage724.sav