# Black Hole Mod

A Minecraft mod that adds destructive, dynamic black holes to your world.

- **Github:** https://github.com/IDoTheHax/Blackhole
- **Modrinth:** https://modrinth.com/mod/blackhole
- **Discord:** https://discord.gg/FastpV5Qag

## Overview

The Black Hole mod introduces a new block that creates a simulated black hole in your Minecraft world. These black holes have realistic gravitational effects, pulling in nearby entities and blocks. They can grow over time, follow players, and cause destruction in their path.

## Features

- **Realistic Physics**: Black holes exert gravitational force on nearby entities and blocks based on configurable mass values
- **Growing Black Holes**: Black holes can expand over time, increasing their area of effect
- **Player Tracking**: Black holes can follow players within a configurable range
- **Visual Effects**: Features particle effects for an immersive experience
- **Fully Configurable**: All aspects of black hole behavior can be adjusted via commands or configuration file

## Commands

All commands require operator permission level 2 or higher and begin with `/blackhole`:

### Configuration Commands

| Command | Description |
|---------|-------------|
| `getmaxscale` / `setmaxscale <value>` | Get/set maximum size a black hole can grow to |
| `getgravity` / `setgravity <value>` | Get/set gravitational constant |
| `getplayermass` / `setplayermass <value>` | Get/set mass value for players |
| `getblockmass` / `setblockmass <value>` | Get/set mass value for blocks |
| `getitementitymass` / `setitementitymass <value>` | Get/set mass value for item entities |
| `getanimalmass` / `setanimalmass <value>` | Get/set mass value for animal entities |
| `getchunkloadradius` / `setchunkloadradius <value>` | Get/set radius of chunks to force-load around a black hole |
| `getmaxblockspertick` / `setmaxblockspertick <value>` | Get/set maximum blocks processed per tick |
| `getmovementspeed` / `setmovementspeed <value>` | Get/set movement speed of following black holes |
| `getdefaultfollowrange` / `setdefaultfollowrange <value>` | Get/set default range for black holes to detect players |
| `getplayerdetectioninterval` / `setplayerdetectioninterval <value>` | Get/set ticks between player detection checks |
| `getgrowthrate` / `setgrowthrate <value>` | Get/set growth rate for black holes |

### Black Hole Manipulation Commands

| Command | Description |
|---------|-------------|
| `togglefollow` | Toggle whether the nearest black hole follows players |
| `togglegrowth` | Toggle whether the nearest black hole grows over time |
| `setfollowrange <range>` | Set the follow range for the nearest black hole |

## Configuration

The mod creates a configuration file at `config/black_hole.json` with the following default values:

```json
{
"maxScale": 40.0,
"gravity": 60.0,
"playerMass": 700.0,
"blockMass": 10.0,
"itemEntityMass": 0.1,
"animalMass": 50.0,
"chunkLoadRadius": 2,
"maxBlocksPerTick": 500,
"movementSpeed": 1.0,
"defaultFollowRange": 256.0,
"playerDetectionInterval": 60,
"growthRate": 0.04
}
```

### Configuration Properties

| Property | Description | Default |
|----------|-------------|---------|
| `maxScale` | Maximum size a black hole can grow to | 40.0 |
| `gravity` | Gravitational constant affecting pull strength | 60.0 |
| `playerMass` | Mass value for players (affects how strongly they're pulled) | 700.0 |
| `blockMass` | Mass value for blocks | 10.0 |
| `itemEntityMass` | Mass value for item entities | 0.1 |
| `animalMass` | Mass value for animal entities | 50.0 |
| `chunkLoadRadius` | Radius of chunks to force-load around a black hole | 2 |
| `maxBlocksPerTick` | Maximum blocks processed per tick (performance setting) | 500 |
| `movementSpeed` | Movement speed when following players | 1.0 |
| `defaultFollowRange` | Default range for black holes to detect players | 256.0 |
| `playerDetectionInterval` | Ticks between player detection checks | 60 |
| `growthRate` | How quickly black holes grow in size | 0.04 |

## Behavior Notes

- Black holes will consume any entity that gets too close to its center
- Creative mode players are immune to black hole effects
- Black holes can break most blocks but cannot break blocks with infinite hardness (like bedrock)
- Black holes can be configured to not follow players or to stop growing
- Black holes will create falling block entities from some destroyed blocks for visual effect
- Each black hole maintains its own settings for following and growth

## Technical Information

- The mod uses Polymer for block rendering
- Black holes are implemented as block entities with associated display entities,
- Force-loaded chunks ensure black holes continue to function even when players are not nearby
- The mod implements a scheduled tick system to control black hole growth and movement

## Known Issues
- Black Hole Rendering Issue: The black hole often looks like the circle is moving when the player changes their view, this is due to the display mode of the item display being set to billboard, advanced maths that i dont understand is required to fix this.
- Render Distance Issue: The black hole disappears when moving too far away, even within typical render distances, due to entity rendering limitations.

Any fixes found can be submitted through a Pull request on the Github: https://github.com/IDoTheHax/Blackhole
Don't Hesitate to add your fixes!!

## Compatibility

This mod is built for Fabric and requires:
- Fabric API (Required)
- Polymer (embedded)

## License

## Credits

Created by IDoTheHax