Using and operating TDLibrary
Mod version shipped with FlammiCraft: 0.76.0
From TDLibrary 0.60.0, compatible economy providers expose exact cent amounts and the configured currency for title purchases.
TDLibrary supports dependent TD mods and provides their shared message inbox. This handbook follows the source and existing documentation; installed-pack and runtime acceptance remain separate.
Requirements and upgrade (0.51.0)
LDLib2 2.2.37 or newer is required on both sides. Shared animation, model and navigation APIs are supplied by TDLibrary; content registrations and saved IDs remain with their mods. The Almanac, Deeper and Darker and Soul Elytra repairs are removed. Sources can register a display name without changing notification IDs, archive records or preferences. The shared MariaDB driver does not change consumer credentials or tables.
Open and use Messages
From 0.48.0, dependent mods can identify their current tab with a gold inset outline. The shared LDLib2 button exposes a selection state independent of hover, keyboard focus and activation. Consumers explicitly set the selection; labels, callbacks and stored data are unchanged. Rendering still needs manual client acceptance after installation.
Install the library on each side running a dependent mod. A server-only consumer does not by itself require a client installation; UI consumers retain their own requirements.
Open Messages with /tdnotify, an assigned TD Notify key, or the optional FTB Library sidebar button. Economy and Groups screens can open it with an area already selected.
The complete Messages interface requires LDLib2 2.2.37 or newer on the client. All four views use LDLib2 controls and the shared TD menu backdrop. Use Tab/Shift+Tab to select controls, Enter/Space to activate buttons, and Escape to return. Lists support the mouse wheel; details and local messages also have Scroll up/down buttons and Page Up/Down. Refresh remains available in every inbox tab. Local messages is a separate button. Search applies with Search or Enter; idle refreshes do not submit an unfinished search.
Mark all seen covers all accessible messages that existed when the view loaded, including other pages and areas. Open problems stay open.
- Choose Current for open tasks and explicitly unverified states, New for unseen relevant information, or History for the accessible archive.
- Select an area and search titles, bodies, item names or shop names.
- Open the detail and inspect its current status. The source rechecks state and permissions.
- Use a source action to address the underlying condition. Reading or marking a message seen does not resolve it.
Idle views refresh every five seconds. Quiet collects messages, Standard allows important pop-ups, and Detailed also allows routine pop-ups. Category preferences override source preferences, which override the all-mod default. Required direct action feedback remains visible.
Loading, empty results and archive errors have separate messages. Use Refresh after an archive error or expired detail. Settings load automatically for the selected area; use Reload settings after a load error, and Save settings to apply edits. Wait for the save confirmation. Builds and source checks do not replace manual client UI acceptance after installation.
Operate the pack-version gate
Dedicated servers can enable requirePackVersion in tdlibrary-server.toml; a world-local server config overrides the global file. Each side supplies its own config/fancymenu/pack_version.txt. The trimmed label is compared exactly, including case. FancyMenu itself is not required on the server.
Permission-level-2 operators can use /tdlibrary packversion reload for subsequent joins. The enable and disable variants change runtime state until restart without saving configuration. Connected players and checks already in progress retain their existing state. Invalid reload input leaves the previous requirement active. The gate is disabled in singleplayer.
This checks a version label, not pack integrity. Follow the actual launcher update and restart procedure when a mismatch appears.
Multiplayer login
From TDLibrary 0.64.0, the client shows Minecraft's standard authentication service message when Mojang's session service returns an HTML error page during a server join. Try joining again once the service can verify your session.
Startup login gate
From 0.62.0, TDLibrary keeps the gate state in tdlibrary-startup-gate.json in the dedicated server root. The server console and RCON can close it with tdlibrary startupgate on, check it with status and immediately open it with off. TDLibrary checks the gate at the first login packet and again before players enter the world. Operators receive the same startup message as other players. Connected players remain online.
MCRestartTool 1.9.0 opens the gate after two confirmed list responses at least 15 seconds apart. The console command works while the tool is down. A missing state file means open. An unreadable or invalid file keeps the gate closed until tdlibrary startupgate off successfully saves the state.
The Restart Tool's one-time exception applies to the intended Java process. TDLibrary consumes it before the first login. A later direct launch reads the closed state from disk.
Any player can use /neustartinfo to display the effective next restart or see that the server is shutting down. It reads mcrestart-schedule.json from the server root and reports unavailable if the data is more than 45 seconds old. The gate preserves whitelist entries, operator permissions and bans. It applies to dedicated servers.
Sleeping block entities
From 0.58.0, supporting mods can remove idle block entities from the server's tick list completely. The owning mod registers them again as soon as work arrives, for example through inventory, neighbor or structure changes. After a chunk reload every block entity ticks again and decides anew. Clients are unaffected. Vanilla signs and hanging signs sleep on their own while nobody is editing them. With Lootr, its loot containers also sleep while neither decay nor refresh is configured; enabling either in Lootr's config or through a datapack wakes them within 30 seconds or on reload.
blockEntitySleep in tdlibrary-server.toml is enabled by default. Disabling it and reloading the config wakes every sleeping block entity. Permission-level-2 operators can use /tdlibrary sleep for current sleepers by type and counters since server start, and /tdlibrary sleep wakeall to wake them once. From 0.60.0, mods can also put a block entity to sleep for a fixed number of ticks: it wakes after that time at the latest and immediately when work arrives. /tdlibrary sleep additionally shows the pending timed wakes.
Natural spawner mob count
From 0.60.0, the natural spawner no longer recounts all loaded mobs on every tick. It reuses the count for spawnStateReuseTicks ticks (default 4, range 1–20, in tdlibrary-server.toml). Newly spawned mobs are added right away, so no mob cap is exceeded. Mobs that died or despawned drop out at the next count, which can delay spawns by at most that many ticks. 1 restores vanilla behavior.
Optional Simple Tomb compatibility
From TDLibrary 0.63.0, regular autosaves compress and write grave files from the original Simple Tomb 1.4.4 on the NeoForge IO worker. Loading or synchronously saving a .mctomb file waits for pending writes to that file. File names and the NBT format stay compatible, so existing graves carry over directly.
Optional Homestyled compatibility
From 0.61.0, TDLibrary speeds up startup with Homestyled 1.10.48 for NeoForge 1.21.1. Furniture retains its collision and selection geometry. The fix applies automatically on the next client or server startup when this Homestyled version is present.
With Homestyled 1.10.73 for NeoForge 1.21.1, placing the Flower Arch with TDLibrary 0.76.0 makes it three blocks wide and three blocks high. Break and place an existing arch again to use the new size with the same item. On multiplayer servers, the server and players need the same version of the compatibility patch.
Optional MoreCulling and LDLib compatibility
From 0.51.0, the client indexes model variants while loading large block-state definitions. Minecraft still validates variants and processes models, overlap errors and resource-pack priority. The index is released after each load; small or externally filtered state lists keep the original scan. ModernFix Dynamic Resources and existing Xaero map sharing can remain enabled. No new setting or change to maps or worlds is needed. Resolving specific gameplay hitches still requires a separate measurement after manual installation in the affected pack.
From TDLibrary 0.49.0, these adapters check the required APIs and behavior at startup instead of exact versions or class hashes. Compatible mod updates need no manual JAR adjustment. MoreCulling 1.0.10 or newer uses lazy per-state caches with ModernFix 5.27.26 or newer's dynamic resources when cache APIs, Mixin targets and both cache-only reload callbacks match. Incompatible structures retain their original behavior with a warning.
Exact AE2 internal inventories are compared through LDLib's mark strategy registry with the existing slot and pattern snapshots. Direct item NBT and encoded pattern edits stay visible, and subclasses keep full serialization. Other values still use LDLib's own inventory marks. Returned NBT comparison marks are detached when the required method signatures are available, so reused mutable tags cannot hide later changes. No tick-time change has been measured. Only the obsolete required NeoECOAE list redirect is suppressed when its sole effect targets a list call no longer present in native LDLib. Optional redirects such as NeoECOAE 21.46.0's retain their own behavior. Native registration, removal, executor release, packet and persisted formats stay unchanged.
TDLibrary bundles MixinSquared as a game library; no separate installation is needed. Installed mod JARs and saved world data are not changed. Automated integration tests do not replace manual modpack acceptance.
Computations and notification storage
From 0.68.0, server clusters share retained messages, read state and presentation settings. Messages remain in the player's inbox when a live hint misses a backend transfer. The reference describes the upgrade and optional world routing.
From 0.53.0 the server runs random ticks through a list of the blocks and fluids in each chunk section that can actually tick. Every such block keeps exactly the vanilla chance per roll and randomTickSpeed keeps its meaning; rolls on stone, air or water no longer read the section. The list follows every block change, is built gradually after loading and is checked again about every five minutes. Start the server with -Dtdlibrary.vanillaRandomTicks=true to keep the vanilla loop. Measure the tick-time saving with a new server profile after installing it manually.
Operators use /tdlibrary compute to inspect shared computation consumers. Worker and application budgets belong in tdlibrary-common.toml. Worker/capacity changes take effect after server restart; extra workers also compete with Minecraft for CPU time.
From 0.65.0 the private tdlibrary-database.toml holds the one MariaDB connection of all TD mods. With enabled = true the notification archive, TDEconomy, TDGroupe and TDUtilities keep their dedicated-server data there, each in its own tables; the first start imports their world data. Missing databases and tables are created automatically. Single-player worlds keep world storage. Important events remain in the durable world-local outbox during outages. Local client session messages do not become server archive entries. From 0.67.0 TDLibrary also records each player's names with the time they were first seen in td_player_name; operators read them with /tdlibrary names [name|uuid], in a screen with a searchable player list, last logins, histories and copy to clipboard, or in chat from the console. See the reference.
Shared connections: From 0.74.0 the TD mods no longer open database connections of their own; they borrow them from a shared TDLibrary pool. Each mod has its own small share, so one slow mod cannot block the others. max_connections under [database] (default 24, 4 to 200) limits all open connections of one server together and takes effect after a restart. MariaDB's max_connections must exceed this value times the number of servers that use the database. The pool closes connections unused for a minute and replaces every connection after ten minutes at most. A transaction that waits for a row another server holds locked now ends after a few seconds with a clean error and runs again instead of losing its connection; previously one stalled server caused "lost its database connection" on all others. Cluster leader election reads the leader without a lock first and only locks when a backend may take over or renew a task. Mods from this release require TDLibrary 0.74.0.
From 0.62.0 several dedicated servers that share one MariaDB database can form a backend cluster: set enabled = true under [database] and [cluster] in tdlibrary-database.toml on every backend and give each backend a unique id in cluster-node.toml in its server folder. TD mods then see players on all backends, send messages between them and run cluster-wide tasks on exactly one backend. Operators check the state with /tdlibrary cluster. The reference describes all settings.
For unavailable history inspect operator logs and connection/schema status. Preserve outbox and quarantine contents. For unresolved messages inspect the source condition rather than repeatedly marking them read. The reference covers TLS modes, version limits, optional compatibility patches and recovery boundaries.
Player names use the latest recorded observation. An empty name history supplies no name.
Player identity and time
Player UUIDs identify records across backends. TDLibrary distinguishes the earliest observed login, latest login and currently reachable backend. An unknown UUID has no stored name or historical join date. TDGroupe tracks active title time, TDLeaderBoard tracks vanilla play time and TDUtilities records session and AFK intervals.