TF-Minecraft's web home for maps, characters, and custom creations.
TFMCWeb powers the TFMC website and its connected world services. It brings together the interactive map, character creation, skin submissions, custom drinks, and player guides.
It connects the Minecraft world with a browser experience: players can explore the political landscape, manage character details, and work on creations that return to the game through the companion plugins.
- Interactive world maps — explore provinces and political information, including nations, settlements, installations, and wars.
- World history — browse the chronicle and archived map chapters to revisit changes in the world.
- Character creation and profiles — create characters and manage their profiles, wardrobes, and kits through the website.
- Custom skin submissions — submit supported cosmetic skins through an in-game-code-linked workflow.
- Drink design — create BreweryX recipes and submit custom drinks for staff review.
- Accounts and staff tools — sign in with Discord, manage linked accounts and supporter status, and use role-controlled player, activity, rail, and permission panels.
- Discord moderation — record cases against Discord or Minecraft accounts, browse each person’s case history, and select linked accounts for Minecraft notifications.
- Player knowledge hub — browse the wiki's guides to crafting, professions, equipment, economy, and other server features.
SimpleFactions, RPCharacters, and DrinkBuilder connect the website to their respective in-game experiences.
Technical documentation for the site lives in docs/. Shared platform documentation stays in TF-Minecraft/Docs.
CI uses Node 22 and Python 3.12. From the repository root, install dependencies and run the frontend Vitest and backend pytest suites with the same JUnit output:
(cd frontend && npm ci && npm test -- --reporter=default --reporter=junit --outputFile.junit=../test-results/frontend.xml) &&
(cd backend && python -m pip install -r requirements.txt -r requirements-dev.txt && python -m pytest -q --junitxml=../test-results/backend.xml)Backend tests that take the postgres fixture (backend/src/database/testing.py)
need a Postgres server and a superuser URL in TEST_DATABASE_URL; each run creates
and drops its own database. Without it they skip locally. CI runs them against a
pgvector/pgvector:pg17 service. Locally, for example:
docker run --rm -d --name ps-test-pg -p 55432:5432 -e POSTGRES_PASSWORD=test \
--tmpfs /var/lib/postgresql/data pgvector/pgvector:pg17 -c fsync=off
export TEST_DATABASE_URL=postgresql://postgres:test@127.0.0.1:55432/postgresCI also lints the frontend with oxlint and checks its formatting with oxfmt.
From frontend/, npm run lint and npm run format:check run the same checks;
npm run format rewrites files in place.
CI uploads test-results/frontend.xml and test-results/backend.xml, then builds
the Next.js frontend. No coverage threshold is enforced. The suites exercise
website components, application logic, and APIs in isolation; they do not run a
live Minecraft server, companion plugins, or real external-service flows.
The Discord cog suite uses Python 3.11 and discord/requirements-test.txt:
python -m pytest -q discord/test_identity_commands.py. It exercises Red command
definitions, Discord modals and local HTTP lookups without signing into Discord.
Copyright (c) 2026 TF-Minecraft contributors.
TF-Minecraft-authored material in this repository is licensed under the Artistic License 2.0. The miniature skin converter adapts MiniSkin Generator by Christian (nirastich) under GPL-3.0, with attribution and changes. Other third-party dependencies and bundled material retain their own licenses.