Skip to content

Commit a7b59bf

Browse files
committed
Add Spawners public docs
1 parent a376d68 commit a7b59bf

16 files changed

Lines changed: 592 additions & 230 deletions

File tree

project-docs/README.md

Lines changed: 59 additions & 58 deletions
Large diffs are not rendered by default.

project-docs/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ For support/debugging:
6262
- [DiscordChat](plugins/discordchat.md)
6363
- [GameTypes](plugins/gametypes.md)
6464
- [BirthdayLanterns](plugins/birthdaylanterns.md)
65+
- [LavaBoots](plugins/lavaboots.md)
66+
- [Spawners](plugins/spawners.md)
6567
- [MobHat](plugins/mobhat.md)
6668
- [PlayerTodo](plugins/todo.md)
6769
- [Refer](plugins/refer.md)

project-docs/docs/commands.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ Feature `/help` pages are intentionally player-facing: they list commands availa
133133
/1mbcmi debug plugin namemc all
134134
/1mbcmi debug plugin trades all
135135
/1mbcmi debug plugin votetokens all
136+
/1mbcmi debug plugin spawners all
136137
/1mbcmi debug plugin mobhat all
137138
/1mbcmi debug plugin todo all
138139
/1mbcmi debug plugin staffcenter all
@@ -835,6 +836,23 @@ LavaBoots:
835836

836837
`/lavaboots` is player-safe and inspects a LavaBoots item the player is wearing, holding, or carrying. Admin give commands work from direct console and in game, create dyed leather boots with PDC identity, and do not create crafting recipes. Levels I-III are normal event levels; IV and V are rare event tiers with lava vision while active. The boots spend stored charge seconds, can absorb magma cream or fire charges from the offhand, drain real leather durability while used in lava, and are blocked from anvil, enchanting, grindstone, smithing, mcMMO repair block, and repair-style player commands.
837838

839+
Spawners:
840+
841+
```text
842+
/spawners
843+
/spawners info
844+
/spawners help
845+
/spawners reload
846+
/spawners admin give mrfloris rabbit 1
847+
/spawners admin give mrfloris cow 4
848+
/spawners admin setupcommands
849+
/spawners debug item
850+
/spawners debug discovered
851+
/spawners debug all
852+
```
853+
854+
`/spawners` opens the hardened shop GUI. Purchases require the relevant CMI `cmi.placespawner.<type>` permission, available balance through the CMI-backed Vault economy provider, and safe inventory space. `/spawners admin setupcommands` exports LuckPerms commands for the configured CMI place/drop spawner permissions.
855+
838856
MobHat:
839857

840858
```text

project-docs/docs/compiling.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ gradle clean refreshBuildDocs build
2424
Expected jar naming:
2525

2626
```text
27-
1MB-CMIAPI-LIB-v1.0.0-394-j25-26.1.2.jar
28-
1MB-CMIAPI-AFKShrine-v1.0.0-394-j25-26.1.2.jar
29-
1MB-CMIAPI-StaffCenter-v1.0.0-394-j25-26.1.2.jar
30-
1MB-CMIAPI-Profile-v1.0.0-394-j25-26.1.2.jar
27+
1MB-CMIAPI-LIB-v1.0.0-395-j25-26.1.2.jar
28+
1MB-CMIAPI-AFKShrine-v1.0.0-395-j25-26.1.2.jar
29+
1MB-CMIAPI-StaffCenter-v1.0.0-395-j25-26.1.2.jar
30+
1MB-CMIAPI-Profile-v1.0.0-395-j25-26.1.2.jar
3131
```
3232

3333
After a successful feature or library build, copy the output jar into:

project-docs/docs/features.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ These are the first feature candidates now using the shared library scaffold:
3535
| Player Fun | GameTypes | `/gametype` safe BentoBox menu adapter for OneBlock, SkyBlock, AcidIsland, CaveBlock, and SkyGrid with world detection and config-driven addon buttons | [GameTypes](plugins/gametypes.md) |
3636
| Player Fun | BirthdayLanterns | `/birthday` collectible birthday, player anniversary, and server milestone lanterns with strict input, GUI claims, finite wish charges, guestbook notes, presets, mail variants, and configurable CMI reward commands | [BirthdayLanterns](plugins/birthdaylanterns.md) |
3737
| Player Fun | LavaBoots | `/lavaboots` finite PDC-marked lava-assist boots with dyed leather event themes, charge, durability drain, offhand fuel, movement assist, short fire-resistance windows, lava vision event tiers, and repair/anvil/enchant guards | [LavaBoots](plugins/lavaboots.md) |
38+
| Player Fun | Spawners | `/spawners` CMI spawner shop GUI with Paper entity discovery, CMI placespawner permission checks, CMI-backed Vault economy purchases, event-year limits, setup exports, and safe buyback scaffolding | [Spawners](plugins/spawners.md) |
3839
| Player Fun | MobHat | Cosmetic whitelisted mob hats with optional `/hat mob` alias support, world safety, scale handling, and experimental offset positions | [MobHat](plugins/mobhat.md) |
3940
| Player Fun | PlayerTodo | Per-player `/todo` notes with paging, search, completion state, and lightweight milestones | [PlayerTodo](plugins/todo.md) |
4041
| Player Fun | Refer | Two-step `/refer <player>` and `/refer verify` referral rewards with CMI/PlaceholderAPI playtime checks | [Refer](plugins/refer.md) |

project-docs/docs/installation.md

Lines changed: 59 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -10,59 +10,60 @@ Paper loads normal plugin jars from the top-level server `/plugins/` directory,
1010
plugins/
1111
CMI-<version>.jar
1212
CMILib<version>.jar
13-
1MB-CMIAPI-LIB-v1.0.0-394-j25-26.1.2.jar
14-
1MB-CMIAPI-AFKShrine-v1.0.0-394-j25-26.1.2.jar
15-
1MB-CMIAPI-RecordingMode-v1.0.0-394-j25-26.1.2.jar
16-
1MB-CMIAPI-SellStreaks-v1.0.0-394-j25-26.1.2.jar
17-
1MB-CMIAPI-ScheduledTips-v1.0.0-394-j25-26.1.2.jar
18-
1MB-CMIAPI-Visit-v1.0.0-394-j25-26.1.2.jar
19-
1MB-CMIAPI-PassportDiscovery-v1.0.0-394-j25-26.1.2.jar
20-
1MB-CMIAPI-SocialGatherings-v1.0.0-394-j25-26.1.2.jar
21-
1MB-CMIAPI-JourneyMap-v1.0.0-394-j25-26.1.2.jar
22-
1MB-CMIAPI-KitStreaks-v1.0.0-394-j25-26.1.2.jar
23-
1MB-CMIAPI-MessageFont-v1.0.0-394-j25-26.1.2.jar
24-
1MB-CMIAPI-Nick-v1.0.0-394-j25-26.1.2.jar
25-
1MB-CMIAPI-EmoteMenu-v1.0.0-394-j25-26.1.2.jar
26-
1MB-CMIAPI-PvPToggle-v1.0.0-394-j25-26.1.2.jar
27-
1MB-CMIAPI-Boosters-v1.0.0-394-j25-26.1.2.jar
28-
1MB-CMIAPI-NameMC-v1.0.0-394-j25-26.1.2.jar
29-
1MB-CMIAPI-Trades-v1.0.0-394-j25-26.1.2.jar
30-
1MB-CMIAPI-VoteTokens-v1.0.0-394-j25-26.1.2.jar
31-
1MB-CMIAPI-DiscordChat-v1.0.0-394-j25-26.1.2.jar
32-
1MB-CMIAPI-GameTypes-v1.0.0-394-j25-26.1.2.jar
33-
1MB-CMIAPI-BirthdayLanterns-v1.0.0-394-j25-26.1.2.jar
34-
1MB-CMIAPI-LavaBoots-v1.0.0-394-j25-26.1.2.jar
35-
1MB-CMIAPI-MobHat-v1.0.0-394-j25-26.1.2.jar
36-
1MB-CMIAPI-PlayerTodo-v1.0.0-394-j25-26.1.2.jar
37-
1MB-CMIAPI-Refer-v1.0.0-394-j25-26.1.2.jar
38-
1MB-CMIAPI-TPAuto-v1.0.0-394-j25-26.1.2.jar
39-
1MB-CMIAPI-Menu-v1.0.0-394-j25-26.1.2.jar
40-
1MB-CMIAPI-StaffCenter-v1.0.0-394-j25-26.1.2.jar
41-
1MB-CMIAPI-Profile-v1.0.0-394-j25-26.1.2.jar
42-
1MB-CMIAPI-FilterLab-v1.0.0-394-j25-26.1.2.jar
43-
1MB-CMIAPI-FilterGuard-v1.0.0-394-j25-26.1.2.jar
44-
1MB-CMIAPI-WarningLens-v1.0.0-394-j25-26.1.2.jar
45-
1MB-CMIAPI-NotableMsg-v1.0.0-394-j25-26.1.2.jar
46-
1MB-CMIAPI-CmdCostDashboard-v1.0.0-394-j25-26.1.2.jar
47-
1MB-CMIAPI-CMIConfig-v1.0.0-394-j25-26.1.2.jar
48-
1MB-CMIAPI-ConsoleNoiseRouter-v1.0.0-394-j25-26.1.2.jar
49-
1MB-CMIAPI-EconomyGuardian-v1.0.0-394-j25-26.1.2.jar
50-
1MB-CMIAPI-StartupDoctor-v1.0.0-394-j25-26.1.2.jar
51-
1MB-CMIAPI-UpdateSmoke-v1.0.0-394-j25-26.1.2.jar
52-
1MB-CMIAPI-PluginVersions-v1.0.0-394-j25-26.1.2.jar
53-
1MB-CMIAPI-Potions-v1.0.0-394-j25-26.1.2.jar
54-
1MB-CMIAPI-Upgrade-v1.0.0-394-j25-26.1.2.jar
55-
1MB-CMIAPI-EndCrystals-v1.0.0-394-j25-26.1.2.jar
56-
1MB-CMIAPI-WorldSnapshot-v1.0.0-394-j25-26.1.2.jar
57-
1MB-CMIAPI-SparkReviewer-v1.0.0-394-j25-26.1.2.jar
58-
1MB-CMIAPI-Hoppers-v1.0.0-394-j25-26.1.2.jar
59-
1MB-CMIAPI-EventRecorder-v1.0.0-394-j25-26.1.2.jar
60-
1MB-CMIAPI-CMIProbe-v1.0.0-394-j25-26.1.2.jar
61-
1MB-CMIAPI-CMIDatabase-v1.0.0-394-j25-26.1.2.jar
62-
1MB-CMIAPI-PlaceholderProbe-v1.0.0-394-j25-26.1.2.jar
63-
1MB-CMIAPI-CMIPlaceholderCheck-v1.0.0-394-j25-26.1.2.jar
64-
1MB-CMIAPI-WarpAudit-v1.0.0-394-j25-26.1.2.jar
65-
1MB-CMIAPI-WorthDrift-v1.0.0-394-j25-26.1.2.jar
13+
1MB-CMIAPI-LIB-v1.0.0-395-j25-26.1.2.jar
14+
1MB-CMIAPI-AFKShrine-v1.0.0-395-j25-26.1.2.jar
15+
1MB-CMIAPI-RecordingMode-v1.0.0-395-j25-26.1.2.jar
16+
1MB-CMIAPI-SellStreaks-v1.0.0-395-j25-26.1.2.jar
17+
1MB-CMIAPI-ScheduledTips-v1.0.0-395-j25-26.1.2.jar
18+
1MB-CMIAPI-Visit-v1.0.0-395-j25-26.1.2.jar
19+
1MB-CMIAPI-PassportDiscovery-v1.0.0-395-j25-26.1.2.jar
20+
1MB-CMIAPI-SocialGatherings-v1.0.0-395-j25-26.1.2.jar
21+
1MB-CMIAPI-JourneyMap-v1.0.0-395-j25-26.1.2.jar
22+
1MB-CMIAPI-KitStreaks-v1.0.0-395-j25-26.1.2.jar
23+
1MB-CMIAPI-MessageFont-v1.0.0-395-j25-26.1.2.jar
24+
1MB-CMIAPI-Nick-v1.0.0-395-j25-26.1.2.jar
25+
1MB-CMIAPI-EmoteMenu-v1.0.0-395-j25-26.1.2.jar
26+
1MB-CMIAPI-PvPToggle-v1.0.0-395-j25-26.1.2.jar
27+
1MB-CMIAPI-Boosters-v1.0.0-395-j25-26.1.2.jar
28+
1MB-CMIAPI-NameMC-v1.0.0-395-j25-26.1.2.jar
29+
1MB-CMIAPI-Trades-v1.0.0-395-j25-26.1.2.jar
30+
1MB-CMIAPI-VoteTokens-v1.0.0-395-j25-26.1.2.jar
31+
1MB-CMIAPI-DiscordChat-v1.0.0-395-j25-26.1.2.jar
32+
1MB-CMIAPI-GameTypes-v1.0.0-395-j25-26.1.2.jar
33+
1MB-CMIAPI-BirthdayLanterns-v1.0.0-395-j25-26.1.2.jar
34+
1MB-CMIAPI-LavaBoots-v1.0.0-395-j25-26.1.2.jar
35+
1MB-CMIAPI-Spawners-v1.0.0-395-j25-26.1.2.jar
36+
1MB-CMIAPI-MobHat-v1.0.0-395-j25-26.1.2.jar
37+
1MB-CMIAPI-PlayerTodo-v1.0.0-395-j25-26.1.2.jar
38+
1MB-CMIAPI-Refer-v1.0.0-395-j25-26.1.2.jar
39+
1MB-CMIAPI-TPAuto-v1.0.0-395-j25-26.1.2.jar
40+
1MB-CMIAPI-Menu-v1.0.0-395-j25-26.1.2.jar
41+
1MB-CMIAPI-StaffCenter-v1.0.0-395-j25-26.1.2.jar
42+
1MB-CMIAPI-Profile-v1.0.0-395-j25-26.1.2.jar
43+
1MB-CMIAPI-FilterLab-v1.0.0-395-j25-26.1.2.jar
44+
1MB-CMIAPI-FilterGuard-v1.0.0-395-j25-26.1.2.jar
45+
1MB-CMIAPI-WarningLens-v1.0.0-395-j25-26.1.2.jar
46+
1MB-CMIAPI-NotableMsg-v1.0.0-395-j25-26.1.2.jar
47+
1MB-CMIAPI-CmdCostDashboard-v1.0.0-395-j25-26.1.2.jar
48+
1MB-CMIAPI-CMIConfig-v1.0.0-395-j25-26.1.2.jar
49+
1MB-CMIAPI-ConsoleNoiseRouter-v1.0.0-395-j25-26.1.2.jar
50+
1MB-CMIAPI-EconomyGuardian-v1.0.0-395-j25-26.1.2.jar
51+
1MB-CMIAPI-StartupDoctor-v1.0.0-395-j25-26.1.2.jar
52+
1MB-CMIAPI-UpdateSmoke-v1.0.0-395-j25-26.1.2.jar
53+
1MB-CMIAPI-PluginVersions-v1.0.0-395-j25-26.1.2.jar
54+
1MB-CMIAPI-Potions-v1.0.0-395-j25-26.1.2.jar
55+
1MB-CMIAPI-Upgrade-v1.0.0-395-j25-26.1.2.jar
56+
1MB-CMIAPI-EndCrystals-v1.0.0-395-j25-26.1.2.jar
57+
1MB-CMIAPI-WorldSnapshot-v1.0.0-395-j25-26.1.2.jar
58+
1MB-CMIAPI-SparkReviewer-v1.0.0-395-j25-26.1.2.jar
59+
1MB-CMIAPI-Hoppers-v1.0.0-395-j25-26.1.2.jar
60+
1MB-CMIAPI-EventRecorder-v1.0.0-395-j25-26.1.2.jar
61+
1MB-CMIAPI-CMIProbe-v1.0.0-395-j25-26.1.2.jar
62+
1MB-CMIAPI-CMIDatabase-v1.0.0-395-j25-26.1.2.jar
63+
1MB-CMIAPI-PlaceholderProbe-v1.0.0-395-j25-26.1.2.jar
64+
1MB-CMIAPI-CMIPlaceholderCheck-v1.0.0-395-j25-26.1.2.jar
65+
1MB-CMIAPI-WarpAudit-v1.0.0-395-j25-26.1.2.jar
66+
1MB-CMIAPI-WorthDrift-v1.0.0-395-j25-26.1.2.jar
6667
```
6768

6869
The common `1MB-CMIAPI-` prefix keeps the project jars together when sorted by filename.
@@ -121,6 +122,11 @@ plugins/
121122
logs/
122123
LavaBoots/
123124
config.yml
125+
Spawners/
126+
config.yml
127+
players/
128+
exports/
129+
logs/
124130
EmoteMenu/
125131
config.yml
126132
PvPToggle/

project-docs/docs/permissions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,15 @@ onembcmi.lavaboots.inspect
170170
onembcmi.lavaboots.toggle
171171
onembcmi.lavaboots.reload
172172
onembcmi.lavaboots.debug
173+
onembcmi.spawners.use
174+
onembcmi.spawners.buy
175+
onembcmi.spawners.pickaxe
176+
onembcmi.spawners.sell
177+
onembcmi.spawners.admin
178+
onembcmi.spawners.reload
179+
onembcmi.spawners.give
180+
onembcmi.spawners.setup
181+
onembcmi.spawners.debug
173182
onembcmi.emotemenu.use
174183
onembcmi.emotemenu.search
175184
onembcmi.emotemenu.run
@@ -524,6 +533,8 @@ Potions is locked by default. Grant `onembcmi.potions.admin` explicitly in LuckP
524533

525534
LavaBoots grants `onembcmi.lavaboots.use` to players by default so they can inspect boots they are wearing, holding, or carrying with `/lavaboots`. Admin creation and item retirement are locked by default: grant `onembcmi.lavaboots.give` for event item creation, `onembcmi.lavaboots.gui` for the in-game builder, `onembcmi.lavaboots.toggle` for disabling or re-enabling generated item ids, and `onembcmi.lavaboots.debug` for PDC inspection. `onembcmi.lavaboots.admin` includes all LavaBoots admin nodes, but defaults to false so operator status alone does not receive it from plugin.yml defaults. Direct console can run the admin non-GUI commands.
526535

536+
Spawners grants `onembcmi.spawners.use` and `onembcmi.spawners.buy` to players by default so `/spawners` can open the shop and buy only the CMI spawner types their group already unlocks. The actual spawner gates are CMI permissions such as `cmi.placespawner.rabbit` and `cmi.dropspawner.rabbit`. `onembcmi.spawners.sell` and `onembcmi.spawners.pickaxe` default to true but their sections are disabled by config until the server owner enables them. Admin give, setup export, reload, and debug permissions default to false.
537+
527538
Upgrade is locked by default. Grant `onembcmi.upgrade.notify` to admins who should see join-time upgrade suggestions, `onembcmi.upgrade.gui` to admins who should open the pending review queue GUI, `onembcmi.upgrade.inspect` to admins who may review player eligibility, `onembcmi.upgrade.simulate` to admins who may use read-only group path and rankup simulation tools, and `onembcmi.upgrade.apply` only to admins trusted to run LuckPerms group changes. `onembcmi.upgrade.admin` includes all Upgrade permissions, but operator status alone does not receive it from plugin.yml defaults. Direct console can run the non-GUI management commands. Upgrade re-checks LuckPerms state before applying and preserves non-managed side groups such as donor, tester, developer, streamer, or notable parents.
528539

529540
SchedulerCheck is direct-console only and explicitly rejects RCON and in-game command senders. All declared permissions default to false for metadata/debug consistency. Direct server console can run the owner commands and see the complete help list. `onembcmi.schedulercheck.check`, `explain`, `export`, and `list` are read/report actions. `onembcmi.schedulercheck.set` can line-edit one CMI scheduler entry's `Enabled: true|false`, `onembcmi.schedulercheck.fix` can dry-run and apply validated scalar scheduler hotfixes, and `onembcmi.schedulercheck.create` can append simple new CMI scheduler entries, so keep the edit/create nodes owner-only even though the runtime command is direct-console only.

project-docs/docs/plugin-metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ id: afkshrine
1313
name: AFKShrine
1414
category: player-fun
1515
version: 1.0.0
16-
build: 394
16+
build: 395
1717
java-target: 25
1818
paper-target: 26.1.2
1919
jar-prefix: 1MB-CMIAPI
20-
jar-name: 1MB-CMIAPI-AFKShrine-v1.0.0-394-j25-26.1.2.jar
20+
jar-name: 1MB-CMIAPI-AFKShrine-v1.0.0-395-j25-26.1.2.jar
2121
repo: https://github.com/mrfdev/1MB-CMIAPI
2222
public-docs: https://docs.1moreblock.com
2323
dependencies: CMI, CMILib, 1MB-CMIAPI-LIB

0 commit comments

Comments
 (0)