Skip to content

Repository files navigation

TF-Minecraft Docs

The technical home for TF-Minecraft's plugins, website, and shared systems.

Explore how TF-Minecraft's projects fit together, from crafting and roleplay to vehicles, trade, and server administration. This repository collects the guides for setup, architecture, configuration, integrations, testing, and operations. Each source repository's README introduces what that project does; its technical guides live here.

TFMC runs Minecraft 1.21.10 on Java 21. The shared platform and build baseline defines common runtime, toolchain and validation conventions, with the current build declarations for each plugin.

Start here

Looking for… Go to…
Java and Minecraft targets Shared platform baseline
A project's guides Browse the projects below
Build and release conventions Builds and releases
The website and backend Web hub documentation
Documentation contribution guidance Maintaining the documentation

Projects

Choose a project to open its technical documentation and source repository link.

Crafting and professions

Project What it does
AdvancedCrafting TF-Minecraft crafting stations, alloys, ingredient conversion and lifecycle APIs
Archaeo Archaeology, hidden ruins, excavation, and fragile finds.
Cooking Interactive cooking stations and custom food crafting.
Dowsing Resource nodes, production chains, and faction-based gathering.
Gathering Hidden gathering spots, character discovery, and weighted harvest drops.
GemInfusion Gem infusion and jewellery crafting mechanics.
Research Research stations, item experiments, and hidden-recipe discovery.
Woodworking Woodworking stations, crafting projects, and material quality.

Roleplay and activities

Project What it does
ActivityTF Daily activity tasks, weekly progress, and player rewards.
BirdMessenger Bird-delivered letters and interactive mailboxes.
CompanionPets Companion pet scaffold and designs for hatching, care, training, and play.
Games Tabletop games, card games, and wagering.
GeigerCounters Geiger counter treasure hunts with proximity signals and tiered loot.
Magic Magic, resonance, artifacts, and shrines.
MusicalInstruments Playable instruments, notes, and chords for live music.
RPCharacters Roleplay characters, professions, chat channels, and player identity.
Surgery Interactive surgery, diagnosis, and patient vitals for medical roleplay.
Thievery Pickpocketing, robbery, and theft mechanics.

Trade and customisation

Project What it does
ArmourShop Custom armour and weapon cosmetics.
BarterShops Sign-based player shops and item trading with DenarEconomy integration.
DenarEconomy Currency and economy systems.
DrinkBuilder Website-integrated custom drink creation and recipe syncing.
InteractibleFurniture Interactive furniture and a shared furniture API.
MarketBlock Market trading, item categories, and demand-based pricing.
Recycler Configurable item recycling and material recovery.

World, vehicles, and combat

Project What it does
GunsAndGadgets Configurable firearms, ammunition, and gadgets.
Infestations Province infestations, ambient monsters, and lure raids.
SimpleFactions Nations, diplomacy, taxation, and ProvinceSystem map integration.
TrialRooms Keyed dungeon rooms, levelled MythicMobs encounters, and rarity-rolled loot.
VehicleFramework Configurable vehicles, movement physics, turrets, and weapons.
VFBuilders Vehicle construction stations and blueprints for VehicleFramework.
WorldBorder Configurable world borders, player warnings, and border damage.

Web and shared services

Project What it does
AACommandsFiller Configurable command trees and permission-aware tab completion.
CoreProtect TFMC-maintained CoreProtect source for block logging, rollbacks, and anti-griefing on Minecraft servers.
PermCleaner Permission inspection and cleanup with LuckPerms integration.
ProvinceSystem TFMC web hub with interactive political maps, character creation, cosmetics, and identity services.
ServerAssets Private plugin dependencies, configurations, models, and resource packs.
TFMCCore Shared gameplay systems, server utilities, and plugin integrations.
TFMCWeb Website integration, Discord account linking, and player identity services.
TLibs Shared Java utilities and integration APIs.

Archived projects

AdvancedGunpowder, AdvancedResearch, Goldsmithing, Nutrition, PointShop and BreedingBuddies are archived. The first five target the shared Java 21 / Minecraft 1.21.10 baseline on main.

Project What it does
AdvancedGunpowder Musket and gunpowder weapon mechanics.
AdvancedResearch Research stations, notes, and progression.
BreedingBuddies Animal breeding, care, ownership, and mount stats.
Goldsmithing Goldsmithing tables and jewellery crafting.
Nutrition Food groups, diet variety, and player nutrition.
PointShop Points-based shops and configurable player rewards.

Documentation

Documentation is maintained on main; this repository does not publish versioned releases. Use a commit SHA to reference an exact revision.

Technical documentation is maintained in TF-Minecraft/Docs.

This repository is public. Private source repositories and licensed binaries retain their existing access restrictions. Licenses, contribution policies, and code/API comments remain with their source projects.

License

Copyright (c) 2026 TF-Minecraft contributors.

TF-Minecraft-authored material in this repository is licensed under the Artistic License 2.0. Third-party dependencies and bundled material retain their own licenses.

About

Technical documentation for TFMC projects: setup, architecture, configuration, integrations, testing, and operations.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages