Files
minecraft-renew-mod/AGENTS.md
ToxicCrzay270 ce2967ed40
Some checks failed
Codex Template Compliance / template-compliance (push) Failing after 5s
Release Dry Run / release-dry-run (push) Failing after 2m7s
Build / build (push) Failing after 26m35s
Scheduled Repository Cleanup Check / cleanup-check (push) Successful in 6s
Scheduled Security Scan / security-scan (push) Failing after 13s
Scheduled Dependency Check / dependency-check (push) Failing after 13s
Add Power Grid NeoForge port submodule
2026-05-27 13:48:25 +02:00

77 lines
3.1 KiB
Markdown

# Agent Instructions
## Project
Minecraft Renew Mod is a local workspace for Minecraft mod porting and prototyping.
The active projects are:
- `create-limited-draining/`, a NeoForge port of Create: Limited Draining for Minecraft 1.21.1 and Create 6.0.10.
- `power-grid/`, the official Create: Power Grid `architectury-1.21.1/dev` upstream branch tracked as a submodule for NeoForge 1.21.1 verification.
## Repository Rules
- Read this file and `.codex/project.md` before making changes.
- Preserve existing application code unless the task explicitly requires code changes.
- Keep changes scoped to the user's request.
- Do not commit secrets, `.env` files, private keys, certificates, local tokens, Minecraft run logs, generated worlds, or build outputs.
- Do not rewrite history or run destructive git commands unless explicitly requested.
- Do not create a release unless explicitly requested.
- Check repository status before editing and before finishing when this directory is a Git repository.
- Preserve unrelated user changes.
- Derive repository owner and repository name from the target remote URL or `GITHUB_REPOSITORY`. Never reuse owner/name values from `.codex-agent-repository-kit`.
- Keep `AGENTS.md` and `.codex/project.md` aligned when commands, artifact paths, or release rules change.
- If `GITEA_TOKEN` is available locally, use it only for read-only Gitea API checks. Never print, commit, or store it.
## Commands
From `create-limited-draining/`:
```powershell
.\gradlew build
.\gradlew runClient
.\gradlew runServer
.\gradlew dependencies --configuration runtimeClasspath
```
From `power-grid/`:
```powershell
.\gradlew :forge:compileJava -x :native:buildWindows -x :native:buildLinux --no-daemon
.\gradlew :forge:remapJar -x :native:buildWindows -x :native:buildLinux --no-daemon
```
There is no separate lint command currently documented. Use the project-specific build or compile command as the cheapest reliable verification command.
## Artifacts
Expected build output:
```text
create-limited-draining/build/libs/*.jar
power-grid/forge/build/libs/*.jar
```
Current documented artifact:
```text
createlimiteddraining-1.21.1-0.3.0-port.1.jar
powergrid-mc1.21.1-0.5.5.1.jar
```
## Security Notes
- Review `docs/security-review.md` before release work.
- Treat generated Minecraft run data under `create-limited-draining/run/` as local-only.
- Treat Gradle caches, logs, generated resources, and build outputs as generated files.
- Keep external dependency sources documented in `create-limited-draining/build.gradle`.
- Keep `power-grid/` aligned with the upstream submodule unless explicitly doing local patch work.
- Keep publishing credentials in Gitea repository or organization secrets, not in tracked files.
## Finish Checklist
- `git diff --check` passes when this directory is a Git repository.
- `.\gradlew build` has been run from `create-limited-draining/`, or the reason it could not run is documented.
- README, changelog, security review, and release checklist are updated when release behavior changes.
- `docs/agent-handoff.md` is updated when work is interrupted, risky, or spans multiple sessions.