Files
Anvil/README.md
T
JonKazama-Hellion d8efc213e3 chore: add pre-push preflight + setup-hooks
Four-block pre-push gate matching the HellionChat pattern:

- Block A (verify-version-consistency.sh): csproj <Version> vs
  repo.json AssemblyVersion / TestingAssemblyVersion / DownloadLink*
  tag presence. Tolerant of repo.json being absent so v0.1.0 (which
  has no public release manifest yet) does not fail at push time;
  the missing-file path turns into the full cross-check once repo.json
  lands.
- Block B: dotnet build Anvil.sln -p:Platform=x64 -c Release. Platform
  pin is forge-wide (Forgeimizer v0.1.0 lesson: solution build defaults
  drift to AnyCPU otherwise).
- Block C: dotnet csharpier check ./Anvil. Catches the accumulated
  formatter drift that hit HellionChat v1.5.6 (12 files) when only
  build was checked per task.
- Block D: markdownlint-cli2 over the repo's *.md files (excludes node_modules,
  bin, obj, .claude, CLAUDE.md).

Plus setup-hooks.sh as the one-shot installer that points
core.hooksPath at .githooks/ and chmods the scripts.

README.md: MD040 fix for the custom-repo URL fence (added text language tag).
2026-05-27 22:25:35 +02:00

56 lines
2.0 KiB
Markdown

# Anvil
An independent Hellion Forge plugin for FINAL FANTASY XIV crafting.
Anvil is a privacy-focused, zero-telemetry crafting helper for Dalamud
(API level 15+). It provides a crafting simulator, a solver wrapper,
recipe bookmarks, and an opt-in Auto-Craft hook.
> Status: **v0.1.0 — early development.** The crafting simulator, solver
> wrapper, macro engine, hooks, IPC provider, bookmark store, and UI
> layers are being built module-by-module under the Anvil clean-room
> pipeline. The Recipe Data layer (module 01) is the first ground-up
> piece.
## Features (planned)
- Crafting Simulator — state machine for FFXIV crafting steps, conditions,
buffs, and actions, with full Cosmic Exploration schema support.
- Solver Wrapper — bridge to the Raphael Rust solver (bundled binary).
- Recipe Note Overlay — anchors next to FFXIV's recipe-note addon.
- Synth Helper Overlay — live next-action hint during synthesis.
- Macro Editor — compose, replay, export to FFXIV macros and MacroMate.
- Recipe Bookmarks — local list with notes, tags, and quick-open.
- Auto-Craft (opt-in) — `UseAction` hook with explicit warning modal.
- IPC Provider — exposes theme, macros, and crafting status to other
Hellion Forge plugins.
- Bilingual EN/DE UI with Hellion Anvil-Boutique styling
(Forge-Bronze on dark surface).
## Privacy
Zero telemetry. No network calls. Everything stays on your machine. See
[PRIVACY.md](PRIVACY.md) for the full statement.
## Attribution
Anvil is a clean-room re-implementation, not a fork. The plugin is
inspired by [Craftimizer](https://github.com/WorkingRobot/Craftimizer)
by Asriel Camora (MIT) — see [NOTICE.md](NOTICE.md) for the goodwill
attribution.
## License
[MIT](LICENSE) — Copyright (c) 2026 Hellion Online Media.
## Install
The custom Dalamud repository URL for Anvil is:
```text
https://gitea.hellion-forge.cloud/JonKazama-Hellion/Anvil/raw/branch/main/repo.json
```
Add this URL under Dalamud → Settings → Experimental → Custom Plugin
Repositories, then install **Anvil** from the plugin installer.