Skip to content

Commit 40503e0

Browse files
Add AGENTS.md with Cursor Cloud development instructions
Co-authored-by: Dominic Seung <dominic@seung.dev>
1 parent 7b4147d commit 40503e0

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# BetterHUD - Agent Instructions
2+
3+
## Cursor Cloud specific instructions
4+
5+
### Project overview
6+
7+
BetterHUD is a client-side Minecraft Fabric mod that adds a customizable HUD overlay. It is a single-module Gradle project (not a monorepo) with no external services, databases, or backends.
8+
9+
### Prerequisites
10+
11+
- **JDK 25** is required (`sourceCompatibility = JavaVersion.VERSION_25` in `build.gradle`). The update script installs `openjdk-25-jdk` via apt.
12+
- Set `JAVA_HOME=/usr/lib/jvm/java-25-openjdk-amd64` before running Gradle commands.
13+
14+
### Common commands
15+
16+
| Task | Command |
17+
|---|---|
18+
| Build | `JAVA_HOME=/usr/lib/jvm/java-25-openjdk-amd64 ./gradlew build` |
19+
| Check (lint + tests) | `JAVA_HOME=/usr/lib/jvm/java-25-openjdk-amd64 ./gradlew check` |
20+
| Run Minecraft client | `JAVA_HOME=/usr/lib/jvm/java-25-openjdk-amd64 ./gradlew runClient` |
21+
| Clean | `JAVA_HOME=/usr/lib/jvm/java-25-openjdk-amd64 ./gradlew clean` |
22+
23+
### Caveats
24+
25+
- There are no test sources in this project (`test NO-SOURCE`); `./gradlew check` still runs `validateAccessWidener` and compilation checks.
26+
- `./gradlew runClient` launches a full Minecraft client with the mod loaded. On a headless VM it will produce ALSA audio errors (harmless) and requires a display server (Xvfb or similar) to render.
27+
- The first Gradle invocation downloads Minecraft JARs, mappings, and dependencies (~30s). Subsequent builds are cached and fast (~1-2s).
28+
- Build output JAR is at `build/libs/betterhud-<version>.jar`.
29+
- Gradle wrapper (`./gradlew`) auto-downloads Gradle 9.4.1; no manual Gradle install needed.

0 commit comments

Comments
 (0)