Skip to content

README.md

Latest commit

 

History

History
128 lines (108 loc) · 6.52 KB

README.md

File metadata and controls

128 lines (108 loc) · 6.52 KB
Raw

Icon export

Builds a game data bundle (item icons, the icon lookup, the item catalog, the ore dictionary, item info and GregTech's recipes) from a GTNH client pack. CI runs it for every GTNH release and publishes the result (see Game data), so you only need it for a pack CI doesn't cover (a nightly, a modified pack), or to build the data yourself.

run.sh starts the GTNH client headlessly in Docker (Xvfb, software rendering, no Minecraft account), renders every item and fluid, and writes the same bundle CI publishes. It takes about 20 minutes for 2.9.0 (most of it capturing its ~9,000 animated icons; GCM_ANIMATION_TICKS=0 skips that, for about 3 minutes), plus a one-time ~250 MB download of Minecraft's libraries and assets.

Building game data

  1. Download the MultiMC/Prism client zip from https://downloads.gtnewhorizons.com/Multi_mc_downloads/ (not the server pack), or use your own pack's MultiMC export.

  2. Run:

    tools/icon-export/run.sh ~/Downloads/GT_New_Horizons_2.9.0_Java_17-25.zip --install

    Output goes to tools/icon-export/out/. --install also puts it in server/data/gamedata/<version>/ and selects it; add --data-dir DIR when the server's data directory is elsewhere (the prebuilt image's data/). The version name comes from the file name; set GCM_VERSION_LABEL to override it.

    For Faithful icons too, add --faithful with a release zip from GTNH-Faithful-Textures (--faithful ~/Downloads/GTNH-Faithful-x32.v2.2.0.zip). The game is launched a second time with the pack on, which doubles the time. --install selects the default textures; switch on the Game data page.

  3. Restart the server, or pick the version on the Game data page.

out/export-report.json lists the counts and any items that failed to render. A few hundred always do: items whose renderer needs a player or a world (the bow, Thaumcraft devices, some Botania and Chisel blocks), since the export never loads one. They fall back to by_label or show no icon.

Settings: GCM_MAX_MEMORY (default 6G), GCM_ICON_SIZE (default 64 px), GCM_ANIMATION_TICKS (default 400, i.e. up to 20 s of animation; 0 for still icons only), GCM_TIMEOUT (seconds, default 3600) and GCM_CACHE_DIR (default ~/.cache/gcm-icon-export).

Publishing from a fork

The gtnh-data.yml workflow checks GTNH's releases daily and publishes a bundle for every new stable, beta and RC release, tagged gtnh-data-<version>. A fork that runs it publishes to the repo named by DATA_REPO in the workflow. That needs a fine-grained token with Contents: read and write on that repo, stored as the GAMEDATA_TOKEN Actions secret. Point your servers at it with GAMEDATA_REPO.

Bundle format

Icons in images.zip are lossless WebP (animated WebP for animated ones), named after NESQL's scheme but ending .webp (item/<mod>/<name>~<damage>[~<nbt>].webp), and data.json says "image_format": "webp". Bundles built before WebP have PNG and APNG icons named .png and no image_format; the server reads both.

The icon lookup contains six tables:

  • by_key — modid:internalname:damage → icon, for ordinary items. When several stacks share a key (NBT variants of one item), the one without NBT.
  • by_key_label — modid:internalname:damage|label → icon, from NBT stacks only: tells those variants apart (each crop's seeds, each bee species). Tried first for items the scan reports with NBT.
  • by_key_material — modid:internalname:damage|material → icon, for GregTech tools: every material's Huge Turbine shares one id, damage and label, and only the tool's primary material in its NBT tells them apart.
  • fluids_by_key — Forge fluid registry name → icon, for fluid pseudo-items (see Fluid items).
  • aspects_by_key — Thaumcraft aspect tag (ordo) → icon, for essentia. Essentia never falls back to by_label, where an aspect's name finds blocks and items named after it. Game data without this table shows a round badge with the aspect's initial instead.
  • by_label — display name → icon. Least reliable fallback, because about 8% of labels collide across mods.

Beside the lookup, ore_dict.json holds the game's ore dictionary ({name: ["modid:internalname:damage", ...]}, damage * for any), for the crafting plan's ore-dictionary substitutes. Bundles made before it existed work without it; plans then take no substitutes.

item_info.json holds what the page shows about items beyond their name and icon:

  • tooltips, shift_tooltips, rarity, formulas: for the same keys as by_key, by_key_label and a GregTech tool's by_key_material, the item's tooltip below its name (lines joined with newlines, formatting codes like §e kept), the same with Shift held where that's different, its name's rarity colour code where it isn't common, and its chemical formula, read the way GregTech's own NEI formula search reads it (its material, or its GT++ material). Formulas and tooltips keep GregTech's font glyphs ( for ², ...), which the page maps to Unicode. The export holds Shift by patching mods' keyboard checks; Ctrl sections, and lines a mod adds only with a player in the world, aren't in it.
  • fluids: each fluid's temperature in kelvin, whether it's a gas, and its formula: that of a container (a cell) filled with it.
  • mods: each mod's name by its id.

Bundles made before it existed have none of it. Before it, ore_dict.json also left out names only one item has.

recipes.json.gz holds GregTech's recipe maps, for the pattern check: about 175,000 recipes in 138 maps for GTNH 2.9, about 2 MB gzipped. items and fluids are tables of keys (modid:internalname:damage, damage * for any; fluid registry names) with their display names in item_names and fluid_names. Each map has its machines (what NEI lists as its catalysts, by name, which is how a pattern's provider is matched to it) and its recipes: {"i": [[item, n]], "f": [[fluid, mB]], "o": [[item, n, chance?]], "g": [[fluid, mB]], "e": EU/t, "d": ticks, "s": special value}, indices into the tables, n 0 for an input that isn't used up, chance in 1/10000 only below 100%. Fake (NEI-only) and disabled recipes are left out. Bundles made before it existed can't be compared.

Credits

The headless client launch follows gtnh-factory-flow (MIT).