====== Information ======

  * 2009Scape Server ((https://gitlab.com/2009scape/2009scape))
  * ''master'' Branch ((https://gitlab.com/2009scape/2009scape/-/tree/master?ref_type=heads))

  * These notes provide a local singleplayer server for 2009Scape ((RSPS/RuneScape Private Server based on cache ''530'' from 2009, [[https://gitlab.com/2009scape/2009scape#history-of-this-codebase|more info]])) on Windows (also see [[servers:linux:games:2009scape_localhost|Linux]] and [[servers:bsd:games:2009scape_localhost|FreeBSD]])

===== Prerequisites =====

  * [[windows:10|Windows 10]]

===== Notes =====

  * For a game client, see [[games:windows:rt4_client_runescape_530|RT4 Client]]

====== Dependencies ======

  * https://gitlab.com/2009scape/2009scape#prerequisites
  * Git, Java

===== Git =====

  * https://www.git-scm.com/download/win
  * Last tested: ''Git-2.47.0.2-64-bit.exe''

  * :!: Git LFS component required
  * :!: Git from the command line and also from 3rd-party software (make sure it's selected)
  * Checkout as-is, commit as-is

===== Java =====

  * https://learn.microsoft.com/en-us/java/openjdk/download#openjdk-17
  * Last tested: ''microsoft-jdk-17.0.13-windows-x64.msi''

  * Entire feature install of ''Microsoft Build of OpenJDK''

====== Download Source ======

  * https://gitlab.com/2009scape/2009scape/-/commits/master?ref_type=HEADS

  git clone --branch "master" --depth "1" --recurse-submodules "https://gitlab.com/2009scape/2009scape.git" "%UserProfile%\Projects\2009Scape-Server\src"

  explorer "%UserProfile%\Projects\2009Scape-Server\src"

====== Initial Build ======

  CD "%UserProfile%\Projects\2009Scape-Server\src\Server" && "%UserProfile%\Projects\2009Scape-Server\src\Server\mvnw.cmd" "clean"

  CD "%UserProfile%\Projects\2009Scape-Server\src\Server" && "%UserProfile%\Projects\2009Scape-Server\src\Server\mvnw.cmd" "package"

====== Settings ======

  * Last commit: [[https://gitlab.com/2009scape/2009scape/-/commit/317b4e9b5c330c6492663631d3edca9794dfc2f9|August 10, 2024]] ''317b4e9b''
  * [[https://gitlab.com/2009scape/2009scape/-/commits/master/Server/worldprops/default.conf?ref_type=heads|New commits check]]
  * [[https://gitlab.com/2009scape/2009scape/-/blob/master/Server/worldprops/default.conf?ref_type=heads|Upstream worldprops/default.conf]] ([[https://gitlab.com/2009scape/2009scape/-/raw/master/Server/worldprops/default.conf?ref_type=heads|raw]])

  DEL /Q "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf"

  notepad "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf"

<code>
[server]

# Server
log_level = "verbose"
write_logs = true
msip = "localhost"
secret_key = "2009scape_development"
preload_map = false

# Accounts
use_auth = false
persist_accounts = false
noauth_default_admin = false
daily_accounts_per_ip = 3

# Watchdog
watchdog_enabled = false
connectivity_check_url = "localhost"
connectivity_timeout = 500

[database]

# MySQL
database_address = "localhost"
database_port = "3306"
database_name = "2009scape"
database_username = "2009scape"
database_password = "x"

[integrations]

# Grafana Analytics?
grafana_logging = false
grafana_log_path = "@data/logs"
grafana_log_ttl_days = 1

[world]

# localhost
motw_text = "Welcome to your localhost server!"
show_rules = false
new_player_announcement = false
allow_token_purchase = false
autostock_ge = false
bots_influence_ge_price = false
enable_doubling_money_scammers = false
personalized_shops = false
enable_default_clan = false

# Jagex-like
i_want_to_cheat = false
default_xp_rate = 1.0
runecrafting_formula_revision = 530
allow_slayer_reroll = false
better_agility_pyramid_gp = false
better_dfs = false
enhanced_deep_wilderness = false
skillcape_perks = false
jad_practice_enabled = false

# Holiday (only enable one or none)
force_halloween_randoms = false
force_christmas_randoms = true

# PVP
pvp = false
wild_pvp_enabled = false
revenant_population = 30

# Server config
debug = false
dev = false
start_gui = false
daily_restart = false
smartpathfinder_bfs = true
enable_botting = false
motw_identifier = "0"
ge_announcement_limit = 500
increased_door_time = false
enable_castle_wars = false
verbose_cutscene = false
holiday_event_randoms = true
enable_bots = false
max_adv_bots = 100
new_player_location = "2524,5002,0"
home_location = "3222,3218,0"

# World
name = "2009Scape (::1)"
world_id = "1"
country_id = "0"
members = true
name_ge = "2009Scape"
activity = "2009Scape Classic."

[paths]

# Paths
data_path = "data"
bot_data = "@data/botdata"
cache_path = "@data/cache"
configs_path = "@data/configs"
eco_data = "@data/eco"
grand_exchange_data_path = "@data/eco"
logs_path = "@data/logs"
object_parser_path = "@data/ObjectParser.xml"
save_path = "@data/players"
store_path = "@data/serverstore"

# Drop Tables
rare_drop_table_path = "@data/configs/shared_tables/RDT.xml"
gem_drop_table_path = "@data/configs/shared_tables/GDT.xml"
herb_drop_table_path = "@data/configs/shared_tables/HDT.xml"
cele_drop_table_path = "@data/configs/shared_tables/CELEDT.xml"
allotment_seed_drop_table_path = "@data/configs/shared_tables/ASDT.xml"
uncommon_seed_drop_table_path = "@data/configs/shared_tables/USDT.xml"
rare_seed_drop_table_path = "@data/configs/shared_tables/RSDT.xml"

# End</code>

====== Scripts ======

****

  MKDIR "%UserProfile%\Projects\2009Scape-Server\scripts"

===== Server Start =====

  notepad "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-start.bat"

<code>
@echo off

CD "%UserProfile%\Projects\2009Scape-Server\src\Server"
java -jar "%UserProfile%\Projects\2009Scape-Server\src\Server\target\server-1.0.0-jar-with-dependencies.jar" || exit "1"

:: End</code>

===== Server Update =====

  notepad "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-update.bat"

<code>
@echo off

git -C "%UserProfile%\Projects\2009Scape-Server\src" reset --hard
git -C "%UserProfile%\Projects\2009Scape-Server\src" pull origin "master" --rebase

CD "%UserProfile%\Projects\2009Scape-Server\src\Server"
CALL "%UserProfile%\Projects\2009Scape-Server\src\Server\mvnw.cmd" "clean" "package" -DskipTests
pause
echo Copy Settings from website load into default.conf

explorer "https://wiki.realmofespionage.xyz/servers:windows:games:2009scape_localhost#settings"
DEL /Q "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf"
notepad "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf"

:: End</code>

===== Save Data Back-up =====

  notepad "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-save-backup.bat"

<code>
@echo off

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

echo 2009Scape Save Data Backed-up Successfully to Downloads

pause

:: End</code>

====== Launcher Shortcuts ======

===== Desktop =====

  * Right-click Desktop -> New -> Shortcut

==== Server Start ====

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-start.bat"

  2009Scape Server

===== Start Menu =====

****

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

==== Shortcuts ====

  * Right-click -> New -> Shortcut

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

=== Server Start ===

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-start.bat"

  Server Start

=== Update ===

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-update.bat"

  Server Updater

=== Save Backup ===

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-save-backup.bat"

  Save Data Back-up

=== Updates Check ===

  https://gitlab.com/2009scape/2009scape/-/commits/master?ref_type=heads

  Server - Updates Check

=== Install Notes ===

  https://wiki.realmofespionage.xyz/servers:windows:games:2009scape_localhost

  Server - Install Notes

====== Quick Commands ======

===== Execute =====

===== Server =====

  CD "%UserProfile%\Projects\2009Scape-Server\src\Server" && java -jar "%UserProfile%\Projects\2009Scape-Server\src\Server\target\server-1.0.0-jar-with-dependencies.jar"

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-start.bat"

===== Update =====

  * https://gitlab.com/2009scape/2009scape/-/commits/master

  git -C "%UserProfile%\Projects\2009Scape-Server\src" reset --hard && git -C "%UserProfile%\Projects\2009Scape-Server\src" pull origin "master" --rebase && CD "%UserProfile%\Projects\2009Scape-Server\src\Server" && CALL "%UserProfile%\Projects\2009Scape-Server\src\Server\mvnw.cmd" "clean" "package" -DskipTests

  * [[#settings|worldprops\default.conf]]
  * :!: localhost ''default.conf'' settings are required to be re-applied after the above command

  DEL /Q "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf" && notepad "%UserProfile%\Projects\2009Scape-Server\src\Server\worldprops\default.conf"

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-server-update.bat"

===== Save Data Back-up =====

  * :!: The ''tar'' command replaces ''Downloads\2009Scape-Server-localhost-Saves.tar.gz'' each time without back-up or date codes

  tar -cvzf "%UserProfile%\Downloads\2009Scape-Server-localhost-Saves.tar.gz" -C "%UserProfile%\Projects\2009Scape-Server\src\Server\data" "players"

  "%UserProfile%\Projects\2009Scape-Server\scripts\localhost-save-backup.bat"

  MKDIR "%UserProfile%\Projects\2009Scape-Server\src\Server\data\players"

  explorer "%UserProfile%\Projects\2009Scape-Server\src\Server\data\players"

===== File Manager =====

==== Root ====

****

  explorer "%UserProfile%\Projects\2009Scape-Server\src"

==== Saves ====

****

  explorer "%UserProfile%\Projects\2009Scape-Server\src\Server\data\players"

====== Resources/TODOs ======

  * https://github.com/2009scape/2009Scape-mobile/issues/13
  * https://gitlab.com/2009scape/2009scape/-/raw/master/Server/worldprops/default.conf?ref_type=heads
  * https://gitlab.com/2009scape/singleplayer/windows/-/raw/master/game/worldprops/default.conf
  * https://gitlab.com/2009scape/2009scape/-/blob/master/Server/src/main/core/game/system/config/ServerConfigParser.kt#L66
  * https://gitlab.com/2009scape/2009scape/-/blob/master/Server/src/main/core/game/world/GameSettings.kt#L120
  * ''noauth_default_admin'' to ''true'' if ''::to'' needed/stuck
  * Pest Control and Mining Star bots auto-still appear with bots disabled in conf (bots disabled stops auto-spawn bots at Lumbridge/seemingly general areas)