ClaimChunk: A Java repository from cjburkey01

Join us on our Discord server for bug reports, support, and general chatting!

Info

Spigot plugin for 1.20+ allowing the claiming of chunks.

The destiny of chunks is to unite not to divide
Let's make the world ours.

Usage and more information can be found on the wiki.

1.20-1.21+ | The latest version works seamlessly (excluding bugs, of course).

Note for 0.0.23+! When updating the server from 1.20 to 1.21, ClaimChunk will throw errors that it can't find entities by whatever names due to the enum API change.

If you keep getting those errors on server start, stop the server, open your old profiles at /plugins/ClaimChunk/worlds/<PROFILE>.txt, then copy these lines and replace the old (similar looking) ones in each world profile file:

_._@B_:
  CONTAINER  [ CYAN_SHULKER_BOX, BLAST_FURNACE, CHEST_MINECART, GREEN_SHULKER_BOX, MAGENTA_SHULKER_BOX, LIGHT_GRAY_SHULKER_BOX, HOPPER_MINECART, FURNACE, LIGHT_BLUE_SHULKER_BOX, WHITE_SHULKER_BOX, TRAPPED_CHEST, FURNACE_MINECART, GRAY_SHULKER_BOX, LIME_SHULKER_BOX, BREWING_STAND, RED_SHULKER_BOX, PINK_SHULKER_BOX, SMOKER, DISPENSER, PURPLE_SHULKER_BOX, HOPPER, CHEST, BLUE_SHULKER_BOX, BLACK_SHULKER_BOX, ORANGE_SHULKER_BOX, YELLOW_SHULKER_BOX, SHULKER_BOX, BARREL, BROWN_SHULKER_BOX, DROPPER ] ;
  DOOR  [ MANGROVE_TRAPDOOR, WAXED_COPPER_TRAPDOOR, OAK_TRAPDOOR, WAXED_EXPOSED_COPPER_DOOR, IRON_TRAPDOOR, ACACIA_TRAPDOOR, DARK_OAK_DOOR, BIRCH_TRAPDOOR, CHERRY_TRAPDOOR, BAMBOO_TRAPDOOR, JUNGLE_DOOR, WAXED_COPPER_DOOR, WARPED_TRAPDOOR, COPPER_DOOR, EXPOSED_COPPER_TRAPDOOR, WAXED_OXIDIZED_COPPER_DOOR, CHERRY_DOOR, WAXED_OXIDIZED_COPPER_TRAPDOOR, WARPED_DOOR, WAXED_WEATHERED_COPPER_TRAPDOOR, MANGROVE_DOOR, WAXED_EXPOSED_COPPER_TRAPDOOR, IRON_DOOR, DARK_OAK_TRAPDOOR, CRIMSON_DOOR, SPRUCE_DOOR, BAMBOO_DOOR, BIRCH_DOOR, WAXED_WEATHERED_COPPER_DOOR, ACACIA_DOOR, JUNGLE_TRAPDOOR, COPPER_TRAPDOOR, OXIDIZED_COPPER_TRAPDOOR, CRIMSON_TRAPDOOR, WEATHERED_COPPER_TRAPDOOR, OXIDIZED_COPPER_DOOR, OAK_DOOR, EXPOSED_COPPER_DOOR, SPRUCE_TRAPDOOR, WEATHERED_COPPER_DOOR ] ;
  REDSTONE  [ DARK_OAK_BUTTON, MANGROVE_BUTTON, BAMBOO_BUTTON, CHERRY_PRESSURE_PLATE, WARPED_PRESSURE_PLATE, ACACIA_PRESSURE_PLATE, BAMBOO_PRESSURE_PLATE, STONE_BUTTON, SPRUCE_PRESSURE_PLATE, DARK_OAK_PRESSURE_PLATE, JUNGLE_PRESSURE_PLATE, BIRCH_PRESSURE_PLATE, POLISHED_BLACKSTONE_PRESSURE_PLATE, CRIMSON_BUTTON, ACACIA_BUTTON, HEAVY_WEIGHTED_PRESSURE_PLATE, CRIMSON_PRESSURE_PLATE, CHERRY_BUTTON, OAK_BUTTON, LEVER, STONE_PRESSURE_PLATE, BIRCH_BUTTON, MANGROVE_PRESSURE_PLATE, SPRUCE_BUTTON, POLISHED_BLACKSTONE_BUTTON, WARPED_BUTTON, LIGHT_WEIGHTED_PRESSURE_PLATE, OAK_PRESSURE_PLATE, JUNGLE_BUTTON ] ;
  SIGN  [ WARPED_HANGING_SIGN, ACACIA_HANGING_SIGN, JUNGLE_WALL_HANGING_SIGN, OAK_HANGING_SIGN, BIRCH_WALL_HANGING_SIGN, BAMBOO_WALL_SIGN, ACACIA_WALL_SIGN, CHERRY_WALL_SIGN, ACACIA_SIGN, OAK_SIGN, BAMBOO_HANGING_SIGN, DARK_OAK_SIGN, BIRCH_WALL_SIGN, BAMBOO_SIGN, DARK_OAK_HANGING_SIGN, SPRUCE_WALL_HANGING_SIGN, DARK_OAK_WALL_SIGN, CRIMSON_HANGING_SIGN, MANGROVE_HANGING_SIGN, CRIMSON_WALL_SIGN, CHERRY_HANGING_SIGN, CRIMSON_WALL_HANGING_SIGN, BIRCH_SIGN, BIRCH_HANGING_SIGN, BAMBOO_WALL_HANGING_SIGN, SPRUCE_HANGING_SIGN, MANGROVE_WALL_HANGING_SIGN, OAK_WALL_HANGING_SIGN, WARPED_WALL_HANGING_SIGN, OAK_WALL_SIGN, ACACIA_WALL_HANGING_SIGN, SPRUCE_SIGN, SPRUCE_WALL_SIGN, MANGROVE_SIGN, CRIMSON_SIGN, WARPED_SIGN, CHERRY_SIGN, JUNGLE_HANGING_SIGN, DARK_OAK_WALL_HANGING_SIGN, MANGROVE_WALL_SIGN, CHERRY_WALL_HANGING_SIGN, JUNGLE_WALL_SIGN, WARPED_WALL_SIGN, JUNGLE_SIGN ] ;

_._@E_:
  ANIMALS  [ MOOSHROOM, MULE, FROG, HOGLIN, LLAMA, SHEEP, ARMADILLO, POLAR_BEAR, CHICKEN, TURTLE, CAMEL, TRADER_LLAMA, ZOMBIE_HORSE, SNIFFER, BEE, HORSE, SKELETON_HORSE, PARROT, COW, FOX, PIG, AXOLOTL, CAT, GOAT, RABBIT, WOLF, STRIDER, DONKEY, PANDA, OCELOT ] ;
  HANGING_ENTITIES  [ GLOW_ITEM_FRAME, ITEM_FRAME, PAINTING, LEASH_KNOT ] ;
  MONSTERS  [ ENDERMAN, SILVERFISH, ZOMBIE_VILLAGER, HUSK, VEX, WARDEN, VINDICATOR, WITCH, SPIDER, PILLAGER, SKELETON, WITHER_SKELETON, PIGLIN_BRUTE, WITHER, CREEPER, BOGGED, ILLUSIONER, ZOMBIFIED_PIGLIN, BREEZE, CAVE_SPIDER, RAVAGER, DROWNED, GUARDIAN, EVOKER, ELDER_GUARDIAN, BLAZE, PIGLIN, ENDERMITE, GIANT, STRAY, ZOGLIN, ZOMBIE ] ;
  VEHICLES  [ SPAWNER_MINECART, COMMAND_BLOCK_MINECART, CHEST_BOAT, CHEST_MINECART, MINECART, TNT_MINECART, FURNACE_MINECART, HOPPER_MINECART, BOAT ] ;

