Initial Minecraft Renew Mod workspace
This commit is contained in:
62
AGENTS.md
Normal file
62
AGENTS.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Agent Instructions
|
||||
|
||||
## Project
|
||||
|
||||
Minecraft Renew Mod is a local workspace for Minecraft mod porting and prototyping.
|
||||
|
||||
The active project is `create-limited-draining/`, a NeoForge port of Create: Limited Draining for Minecraft 1.21.1 and Create 6.0.10.
|
||||
|
||||
## 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.
|
||||
- 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
|
||||
|
||||
Run commands from `create-limited-draining/` unless noted otherwise.
|
||||
|
||||
```powershell
|
||||
.\gradlew build
|
||||
.\gradlew runClient
|
||||
.\gradlew runServer
|
||||
.\gradlew dependencies --configuration runtimeClasspath
|
||||
```
|
||||
|
||||
There is no separate lint or test command currently documented. Use `.\gradlew build` as the cheapest reliable verification command.
|
||||
|
||||
## Artifacts
|
||||
|
||||
Expected build output:
|
||||
|
||||
```text
|
||||
create-limited-draining/build/libs/*.jar
|
||||
```
|
||||
|
||||
Current documented artifact:
|
||||
|
||||
```text
|
||||
createlimiteddraining-1.21.1-0.3.0-port.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 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.
|
||||
Reference in New Issue
Block a user