Skip to content

Commit dd178df

Browse files
tastybentoclaude
andcommitted
Refresh README to match modern addon style
Drops the Alpha-stage notice, restructures the page with the same section layout used by the recently-updated DimensionalTrees README, and rewrites the configuration and replacement-rules sections to reflect the current Nether / End / Overworld behaviour. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent c9428ea commit dd178df

1 file changed

Lines changed: 93 additions & 35 deletions

File tree

README.md

Lines changed: 93 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,118 @@
1-
# ExtraMobs Addon
1+
# 👾 ExtraMobs Add-on for BentoBox
22
[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
33
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/ExtraMobs)](https://ci.codemc.org/job/BentoBoxWorld/job/ExtraMobs/)
44

5-
Add-on for BentoBox that adjusts some mob spawning rules to get Blazes, Wither Skeleton, and Shulkers.
5+
## 🔍 What is ExtraMobs?
66

7-
## Where to find
7+
**ExtraMobs** is a BentoBox add-on that lets players spawn **Blazes**, **Wither Skeletons**, **Shulkers** and **Guardians** on their islands by building the right structures. It does **not** change Minecraft's spawning rules — it watches for natural spawns and replaces certain mobs by chance when the surrounding blocks match a themed pattern.
88

9-
Currently ExtraMobs Addon is in **Alpha stage**, so it may or may not contain bugs... a lot of bugs. Also it means, that some features are not working or implemented.
10-
You can download it from [Release tab](https://github.com/BentoBoxWorld/ExtraMobs/releases)
9+
Works with every BentoBox game mode (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, …).
1110

12-
Or you can try **nightly builds** where you can check and test new features that will be implemented in next release from [Jenkins Server](https://ci.codemc.org/job/BentoBoxWorld/job/ExtraMobs/lastStableBuild/).
11+
---
1312

14-
If you like this addon but something is missing or is not working as you want, you can always submit an [Issue request](https://github.com/BentoBoxWorld/ExtraMobs/issues) or get a support in Discord [BentoBox ![icon](https://avatars2.githubusercontent.com/u/41555324?s=15&v=4)](https://discord.bentobox.world)
13+
## 🚀 Getting Started
1514

16-
## How to use
15+
1. Place the **ExtraMobs** `.jar` into your BentoBox `addons` folder.
16+
2. Restart your server.
17+
3. The addon creates `addons/ExtraMobs/config.yml`.
18+
4. Edit `config.yml` to adjust the spawn chances or disable specific game modes.
19+
5. Restart the server (or reload BentoBox) to apply your changes.
1720

18-
1. Place the addon jar in the addons folder of the BentoBox plugin
19-
2. Restart the server
20-
3. In game you can change flags that allows to use current addon.
21+
---
2122

22-
## Information
23+
## ✨ How Replacements Work
2324

24-
This addon does not change Minecraft spawning rules. Instead it uses other mobs that are naturally generated and change their type with new entity, if all conditions are met.
25+
ExtraMobs only acts on **natural** spawns inside a BentoBox-managed world. When a candidate mob spawns on a themed block, ExtraMobs rolls against the configured chance; on success the original spawn is cancelled and the replacement entity is summoned in its place.
2526

26-
##### For Wither Skeleton and Blaze:
27+
### 🔥 Nether — Wither Skeleton & Blaze
2728

28-
Addon will replace Zombie Pigmen with Blaze or Wither Skeleton by chance from config, if:
29-
- given world is generated by GameMode Addon.
30-
- given world is Nether
31-
- Zombie Pigmen is standing on nether brick, nether brick slab or nether brick stairs.
29+
A **Zombified Piglin** or **Piglin** is replaced when:
30+
- the world is the BentoBox Nether,
31+
- and the mob is standing on **nether brick**, **nether brick slab**, or **nether brick stairs**.
3232

33-
##### For Shulkers:
33+
The wither skeleton roll is checked first, then the blaze roll.
3434

35-
Addon will replace Enderman with Shulker by chance from config if:
36-
- given world is generated by GameMode Addon.
37-
- given world is the End
38-
- Enderman is standing on purpur block, purpur stair or purpur slab.
35+
### 🌌 End — Shulker
3936

40-
##### For Guardians:
37+
An **Enderman** is replaced with a **Shulker** when:
38+
- the world is the BentoBox End,
39+
- and the mob is standing on a **purpur block**, **purpur slab**, or **purpur stairs**.
4140

42-
Addon will replace Cod, Salmon or Tropical fish with Guardian by chance from config if:
43-
- given world is generated by GameMode Addon.
44-
- given world is the Overworld
45-
- biome in given location is deep ocean or any its variants
46-
- first block above water where fish is spawned is prismarine, prismarine brick or dark prismarine (blocks, slabs and stairs).
41+
### 🌊 Overworld — Guardian
4742

43+
A naturally-spawned **Cod**, **Salmon**, or **Tropical Fish** is replaced with a **Guardian** when:
44+
- the world is the BentoBox Overworld,
45+
- the biome is **Deep Ocean** (or Deep Cold / Deep Frozen / Deep Lukewarm),
46+
- and the first non-water block above the fish is **prismarine**, **prismarine bricks**, or **dark prismarine** (block, slab, or stairs variant).
4847

49-
## Compatibility
48+
---
5049

51-
- [x] BentoBox - 1.11.0 version
50+
## ⚙️ Configuration
5251

53-
Addon is build on Minecraft 1.15.2 and BentoBox 1.11.0 version, however, it should even work on Minecraft 1.13.2 and BentoBox 1.0 Release.
52+
### Global Defaults
5453

55-
Addon supports all Game mode addons.
54+
```yaml
55+
# Game modes in which ExtraMobs should not run.
56+
# Add the GameMode addon name (e.g. BSkyBlock, AcidIsland, CaveBlock).
57+
disabled-gamemodes: []
5658

59+
nether-chances:
60+
# Chance (0.0–1.0) to spawn a Wither Skeleton instead of a Zombified Piglin.
61+
wither-skeleton: 0.01
62+
# Chance (0.0–1.0) to spawn a Blaze instead of a Zombified Piglin.
63+
blaze: 0.1
5764

58-
## Information
65+
end-chances:
66+
# Chance (0.0–1.0) to spawn a Shulker instead of an Enderman.
67+
shulker: 0.1
5968

60-
More information can be found in [Wiki Pages](https://github.com/BentoBoxWorld/ExtraMobs/wiki).
69+
overworld-chance:
70+
# Chance (0.0–1.0) to spawn a Guardian instead of a fish.
71+
guardian: 0.1
72+
```
73+
74+
All chance values are decimals between `0.0` (never) and `1.0` (always). For the Nether the wither skeleton roll is evaluated before the blaze roll, so the blaze chance is effectively conditional on the wither skeleton roll failing.
75+
76+
### Per-Gamemode Overrides
77+
78+
You can define replacement rules that only apply to a specific game mode. Each gamemode may set rules for the `nether`, `end`, and/or `world` (overworld) environments. **When per-gamemode rules are present for an environment, the global defaults above are not applied for that gamemode.**
79+
80+
```yaml
81+
gamemode-settings:
82+
BSkyBlock:
83+
nether:
84+
- old: ZOMBIFIED_PIGLIN
85+
new: WITHER_SKELETON
86+
chance: 0.05
87+
- old: ZOMBIFIED_PIGLIN
88+
new: BLAZE
89+
chance: 0.1
90+
end:
91+
- old: ENDERMAN
92+
new: SHULKER
93+
chance: 0.3
94+
world:
95+
- old: COD
96+
new: GUARDIAN
97+
chance: 0.15
98+
AcidIsland:
99+
end:
100+
- old: ENDERMAN
101+
new: SHULKER
102+
chance: 0.5
103+
```
104+
105+
Each rule needs:
106+
- `old` — the EntityType name of the mob to replace (e.g. `ZOMBIFIED_PIGLIN`, `ENDERMAN`, `COD`).
107+
- `new` — the EntityType name of the replacement (e.g. `WITHER_SKELETON`, `SHULKER`, `GUARDIAN`).
108+
- `chance` — probability in the range `0.0`–`1.0`.
109+
110+
The gamemode key must exactly match the GameMode addon name as registered in BentoBox (`BSkyBlock`, `AcidIsland`, `CaveBlock`, `SkyGrid`, …). Themed-block requirements (nether brick / purpur / prismarine) still apply to per-gamemode rules.
111+
112+
---
113+
114+
## 🐛 Bugs and Feature Requests
115+
116+
Please submit issues at [GitHub Issues](https://github.com/BentoBoxWorld/ExtraMobs/issues) or ask in the [BentoBox Discord](https://discord.bentobox.world).
117+
118+
More information is available on the [Wiki](https://github.com/BentoBoxWorld/ExtraMobs/wiki).

0 commit comments

Comments
 (0)