1.17 - 1.20 | The latest known working version is 0.0.23-RC8.
- Newer versions of the plugin will require Java 17, but may still work.
1.13 - 1.16.5 | The latest working version is 0.0.22.
- Note: If you disable titles, 0.0.23 might work on version older than 1.17. If you experience issues, however, they may be more difficult to address.
Pre-1.13 | The latest working version is 0.0.20
- Newer features of Spigot are used in builds 0.0.21 and later that make it incompatible with older versions.
- 1.9 - 1.12 | Should work without any trouble.
- 1.6 - 1.8 | Works when useTitlesInsteadOfChat is set to false under the titles section of the config.

If you have issues running an old version of the plugin on a Minecraft version within the above supported ranges, you may make an issue, and I should be able to help, but I won't be bringing newer features over. They officially have "minor bug support" status. Version 0.0.23 will be supported for slightly longer though, as this transition period may get funky.

I'm keeping the Spigot API version I build against for 1.20.6 for a while, about 25% of server owners reporting anonymous data (to bStats.org) still use 1.20.4, but 30ish% use 1.21, so the goal is compatibility with both versions at least.

For even more information, the SpigotMC page can be found here.

Download

Downloads are available in the releases section and separately on Modrinth.

The latest compiled version of this repository can be downloaded via this link.

Optional Features:

Vault (for currency support you will also need an economy plugin like Essentials).
WorldGuard (VERSION 7.0.0 OR ABOVE REQUIRED and, as such, WorldGuard support is only available for 1.13 OR ABOVE).
PlaceholderAPI (View the available placeholders on the wiki).

News

This section is being written on the 600th commit! Happy 600 everyone :) May our years going forward be full of joy!

We've had ClaimChunk among us for 2473 days (as of today), thanks to the effort of 9 other contributors supporting me along the way!

If you'd like to help out, open a pull request or submit a GitHub issue with a feature request and/or bugs you've come across!

Guess what! I'm sorta back :) Life has been crazy for the last couple of years, but here I am :) I hope to continue working on this plugin and making existing features more stable (and maybe a small thing here or there)!

Please do join the Discord server if you have any trouble with anything or want to know what I'm currently doing. I'll be a little more online, I hope!

Plugin Integrations

If you have developed an addon for ClaimChunk or for another plugin that integrates with ClaimChunk, or have added ClaimChunk support to your plugin, let me know, and I'll put your addon/plugin here. You can reach me at bulletlanguage@gmail.com or through the Discord server.

Here are some plugins that either have addons for or integrations with ClaimChunk:

MongoDB integration with this addon by Glowman554
Regionerator (prevent claimed chunks from being regenerated)

Addons that aren't actively maintained but could be useful:

Dynmap via this addon
Archived: Pl3xMap via this addon
(Old, maybe functional, repository deleted) ClaimFly (allowing players to fly in claimed territory).

Now on Maven Central! To make a plugin, use one of these snippets:

Maven:

<dependency>
    <groupId>com.cjburkey.claimchunk</groupId>
    <artifactId>claimchunk</artifactId>
    <version>0.0.25-FIX3</version>
</dependency>

Gradle (Groovy):

implementation 'com.cjburkey.claimchunk:claimchunk:0.0.25-FIX3'

Gradle (Kotlin):

implementation("com.cjburkey.claimchunk:claimchunk:0.0.25-FIX3")

Building

If you want to obtain a version of the plugin that isn't available yet (like a snapshot), you can do so by asking on the Discord or building it yourself. Here's how to build it yourself:

First, you'll need to clone the repo either using the Git command:
git clone git@github.com:cjburkey01/ClaimChunk.git
or downloading the repository source using the button shown below (Or you can click the image!):

Once you have obtained the repo, inside the local repository, you'll just need to execute this Gradle Wrapper command:

./gradlew build for Unix/Mac
gradlew build for Windows

Your built jar file can be found at:
<REPO>/OUT/claimchunk-VERSION.jar