From d03c6a18c170c8bd8ab9567943347a854584c741 Mon Sep 17 00:00:00 2001
From: SirEdvin <me@siredvin.site>
Date: Wed, 22 Jul 2026 19:19:08 +0000
Subject: [PATCH] docs: expand repository guidance

---
 AGENTS.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 63 insertions(+), 7 deletions(-)

diff --git a/AGENTS.md b/AGENTS.md
index f1b39dd..92a0eb7 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,17 +1,73 @@
-# Repository Guidelines
+# Digital Items
+
+## Overview
+
+Digital Items is a Minecraft 1.20.1 mod that adds digital item storage peripherals for CC:Tweaked. It supports both Fabric and Forge from a shared core module.
+
+## Tech Stack
+
+- Runtime: Minecraft 1.20.1 / Java 17
+- Languages: Kotlin 2.0, Java, TypeScript, and Lua
+- Loaders: Fabric Loader 0.15 and Forge 47
+- Computer mod: CC:Tweaked 1.113
+- Testing: Testiarium GameTests and TypeScript-to-Lua fixtures
+- Build system: Gradle Wrapper
+
+## Key Commands
+
+Log handling is important. Always use an explicit timeout and silently save complete output.
+
+- Build: `mkdir -p build; LOG="build/gradle-$(date +%Y%m%d-%H%M%S).log"; timeout --foreground 10m ./gradlew build --no-daemon >"$LOG" 2>&1`
+- GameTests: `mkdir -p build; LOG="build/gametests-$(date +%Y%m%d-%H%M%S).log"; timeout --foreground 20m xvfb-run -a ./gradlew gameTest --no-daemon -PminimalTestEnvironment >"$LOG" 2>&1`
+- TypeScript fixtures: `mkdir -p build; LOG="build/typescript-tests-$(date +%Y%m%d-%H%M%S).log"; timeout --foreground 5m ./gradlew :typescript-tests:compileTestLua --no-daemon >"$LOG" 2>&1`
+
+Increase timeouts only when required. Stop development clients and servers after collecting results. Report the command, exit code, duration, log path, and relevant errors; inspect only the relevant failure window.
 
 ## Project Structure
 
-DigitalItems is a Gradle multi-project repository. Subprojects live under `projects/`:
+```text
+projects/
+  core/                               # Shared implementation, resources, and GameTests
+  fabric/                             # Fabric integration and test mod
+  forge/                              # Forge integration and test mod
+  typed-peripheral-digitalitems/      # Publishable TypeScriptToLua peripheral API
+  typescript-tests/                   # TypeScript sources compiled to ComputerCraft Lua fixtures
+gradle/                                # Version catalog and Gradle configuration
+```
 
-- `core`: loader-independent Minecraft mod code and shared test-mod sources.
-- `forge`: Forge implementation, generated resources, and Forge GameTests.
-- `fabric`: Fabric implementation, generated resources, and Fabric GameTests.
-- `typed-peripheral-digitalitems`: publishable TypeScriptToLua peripheral API package.
-- `typescript-tests`: TypeScript GameTest programs compiled to Lua and included in the shared test mod.
+Production code lives in `src/main/`. Shared GameTests and fixtures live in `projects/core/src/testMod/`; loader test-mod entry points and metadata live in each loader's `src/testMod/`.
 
 The TypeScript tests consume `typed-peripheral-digitalitems` through a local npm file dependency. Gradle compiles the package before installing the test project's npm dependencies.
 
 ## Contribution Workflow
 
 Every new task must be implemented on a dedicated branch and submitted as a GitHub pull request. Do not commit task changes directly to the base branch.
+
+## Conventions
+
+- Keep loader-independent behavior in `projects/core/`.
+- Keep loader API usage in the corresponding `fabric` or `forge` module.
+- Follow the official Kotlin code style configured in `gradle.properties`.
+- Reuse existing project patterns before adding helpers, abstractions, or dependencies.
+- Comments explain why, not what.
+
+## DO NOT MODIFY
+
+- Never edit generated build output; change its source and rerun the relevant Gradle task.
+- Never commit `build/`, development run directories, logs, EULA files, or `node_modules/`.
+- Do not modify unrelated user changes in a dirty worktree.
+
+## Testing Approach
+
+- Run `:typescript-tests:compileTestLua` after changing TypeScript fixtures or the typed peripheral package.
+- Run the root `gameTest` task for both Fabric and Forge GameTests, using `xvfb-run` for graphics-dependent Minecraft startup.
+- Run the timed multi-loader build before marking code changes complete.
+- Fix failing tests rather than skipping them.
+
+## Code Style
+
+- Prefer the smallest correct change.
+- Do not add speculative abstractions or dependencies.
+- Keep shared and loader-specific responsibilities separated.
+- Preserve validation, error handling, and dedicated-server safety.
+- If requirements are unclear, ask instead of assuming.