Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pcal43/mob-filter

Minecraft mod for controlling what mobs can spawn where
https://github.com/pcal43/mob-filter

minecraft minecraft-mod

Last synced: about 2 months ago
JSON representation

Minecraft mod for controlling what mobs can spawn where

Awesome Lists containing this project

README

        

# MobFilter

MobFilter is a Minecraft mod that allows you to limit spawning of mobs in your world.
You can use it to
* Create safe zones in your world where mobs aren't allowed to spawn.
* Completely prevent particular mobs from ever spawning
* Limit mob spawning to specific biomes, times, or light levels
* ...and more

MobFilter uses the Fabric modloader and runs only on the server.

I will not be doing a Forge version of MobFilter.

## Usage

MobFilter uses a flexible, rule-based filtering system that you configure. When Minecraft wants to spawn
a new mob, MobFilter checks the rules you provide to see if the spawn should be 'vetoed.'

The first time you run Minecraft with the mobfilter jar installed, an empty configuration file will be
created in `config/mobfilter.json5`. Just edit this file to set up your rules. The rules will take effect the
next time you start a world.

Rules can test for several conditions, including:
* Block Position
* Location (Biome, World, Dimension, BlockId)
* Mob Type (EntiyId or SpawnGroup)
* Time of Day
* Light Level
* Phase of moon

See [CONFIG.md](https://github.com/pcal43/mob-filter/blob/main/CONFIG.md) for more information about setting up rules.

## Config Examples

### Disable All Vanilla Mobs
```
{
rules : [
{
name : 'No Vanilla',
what : 'DISALLOW_SPAWN',
when : {
entityId : [ 'minecraft:*' ]
}
}
]
}
```

### Secret Cow Level

```
{
rules : [
{
name : 'Allow cows...',
what : 'ALLOW_SPAWN',
when : {
entityId : [ 'minecraft:cow' ]
}
},
{
name : '...and nothing else',
what : 'DISALLOW_SPAWN',
when : {}
}
]
}
```

### Safe Zone
```
{
rules : [
{
what : 'DISALLOW_SPAWN',
when : {
category : [ 'MONSTER' ],
dimensionId : [ 'minecraft:overworld' ],
blockX: [ -128, 234 ],
blockY : [ 63, 'MAX' ],
blockZ : [ -321, 512 ]
}
}
]
}
```

## Why This Mod?

I wrote this mod because I wanted to be able to be able to play survival minecraft with my daughter, and that meant
we had to have a mob-free area around our base. There are numerous other mods out there that manage mob spawning but
n one of them did quite what I needed them to do.

## Legal

This mod is published under the [Apache 2.0 License](LICENSE).

You're free to include this mod in your modpack provided you attribute it to pcal.net.

## Questions?

If you have questions about this mod, please join the Discord server:

[https://discord.pcal.net](https://discord.pcal.net)