pulse

1# Development Guide
2 
3## Prerequisites
4 
5- **Java 25** (JDK 25+)
6- **Git**
7 
8## Setup
9 
10```bash
11git clone https://github.com/bitzCognautic/Pulse.git
12cd Pulse
13```
14 
15Open in IntelliJ IDEA. The Gradle import handles dependencies.
16 
17## Build Commands
18 
19| Command | Description |
20|---|---|
21| `./gradlew build` | Full build |
22| `./gradlew runClient` | Launch Minecraft with the mod |
23| `./gradlew clean` | Clean build outputs |
24 
25Testing and CI are run via GitHub Actions (`build.yml`).
26 
27## Project Layout
28 
29- `Pulse.java` — `ModInitializer`, wires singletons
30- `PulseClient.java` — `ClientModInitializer`, applies optimizations per tick
31- `performance/` — frametime tracking, rolling statistics
32- `pressure/` — weighted normalisation → pressure score
33- `adaptive/` — stage mapping and recovery timing
34- `modules/` — 9 module stubs (none wired yet)
35- `config/` — ModMenu GUI + JSON persistence
36- `overlay/` — debug HUD
37- `compat/` — mod scanner
38 
39## Adding a New Optimization
40 
411. Implement the change in `PulseClient.applyOptimizations()` (if using Options API).
422. Or, wire into a Fabric event (`LevelRenderEvents`, etc.).
433. Add toggles in `ConfigManager.buildScreen()` if user-controllable.
444. Update `README.md` and `ARCHITECTURE.md`.
45 
46## Notes on the Current Minecraft Version
47 
48The rendering system was rewritten (two-phase extraction + submit nodes):
49- `WorldRenderEvents` was removed; use `LevelRenderEvents` / `LevelExtractionEvents`.
50- `GraphicsStatus` / `graphicsMode()` were removed.
51- Old mixin targets (`EntityRenderDispatcher.render`, `ParticleEngine.particles`, etc.) were renamed or restructured.
52- See `gradle.properties` for the exact Minecraft/Fabric API versions this project targets.
53