Skip to content
Alikuxac Docs

About This Documentation Portal

This site hosts documentation for my Minecraft mods and open-source tools. Builds pull markdown and assets directly from each project’s Git repository.

Why This Site Exists

Section titled “Why This Site Exists”

Documenting Minecraft mods across releases presents a few specific problems:

  1. Version branches: Each Minecraft version lives on its own branch (1.20.1, 1.21.1), often with breaking config and API changes.
  2. Tag pinning: Features shift between mod releases. Pinning docs to release tags ensures guides match the version players actually install.
  3. Asset locality: Screenshots and config samples stay in the source repository alongside the code, rather than on external image hosts.

How It Works

Section titled “How It Works”

The ingestion script (scripts/sync-docs.ts) runs before each Astro build:

  • Sparse checkout: Queries remote branches and tags, checking out only configured docs/ directories without downloading Java sources, build tools, or jars.
  • Branch and tag discovery: Resolves the latest release tag per version branch (e.g., v0.2.0+1.21.1) and attaches badges to sidebar links.
  • Asset extraction and link rewriting: Moves relative image paths into the public directory and points non-doc code references to their GitHub URLs.
  • Dynamic sidebar: Generates Starlight navigation groups from active repositories and version branches.

Multi-Loader Documentation

Section titled “Multi-Loader Documentation”

Most mods here use a multi-loader structure per version branch (common/, neoforge/, forge/, fabric/).

Tabs synchronized with syncKey="modloader" persist the selected loader across pages:

  • Configuration Path: config/machinemetrics-client.toml
  • Mod Dependencies: NeoForge 21.1+
  • Compatibilities: Create (NeoForge), Mekanism (NeoForge)

Documented Projects

Section titled “Documented Projects”
  • Machine Metrics: In-game HUD and telemetry inspector for FE/t energy transfer, fluid tanks, Create kinetic networks, and Mekanism gases.
  • Human Nature: Body-part damage tracking, injury severity tiers, and medical treatment mechanics for Minecraft 1.21.1.