FeatherRegen
Custom Regenerating Blocks Made Easy!

Features

• Custom Regenerating Blocks: Easily create unique blocks that regenerate after being broken.
• Flexible Configuration: Customize block types, respawn times, commands, and more.
• Command Integration: Execute custom commands when blocks are broken.
• Particle Effects: Add visual effects with customizable particles.
• Temporary Replacements: Set temporary blocks until regeneration occurs.
• In-Game Management: Use simple commands to place or remove custom blocks.
• Custom Block Placer Tool: Place custom blocks easily with a special tool.
• SQLite Database: Efficiently store and manage custom block data.
• Permissions System: Control user access to plugin features.

Getting Started
Installation

1. Download the FeatherRegen.jar file.
2. Place it in your server's plugins folder.
3. Restart your server.

Configuration

1. Navigate to plugins/FeatherRegen/config.yml.
2. Customize the settings and define your custom blocks (several examples are provided in the default config.yml file).
3. Save the file and restart your server.

Creating Custom Blocks

1. Use /featherregen set <block_name> while looking at a block to set it as a custom block.
2. Alternatively, use /featherregen tool <block_name> to get a placer tool, then break blocks with it to set custom blocks.

Managing Custom Blocks

1. Use /featherregen list to view all available custom blocks.
2. Use /featherregen remove while looking at a custom block to remove it.
3. Use /featherregen reset to clear all custom blocks (use with caution!).

Configuration Example
Here’s an example of how to configure a custom block in config.yml:

Explanation:

• lucky_gold: The name of your custom block.
• block_type: The Minecraft material for this block.
• commands: List of commands to execute when the block is broken.
• particle_effect: The visual effect displayed on block break.
• respawn_time: Time (in seconds) before the block regenerates.
• replace_with: Temporary block to place until regeneration.

Commands & Permissions
Commands

• /featherregen list – View all available custom blocks.
• /featherregen set <block_name> – Set a custom block at your target location.
• /featherregen remove – Remove a custom block at your target location.
• /featherregen reset – Reset the entire custom blocks database.
• /featherregen tool <block_name> – Get a custom block placer tool.

Permissions

• featherregen.admin – Allows use of all FeatherRegen commands (default: op).

Usage Examples
Example: Creating a Lucky Gold Block

1. Configure the block in config.yml (see configuration example above).
2. In-game, look at the desired location and type: /featherregen set lucky_gold.
   The block will now regenerate when broken, giving players gold and luck!

Example: Setting Up a Speed Beacon
Add this to your config.yml:

In-game, you can now use and place speed beacons around your world.

------------------------------------

FAQ

• How do I update the plugin?
  Simply replace the old .jar file with the new one and restart your server. Your configurations and data will be preserved.
  
  
• Can I change a custom block's properties after placing it?
  Yes! Update the block’s configuration in config.yml, then restart your server. The changes will apply to all existing blocks of that type.
  
  
• Is the plugin compatible with other block protection plugins?
  FeatherRegen should work alongside most protection plugins, but always test compatibility in a safe environment first.
  
  
• Can I use placeholders in the commands?
  Yes! Use <player> in your commands, and it will be replaced with the name of the player who broke the block.

Elevate your server with FeatherRegen today!
For support or feature requests, please use the discussion section or create an issue on the resource page.