README-dev.md

Build instructions

If you just want to install the mod, skip this section and refer to the instructions in the main README.md document.

Stuff you'll need:

• The Java Development Kit (JDK)
• A copy of minecraft.jar from your Minecraft installation
• LibShapeDraw
• Minecraft Coder Pack (MCP)
• Either ModLoader or Minecraft Forge

Step-by-step

1. Option A: Patch minecraft.jar to include ModLoader, then install and configure MCP using the modified minecraft.jar.
   Option B: Install and configure MCP along with the Forge sources. For this option your minecraft.jar needs to be unmodified.
2. Make sure you're able to recompile Minecraft before the next step.
3. Add the LibShapeDraw jar to jars/bin and to the classpath, following the instructions from LibShapeDraw's documentation.
4. Copy everything from this repo's src/ directory to src/minecraft/.
5. Recompile, reobfuscate, and package the jar/zip. If you're on a Unix-based system, you can use the build-buildregion.sh script for this.

Planned features

The following features will likely be added to BuildRegion eventually. Features listed near the top of this list are coming sooner rather than later.

• Sphere and cylinder region types
• Speed optimizations: use OpenGL VBOs wherever possible
• Allow user to specify a different modifier key (Shift/Alt/Ctrl/Cmd)
• Remember the last region type used between game sessions
• Add alternate cuboid selection method: specify corners (ala WorldEdit)
• Basic integration with server-side plugins like WorldGuard, etc.
• Allow half-height horizontal regions for slab and step placement
• A schematic region type
• Cut/copy/paste functionality, only for single-player worlds with cheats enabled, or for servers with an appropriate plugin (e.g. WorldEdit)