Skip to content

AGENTS.md

Latest commit

 

History

History
81 lines (52 loc) · 2.71 KB

AGENTS.md

File metadata and controls

81 lines (52 loc) · 2.71 KB
Raw

μ-text Agent Notes

Project

Static Jekyll prototype for the μ-text narrative troubleshooting simulator.

Toolchain

  • Jekyll runs from the vendored bundle path.
  • Tailwind is built with the local npm dependency.
  • No backend, authentication, persistence, payments, ranking, or real puzzle solver should be added in this prototype phase.

Commands

Use the vendored Ruby executables and gem home first:

export GEM_HOME="vendor/bundle/ruby/3.4.0"
export GEM_PATH="vendor/bundle/ruby/3.4.0"
export PATH="vendor/bundle/ruby/3.4.0/bin:$PATH"

Serve locally (for development):

npm run serve

The default local URL is:

http://127.0.0.1:4000/

Production build (for GitHub Pages only):

npm run build

baseurl caveat

_config.yml has baseurl: "/mutext" for the GitHub Pages deploy at https://dhilst.github.io/mutext/. The npm run serve command overrides this with --baseurl '' so assets resolve correctly on localhost.

Do NOT run npm run build while npm run serve is running. It overwrites _site/ with production paths (/mutext/...) and breaks the local server. If you need to rebuild Tailwind while serving, restart the serve command instead.

Important Files

  • _config.yml configures Jekyll and no-theme output.
  • _layouts/default.html contains the global shell UI.
  • _includes/ contains reusable static UI components.
  • index.md is the landing console.
  • _posts/ is the location for post content and puzzle content. Keep posts and puzzles there.
  • _posts/2026-05-15-tutorial.md is the tutorial incident screen. Jekyll publishes it at /puzzles/001-tutorial.html.
  • _lore/ contains static lore collection pages.
  • assets/css/main.css is the Tailwind input file.
  • assets/css/site.css is the compiled stylesheet.
  • assets/js/main.js contains vanilla JS placeholder interactions.

Design Direction

Keep the interface close to internal corporate tooling, retro terminal systems, incident dashboards, and restrained cyberpunk engineering environments. Favor clear dense UI, subtle motion, dark terminal colors, dry incident copy, and atmospheric story presentation.

Narrative Boundary

DO NOT BREAK THE NARRATIVE INSIDE THE GAME.

Visible game UI must stay in-world. Do not put implementation notes, design guidance, style instructions, or meta-language such as "the UI should feel..." into pages, panels, tooltips, logs, chat, lore, or any other user-facing game content. Keep that guidance in AGENTS.md, code comments when truly necessary, issues, or development docs only.

Puzzle Structure

Check docs/puzzle-spec.md

Characters

Check docs/characters.md

Git

Do not add Co-Authored-By lines to commits. Always use --no-gpg-sign when committing.