Skip to content

Commit 2cc4515

Browse files
committed
Add CLAUDE.md for project documentation and build instructions
1 parent 65e38d4 commit 2cc4515

1 file changed

Lines changed: 89 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,92 @@ All 24 locale files use **MiniMessage format** (e.g., `<red>`, `<dark_blue>`). L
8383
## CI
8484

8585
GitHub Actions workflow on `develop` branch and PRs: builds with Java 21, runs JaCoCo coverage, reports to SonarCloud.
86+
87+
## Dependency Source Lookup
88+
89+
When you need to inspect source code for a dependency (e.g., BentoBox, addons):
90+
91+
1. **Check local Maven repo first**: `~/.m2/repository/` — sources jars are named `*-sources.jar`
92+
2. **Check the workspace**: Look for sibling directories or Git submodules that may contain the dependency as a local project (e.g., `../bentoBox`, `../addon-*`)
93+
3. **Check Maven local cache for already-extracted sources** before downloading anything
94+
4. Only download a jar or fetch from the internet if the above steps yield nothing useful
95+
96+
Prefer reading `.java` source files directly from a local Git clone over decompiling or extracting a jar.
97+
98+
In general, the latest version of BentoBox should be targeted.
99+
100+
## Project Layout
101+
102+
Related projects are checked out as siblings under `~/git/`:
103+
104+
**Core:**
105+
- `bentobox/` — core BentoBox framework
106+
107+
**Game modes:**
108+
- `addon-acidisland/` — AcidIsland game mode
109+
- `addon-bskyblock/` — BSkyBlock game mode
110+
- `Boxed/` — Boxed game mode (expandable box area)
111+
- `CaveBlock/` — CaveBlock game mode
112+
- `OneBlock/` — AOneBlock game mode
113+
- `SkyGrid/` — SkyGrid game mode
114+
- `RaftMode/` — Raft survival game mode
115+
- `StrangerRealms/` — StrangerRealms game mode
116+
- `Brix/` — plot game mode
117+
- `parkour/` — Parkour game mode
118+
- `poseidon/` — Poseidon game mode
119+
- `gg/` — gg game mode
120+
121+
**Addons:**
122+
- `addon-level/` — island level calculation
123+
- `addon-challenges/` — challenges system
124+
- `addon-welcomewarpsigns/` — warp signs
125+
- `addon-limits/` — block/entity limits
126+
- `addon-invSwitcher/` / `invSwitcher/` — inventory switcher
127+
- `addon-biomes/` / `Biomes/` — biomes management
128+
- `Bank/` — island bank
129+
- `Border/` — world border for islands
130+
- `Chat/` — island chat
131+
- `CheckMeOut/` — island submission/voting
132+
- `ControlPanel/` — game mode control panel
133+
- `Converter/` — ASkyBlock to BSkyBlock converter
134+
- `DimensionalTrees/` — dimension-specific trees
135+
- `discordwebhook/` — Discord integration
136+
- `Downloads/` — BentoBox downloads site
137+
- `DragonFights/` — per-island ender dragon fights
138+
- `ExtraMobs/` — additional mob spawning rules
139+
- `FarmersDance/` — twerking crop growth
140+
- `GravityFlux/` — gravity addon
141+
- `Greenhouses-addon/` — greenhouse biomes
142+
- `IslandFly/` — island flight permission
143+
- `IslandRankup/` — island rankup system
144+
- `Likes/` — island likes/dislikes
145+
- `Limits/` — block/entity limits
146+
- `lost-sheep/` — lost sheep adventure
147+
- `MagicCobblestoneGenerator/` — custom cobblestone generator
148+
- `PortalStart/` — portal-based island start
149+
- `pp/` — pp addon
150+
- `Regionerator/` — region management
151+
- `Residence/` — residence addon
152+
- `TopBlock/` — top ten for OneBlock
153+
- `TwerkingForTrees/` — twerking tree growth
154+
- `Upgrades/` — island upgrades (Vault)
155+
- `Visit/` — island visiting
156+
- `weblink/` — web link addon
157+
- `CrowdBound/` — CrowdBound addon
158+
159+
**Data packs:**
160+
- `BoxedDataPack/` — advancement datapack for Boxed
161+
162+
**Documentation & tools:**
163+
- `docs/` — main documentation site
164+
- `docs-chinese/` — Chinese documentation
165+
- `docs-french/` — French documentation
166+
- `BentoBoxWorld.github.io/` — GitHub Pages site
167+
- `website/` — website
168+
- `translation-tool/` — translation tool
169+
170+
Check these for source before any network fetch.
171+
172+
## Key Dependencies (source locations)
173+
174+
- `world.bentobox:bentobox``~/git/bentobox/src/`

0 commit comments

Comments
 (0)