Links BlockDesigner to BlockCompanion, the Minecraft mod: send your project into the game and edit builds from it.
Plus the materials a build needs as the items you'd gather in survival, what you have gathered and what is left.
BlockCompanion Plugin is a plugin for BlockDesigner, the Windows editor for Minecraft builds, and BlockDesigner's side of BlockCompanion. It was called Resource Tracker before 1.6.0; an installed copy updates to the new name by itself and keeps everything you saved. It is released on its own, separately from the app. It needs BlockDesigner 0.4.26 or later (plugin API 7).
Contents: Download · Features · Building from source · Project layout
Get the latest version from the releases page:
- Download
resource-tracker-<version>.jar. - In BlockDesigner open Plugins (puzzle icon) › Manage plugins… › Install… and pick the jar.
Newer versions of BlockDesigner install it for you on their first start, switched on. If you uninstall it, it stays uninstalled.
It is on straight away, with its own tab on the right. You can switch it off, reload or uninstall it in the same window, and it updates itself (Plugins › Manage plugins… › Update plugins automatically). Plugins run with the same access as BlockDesigner itself, so only install ones you trust.
The plugin has one tab on the right with two pages, picked by the bar at its top: Materials (the list) and BlockCompanion (the link to the game). The page you used last comes back next time, and so do where you count, the sort, Hide done and the game link's settings. Its one setting, Count mobs as their spawn eggs, is on its page in BlockDesigner's Settings window (the gear on the tab opens it).
From top to bottom:
- Count: where to count (all visible layers, the selected layers, the active layer, or the current selection), and the refresh button to count again (it also looks at the game's progress and chests again). It recounts by itself as you build.
- Items: every item the build needs, most first, with its icon and how many stacks and shulker boxes that is ("2 shulkers + 3 stacks + 12"). Filter, Hide done and sort by most left, most needed or name.
- At the bottom: a bar over the whole build ("1,234 of 5,000 items placed or gathered (24%) · 3 of 20 kinds done"), and, when the project is linked to a build in the game, how far it is there ("In game: 35% built · 9,313 blocks left") with a link to the BlockCompanion page. Then Copy list, Save CSV… and Reset… (it asks first).
The page's button shows how many kinds are left to gather.
- Gathered: type how many you have in each row: a number, stacks (
10s), shulker boxes (2sh) or a sum (1sh + 3s + 12). The tick marks an item as all gathered and the undo arrow takes that back. Each row shows what's left with a bar that fills red to green. - Saved per project: what you've gathered is kept for each project file, and comes back when you open it again.
- Copy list puts what's left on the clipboard as text ("Oak Planks: 640 (10 stacks)"); Save CSV… writes needed, gathered and left for every item as a spreadsheet. When the project is linked to the game, both include how many are placed. Plugins › Copy materials list copies it without opening the page; it and Send project to the game can be given keys in Settings › Keybinds.
- Mobs (optional, in Settings): count mobs as their spawn eggs. Paintings, item frames (and what they hold), armor stands, boats, minecarts and end crystals always count as their items.
Everything to do with the BlockCompanion mod (0.1.0 or later), from top to bottom:
- Games: every BlockCompanion game and server running on this computer, with its version, loader, what it shows and whether it is connected. The plugin connects to them by itself. A game leaves the list when it disconnects, unless you save it (the save button on its row): saved games stay, disconnected (grey), until you unsave them. Tick the games your project goes to. The refresh button looks for games again, re-reads what they report and counts again; Use its textures shows blocks with the resource packs of the game selected in the list, and its server's pack (needs BlockDesigner 0.4.24 or later).
- Send project: Send to game sends the project to the ticked games. It appears in front of you in the game; a server adds it to its shared schematics. Also in Plugins › Send project to the game. With Live on, every change you make here reaches the ticked games a moment later, so the ghosts follow your edits.
- Edit in BlockDesigner: picked on a placement in the game (BlockCompanion 0.3.0 or later), it opens that build here as your project, ticks that game and turns Live on, so the placement follows your edits. What happened shows under the status at the bottom.
- Game progress: the build in the game whose placed blocks count on the Materials page, how far it is, and how many linked chests count as gathered (below).
- BlockCompanion mod: Install mod… (below).
- At the bottom, the status: Connected to 2 games, Connecting…, Waiting for a game (or No game found), with how many are active and disconnected, and what the last install did. A dot in the same colour is on the page's button, even before you open the page.
Live, the ticks and the saved games are kept. Grab from the game: BlockCompanion's Grab from BD button asks for the open project; the plugin answers even while the panel is closed.
BlockCompanion writes how far a build is in the game to <your user folder>\.blockcompanion\progress while you build.
- Linked automatically: the Game progress picker links the project to the build in the game whose project name is the project's name (or whose schematic file name is the project file's name), ignoring case. If there are several (the project loaded more than once), the most recently updated wins. Pick another build or Not linked instead; the choice is saved for each project.
- Placed counts as done: each row on the Materials page shows how many are placed in the game, and an item with all
of it placed is done by itself. What's left is
needed − placed − gathered, so Gathered now means what you have in hand and haven't placed yet (the row's tooltip spells it out). ✓ fills in just what isn't placed. The progress bar counts placed and gathered. - Live: it looks at the folder every 2 seconds and shows "In game: 35% built · 9,313 blocks left · updated 5 s ago", or "not seen for 10 min" when the game hasn't written for 5 minutes. A file caught half-written keeps the last good numbers.
- The game counts the visible layers of the project, so its numbers line up best with Count: All visible layers.
- Without BlockCompanion, or with Not linked, everything works as before.
Chests you link in the game (sneak and right-click them with the stick) count as gathered, and each row on the Materials page says how many are in chests.
Puts the newest BlockCompanion release (the highest version on GitHub, not prereleases) into a game's mods folder (a
Paper server's plugins): the jar for its loader and Minecraft version, or for its line (the 26.2 jar for 26.2.1). Older
BlockCompanion jars there go first, found by name or by mod id; if the game holds one open it's renamed to .disabled,
else you're asked to close the game. The first choice is the game BlockDesigner takes its textures from (Settings ›
Minecraft assets): the launcher instance picked there (Prism, MultiMC, CurseForge or Modrinth), else the game folder of
the loaded resource packs, else the official launcher's .minecraft. Without an instance, the version is the one a game
reported from that folder, else the game jar's, marked with ? to check. If the loader can't be told, you're asked,
among the loaders that version has a jar for. Or pick a game from the list, or another game folder (or its mods
folder): the jar for what it runs is picked when its launcher files or mods tell. Restart the game afterwards.
The games are found through small files in <your user folder>\.blockcompanion\instances, and the connection only
listens on this computer.
The count is in the items you'd need in survival, not in blocks:
- A double slab is two slabs. Doors, beds and tall plants are one item for both halves. Waterlogging costs nothing extra.
- Candles, sea pickles, turtle eggs, snow layers, petals and leaf litter count how many there are in the block.
- Crops are their seeds (wheat → wheat seeds, carrots → carrot…). Wall torches, signs, banners, heads and coral fans are the item you place. Potted plants are a flower pot and the plant. Redstone wire is redstone dust and tripwire is string. Candle cakes are a cake and a candle.
- Water and lava sources are a bucket each; flowing water and lava, fire, portals and piston heads cost nothing.
You need Windows and a JDK 26 (Temurin 26 is what BlockDesigner uses; set org.gradle.java.home in
gradle.properties to yours). Then:
./gradlew jar # build/libs/resource-tracker-<version>.jar
The plugin compiles against the BlockDesigner plugin API jars in libs/ (from BlockDesigner 0.4.27). The app
provides them, Jackson and JavaFX at runtime, so they are never bundled into the plugin. To target a newer API, replace them
with the jars from a newer BlockDesigner build (./gradlew :plugin-api:jar :core:jar in the
BlockDesigner repository) and update the file names in build.gradle.kts.
The version is set in build.gradle.kts and copied into the jar's blockdesigner-plugin.json. To release a new
version, change it there, add a section to RELEASE_NOTES.md, build the jar and attach it to a
GitHub release tagged with the version.
For writing plugins, see BlockDesigner's plugin guide and API reference.
./gradlew test
The tests cover the plugin's logic that runs without the app, against the API jars in libs/.
| Path | What it does |
|---|---|
src/main/java |
The plugin's code: Items (blocks and entities to items), Tally (counting a scope), Gathered (saved progress and game link), GameProgress and ProgressFolder (BlockCompanion's progress files), GameInstance, GameConnection and GameLinks (the live link), ModInstaller (installing BlockCompanion), Prefs (the saved page state), TrackerSession (what both pages share: the count, the link, the look at the games every 2 seconds, the page's status dot), LinkStatus, the pages (TrackerPanel: Materials; GameLinkPanel and GameLinkPane: BlockCompanion) |
src/main/resources/blockdesigner-plugin.json |
The manifest BlockDesigner reads: id, name, version, main class, API level. The id stays resource-tracker (and the jar resource-tracker-<version>.jar) from the plugin's old name, so installed copies keep updating and keep their data |
src/test/java |
Tests |
libs/ |
The BlockDesigner plugin API jars it compiles against |