MUME Wiki

Community wiki and guide to Multi-Users in Middle-earth — a free text-based multiplayer RPG set in Tolkien's world.

Contributing

Non-coders (edit via GitHub)

1. Browse to any page in docs/pages/ on GitHub
2. Click the pencil icon (Edit this file)
3. Make your changes and click Commit changes → Create a new branch and pull request
4. A preview build will be triggered automatically; a maintainer will review and merge

Coders (local development)

Use Docker. All development should be done via Docker to keep the environment consistent with CI.

Dev server with live reload:

docker compose up dev

The site will be available at http://localhost:5174/wiki/.

Production build (mirrors CI exactly):

docker compose up --build wiki

The site will be available at http://localhost:4173/wiki/.

Updating dependencies

Always update packages inside the container so the lock file stays CI-compatible:

docker run --rm -v "$(pwd):/app" -w /app node:22 npm install <package>
git add package.json package-lock.json
git commit -m "chore: update dependencies"

Tech stack

• VitePress — static site generator
• GitHub Actions — CI/CD
• GitHub Pages — hosting