Skip to content

Commit c67314e

Browse files
authored
Update README.md
1 parent 8eb06f5 commit c67314e

1 file changed

Lines changed: 12 additions & 25 deletions

File tree

README.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,19 @@ RareSpawns is a Spigot/Paper plugin that adds fully configurable, data‑driven
6565
## Highlights
6666

6767
- Data‑driven rare entity system (YAML) with spawn groups, weights, biome/time/weather filters.
68-
- Standalone custom items (loot, keys, utilities) with progression features (Soul Harvester).
68+
- Standalone custom items (loot, keys, utilities) with progression features ([Soul Harvester](https://github.com/Valorless/RareSpawnsLite/wiki/soulharvestercomponent)).
6969
- Upgrade chain system: attributes, enchantments, model data, lore/name, item model swaps, powers.
7070
- Player‑facing Soul Powers (runtime compiled Java) unlocked through item progression.
7171
- Ability system for rare entities (packaged + extensible runtime compilation).
7272
- Power Items (BREAK, REDSTONE, TROWEL) enabling block manipulation or placement mechanics.
73-
- Integration hooks: WorldGuard, GriefPrevention, mcMMO, Nexo / ItemsAdder / Oraxen (soft).
73+
- Integration: WorldGuard, GriefPrevention, mcMMO, Nexo / ItemsAdder / Oraxen (soft).
7474
- Lightweight Java API for detection, ID resolution, programmatic spawns, listings.
7575
- Opt‑out command for players who do not want rares spawning near them.
76-
- Minimal dependencies; only requires Java 17+ and a JDK if you use runtime compilation features.
76+
- Minimal dependencies; only requires Java 21+, a JDK if you use runtime compilation features, and [ValorlessUtils](https://github.com/Valorless/ValorlessUtils/releases).
7777

7878
---
7979

80-
## For Server Owners (Users)
80+
## For Server Owners & Players
8181

8282
### Feature Overview
8383

@@ -116,8 +116,8 @@ RareSpawns is a Spigot/Paper plugin that adds fully configurable, data‑driven
116116
| Command | Description | Permission |
117117
|---------|-------------|------------|
118118
| `/rarespawns reload` | Reload configuration & content (abilities/items/entities). | `rarespawns.reload` |
119-
| `/rarespawns item <id> [player|random]` | Give a custom item to self/other/random. | `rarespawns.item` |
120-
| `/rarespawns spawn <entityId> [player]` | Spawn a rare entity at self/target player. | `rarespawns.spawn` |
119+
| `/rarespawns item <id> [random]` | Give a custom item to self with fixed or random stats. | `rarespawns.item` |
120+
| `/rarespawns spawn <id> [player]` | Spawn a rare entity at self/target player. | `rarespawns.spawn` |
121121
| `/rarespawns kill <radius>` | Kill rares within radius around sender. | `rarespawns.kill` |
122122
| `/rarespawns optout` | Toggle rare spawn opt‑out. | `rarespawns.optout` |
123123

@@ -213,6 +213,7 @@ Players can run `/rarespawns optout` to toggle whether natural rare spawns consi
213213
## For Developers
214214

215215
### API Surface (Quick Reference)
216+
I recommend reading the [API Wiki](https://github.com/Valorless/RareSpawnsLite/wiki/API)
216217

217218
Static methods (see full docs at [API Docs](https://valorless.github.io/RareSpawns)):
218219

@@ -255,7 +256,7 @@ Synchronous Bukkit events you can listen to:
255256
- Implement interfaces (`Ability`, `SoulPower`) & annotate (`@AbilityInfo`, `@SoulPowerInfo`).
256257
- Place source in data folders (`abilities/` or `soulpowers/`) default package, no package line.
257258
- Requires JDK; server compiles them asynchronously on reload/start.
258-
- Soul Powers: triggers (`onAttack`, `onDefence`, `onKill`, `onEquip`) with chance, cooldown, failCooldown semantics.
259+
- Soul Powers: triggers (`onAttack`, `onDefence`, `onKill`) with chance, cooldown, failCooldown semantics.
259260

260261
### Item & Entity Data Model
261262

@@ -279,20 +280,6 @@ Synchronous Bukkit events you can listen to:
279280
- Wrap Soul Harvester progression for custom reward gating.
280281
- Introduce new runtime powers or abilities for dynamic effects (avoid blocking operations).
281282

282-
### Building from Source
283-
284-
Requires:
285-
- Java 17+ (JDK)
286-
- Maven
287-
288-
Steps:
289-
```bash
290-
git clone https://github.com/Valorless/RareSpawns.git
291-
cd RareSpawns
292-
mvn clean package
293-
```
294-
Resulting plugin JAR in `target/`.
295-
296283
### Contributing
297284

298285
Suggestions & issues welcome:
@@ -304,18 +291,18 @@ Suggestions & issues welcome:
304291

305292
- Native RareSpawns PlaceholderAPI placeholders.
306293
- Additional Soul Power triggers (onEquip refinement, onBlockPlace, onFish success).
307-
- Configurable minion AI profiles.
294+
- Configurable AI profiles.
308295
- Extended upgrade actions: particle trails, timed buffs, conditional triggers.
309-
- Web-based config viewer/export.
296+
- Web-based config viewer/export. (More like wishful thinking atm)
310297

311298
---
312299

313300
## License
314301

315-
License will be added / clarified (TBD). Until formal license is published, treat source as all-rights-reserved to the author; do not redistribute compiled builds without permission.
302+
License will be added / clarified (TBD). Until formal license is published, treat source as all-rights-reserved; do not redistribute compiled builds without permission.
316303

317304
---
318305

319-
For full documentation, examples, and integration guides visit the [Docs Site](https://valorless.github.io/RareSpawns). Feel free to open issues for feature requests or clarification.
306+
For full documentation, examples, and integration guides visit the [Docs Site](https://valorless.github.io/RareSpawns) & [Wiki Page](https://github.com/Valorless/RareSpawnsLite/wiki). Feel free to open issues for feature requests or clarification.
320307

321308
Enjoy crafting your world’s rare encounters!

0 commit comments

Comments
 (0)