Skip to content

docs: add local server setup guides, GM handbook, and generated ID references - #3

Open
andrenogrib wants to merge 14 commits into
dwSize-PE:masterfrom
andrenogrib:docs/local-server-handbook-and-id-reference
Open

docs: add local server setup guides, GM handbook, and generated ID references#3
andrenogrib wants to merge 14 commits into
dwSize-PE:masterfrom
andrenogrib:docs/local-server-handbook-and-id-reference

Conversation

@andrenogrib

Copy link
Copy Markdown

Summary

This PR turns the current local server setup knowledge into versioned project documentation and adds a small set of opt-in helper scripts to make local runtime validation much easier.
The main goal is to make the project significantly easier to bootstrap, operate, and inspect without requiring contributors to reverse-engineer the runtime pack or dig through the source tree first.

What is included

  • Translate and polish the documentation in English
  • Add beginner-friendly local setup, startup, and test guides
  • Add a practical GM/Admin handbook for in-game operations
  • Add account and character management documentation
  • Add a dedicated guide for the localhost game.dll runtime patch
  • Add a scripts handbook that explains the PowerShell tooling and intended usage
  • Add troubleshooting notes for real local runtime issues already observed
  • Add generated quick-reference tables for maps, monsters, equipment, potions, and other item IDs
  • Add a script to regenerate the reference markdown files from shared/map.h and GameDB

Why this is useful

  • Reduces onboarding time for anyone trying to run the server locally
  • Captures runtime-specific knowledge that would otherwise stay tribal or get lost in chat logs
  • Makes GM/admin workflows easier to discover and safer to repeat
  • Gives contributors copy-ready ID references instead of requiring manual SQL lookups every time
  • Keeps the large Files/ runtime pack out of Git while still documenting how to work with it

Notes for reviewers

  • No gameplay logic or engine behavior was changed in the client/server source
  • Files/ is intentionally not included in the PR
  • The helper scripts are local, opt-in tooling for setup, lookup, and documentation generation
  • The generated ID references can be refreshed at any time with scripts/export-pt-reference-docs.ps1

High-level file groups

  • docs/guides/*: local setup, startup, GM, account, runtime patch, scripts, and events docs
  • docs/reference/*: command reference, item data reference, and generated lookup tables
  • docs/reference/ids/*: dedicated ID section for maps, monsters, equipment, potions, and other items
  • docs/troubleshooting/*: local runtime issue notes and workarounds
  • scripts/*: local helper scripts for SQL restore, server startup, account provisioning, item/map/monster lookup, and doc export

Validation performed

  • Regenerated the markdown references with scripts/export-pt-reference-docs.ps1
  • Validated lookup helpers for maps and monsters against the local database
  • Reviewed links and indexing so the new docs structure is navigable from the root README and the docs index

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant