Matt
25107efcf1
New companion-mod design doc covering: Architecture - Purpose & scope (what's in the mod vs what stays in KubeJS) - High-level diagram showing client/server/KubeJS/FTB-stack roles - Full Java package layout under uk.sijbers.bnstoolkit - Six GUI screens specified individually with layouts + network calls (Quest Log, Bounty Board, Tier Upgrade, Plot Purchase, Shop Browser, Quest Progress HUD) - Three mixin targets into FTB Chunks' ChunkScreenPanel (drawBackground, ChunkButton.addMouseOverText, ChunkButton.onClicked) -- no FTB fork - Network packet contract (7 S2C + 5 C2S packets, versioned) - Data persistence model (SavedData for plots + sethomes, in-memory for death locations, KubeJS for quest state) - Two config files documented (tiers.json + plots.json) with example JSON5 schemas - KubeJS integration surface (8 /bnstoolkit_internal commands) - Build & release setup (separate Gitea repo, standard NeoForge ModDevGradle, semver) - 6 mod implementation phases (M0-M6), each independently shippable Detailed perk specifications - Wilderness chunks: FTB Ranks permission node, native FTB Chunks enforcement, no mod-side work - Plot slots: SavedData-backed ownership tracking, 50% refund on release - Sethomes: full sethome system built in bnstoolkit (no other sethome mod exists in pack). Per-tier cap, 30s cooldown, /sethome /home /delhome /listhomes commands - Daily bounty slots: enforced in KubeJS engine, UI greys Accept when at cap - Shop fee discount: base 25% Bazaar fee reduced by tier discount. Only applies to NPC Bazaar shop, not player-to-player Numismatics. Worked example showing -25% Sovereign = 0% fee = full 10 spurs/diamond - Chat colour: full colour ladder per tier (grey to rainbow at Sovereign with character-by-character cycling) - Join broadcast: 6 levels documented (none, simple, fancy, epic, epic+particles, epic+spectacular) with example ASCII - /back after death: in-memory storage, 60s cooldown, dimension-aware - Future perk dimensions: 7 candidates the schema supports without code changes (particle trails, custom join sounds, custom title prefix, priority bounty access, tier-gated vendors, daily login bonus, keep-inventory chance) Six open implementation questions flagged for resolution during build, none blocking. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Brass & Sigil
Self-hosted Minecraft modpack distribution + administration system. Three components, one repo:
brass-and-sigil/
├── launcher/ ← Avalonia desktop client (Windows .NET 8)
│ Auths with Microsoft, syncs the modpack, launches the game.
├── server/ ← brass-sigil-server daemon (Linux .NET 8)
│ Wraps the MC subprocess, exposes the admin web panel,
│ syncs mods, runs backups + BlueMap, handles whitelist.
├── pack/ ← Modpack content
│ ├── pack.lock.json Source of truth for mod versions / URLs / hashes
│ ├── tweaks/ Hand-written data-only tweak source
│ └── overrides/ Build output / hand-placed local files (gitignored)
├── scripts/ ← Build + deploy entry points (run from repo root)
│ ├── Update-Pack.ps1 Refresh pack.lock.json from Modrinth/CurseForge
│ ├── Check-Updates.ps1 Non-mutating "what's new?" report
│ ├── Build-Tweaks.ps1 Compile tweaks/ into pack/overrides/mods/*.jar
│ ├── Build-Pack.ps1 Generate manifest.json from the lockfile
│ └── Deploy-Brass.ps1 One-shot build + deploy everything
└── docs/ ← Operational notes, deploy runbook, schema docs
Quick start
# Pull dependencies, copy and edit the deploy profile
git clone <remote> brass-and-sigil
cd brass-and-sigil
Copy-Item scripts\deploy.config.template.ps1 scripts\deploy.config.ps1
notepad scripts\deploy.config.ps1 # fill in deploy share, SSH host, etc.
# Build + deploy everything in one go
.\scripts\Deploy-Brass.ps1
deploy.config.ps1 is gitignored -- local values never get committed.
Component reference
| Component | What it does | Technology |
|---|---|---|
launcher/ |
Friend-distributed client. Auths with Microsoft via WebView2 + XboxAuthNet, downloads mods, launches Minecraft. Single self-contained .exe published from publish/. |
Avalonia 12 + CmlLib.Core |
server/ |
Daemon running alongside the MC process on Linux. Hosts a Kestrel web panel for admin (cookie-auth, rate-limited), bridges RCON, runs scheduled backups + BlueMap renders, handles whitelist requests. | ASP.NET Core minimal APIs |
pack/ |
Lockfile-driven modpack content. pack.lock.json resolves mod slug → URL+SHA-1; Build-Pack.ps1 walks it and produces manifest.json for the launcher and the server-tool to consume. |
PowerShell tooling |
Workflow
- Bump mod versions:
.\scripts\Update-Pack.ps1(queries Modrinth + manual CurseForge entries). - Sanity-check:
.\scripts\Check-Updates.ps1for a non-mutating availability report. - Edit tweaks under
pack/tweaks/<name>/if you're changing recipes / loot / etc. - Deploy:
.\scripts\Deploy-Brass.ps1-- builds launcher + server, regenerates manifest, mirrors everything to the deploy share, scp's the server binary.
Secrets / config files
| File | Tracked? | Notes |
|---|---|---|
launcher/launcher-config.template.json |
✓ | Empty placeholders, public-safe |
launcher/launcher-config.json |
✗ | Local override; merged into the published exe at build time if present |
server/deploy/server-config.example.json |
✓ | Template; rename to server-config.json on the server with real values |
server/deploy/server-config.json |
✗ | Production config; lives on the server only |
scripts/deploy.config.ps1 |
✗ | Local deploy profile (paths, SSH host, share location) |
License
See LICENSE.