Skip to content

Commit 903ec02

Browse files
committed
bump version to 1.5.3, update GUI interactions, and clean up documentation
1 parent 5e4a545 commit 903ec02

10 files changed

Lines changed: 41 additions & 62 deletions

File tree

NMS/v1_21/src/main/java/github/nighter/smartspawner/v1_21/TextureInitializer.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
import github.nighter.smartspawner.nms.TextureWrapper;
44
import org.bukkit.entity.EntityType;
55

6+
/**
7+
* This class is responsible for initializing version-specific textures
8+
* for various entity types in the SmartSpawner plugin.
9+
*/
610
public class TextureInitializer {
11+
12+
/**
13+
* Initializes version-specific textures for various entity types.
14+
* This method should be called during the plugin's initialization phase.
15+
*/
716
public static void init() {
817
TextureWrapper.addVersionSpecificTexture(
918
EntityType.ARMADILLO,

NMS/v1_21_4/src/main/java/github/nighter/smartspawner/v1_21_4/TextureInitializer.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
import github.nighter.smartspawner.nms.TextureWrapper;
44
import org.bukkit.entity.EntityType;
55

6+
/**
7+
* This class is responsible for initializing version-specific textures
8+
* for various entity types in the SmartSpawner plugin.
9+
*/
610
public class TextureInitializer {
11+
12+
/**
13+
* Initializes version-specific textures for various entity types.
14+
* This method should be called during the plugin's initialization phase.
15+
*/
716
public static void init() {
817
TextureWrapper.addVersionSpecificTexture(
918
EntityType.ARMADILLO,

NMS/v1_21_6/src/main/java/github/nighter/smartspawner/v1_21_6/TextureInitializer.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
import github.nighter.smartspawner.nms.TextureWrapper;
44
import org.bukkit.entity.EntityType;
55

6+
/**
7+
* This class is responsible for initializing version-specific textures
8+
* for various entity types in the SmartSpawner plugin.
9+
*/
610
public class TextureInitializer {
11+
12+
/**
13+
* Initializes version-specific textures for various entity types.
14+
* This method should be called during the plugin's initialization phase.
15+
*/
716
public static void init() {
817
TextureWrapper.addVersionSpecificTexture(
918
EntityType.ARMADILLO,

README.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@
66

77
<br>
88

9-
[![Release](https://img.shields.io/github/v/release/NighterDevelopment/smartspawner?logo=github&logoColor=white&label=release&labelColor=%230D597F&color=%23116BBF)](https://github.com/NighterDevelopment/smartspawner/releases/latest)
10-
[![Modrinth Downloads](https://img.shields.io/modrinth/dt/smart-spawner-plugin?logo=modrinth&logoColor=white&label=downloads&labelColor=%23139549&color=%2318c25f)](https://modrinth.com/plugin/smart-spawner-plugin)
11-
[![Spigot Downloads](https://img.shields.io/spiget/downloads/120743?logo=spigotmc&logoColor=white&label=spigot%20downloads&labelColor=%23ED8106&color=%23FF994C)](https://www.spigotmc.org/resources/smart-spawner-gui-spawner-plugin%E2%9C%A8-1-21-1-21-3-%EF%B8%8F.120743/)
12-
[![License](https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-brightgreen.svg)](LICENSE)
13-
149
[![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/smart-spawner-plugin)
1510
[![Spigot](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/spigot_vector.svg)](https://www.spigotmc.org/resources/120743/)
1611
[![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg)](https://hangar.papermc.io/Nighter/SmartSpawner)
@@ -22,43 +17,10 @@
2217

2318
## Requirements
2419

25-
- **Minecraft Version:** 1.20 - 1.21.8
20+
- **Minecraft Version:** 1.21 - 1.21.8
2621
- **Server Software:** Paper, Folia or compatible forks
2722
- **Java Version:** 21+
2823

29-
## Installation
30-
31-
1. Download the latest release from [Modrinth](https://modrinth.com/plugin/smart-spawner-plugin)
32-
2. Place the `.jar` file in your server's `plugins` folder
33-
3. Restart your server
34-
4. Configure the plugin in `plugins/SmartSpawner/config.yml`
35-
5. Reload with `/ss reload`
36-
37-
## Commands
38-
39-
| Command | Permission | Description |
40-
|---------|------------|-------------|
41-
| `/ss reload` | `smartspawner.reload` | Reload plugin configuration |
42-
| `/ss give <player> <type> <amount>` | `smartspawner.give` | Give spawners to players |
43-
| `/ss list` | `smartspawner.list` | Open admin spawner management GUI |
44-
| `/ss hologram` | `smartspawner.hologram` | Toggle hologram visibility |
45-
46-
**Aliases:** `/ss`, `/spawner`, `/smartspawner`
47-
48-
## Permissions
49-
50-
| Permission | Default | Description |
51-
|------------|---------|-------------|
52-
| `smartspawner.reload` | OP | Access to reload command |
53-
| `smartspawner.give` | OP | Access to give command |
54-
| `smartspawner.list` | OP | Access to admin GUI |
55-
| `smartspawner.hologram` | OP | Toggle hologram display |
56-
| `smartspawner.stack` | true | Allow spawner stacking |
57-
| `smartspawner.break` | true | Allow spawner breaking |
58-
| `smartspawner.sellall` | true | Allow selling storage items |
59-
| `smartspawner.changetype` | OP | Allow changing spawner types with eggs |
60-
| `smartspawner.limits.bypass` | false | Bypass spawner limits per chunk |
61-
6224
## Localization
6325

6426
| Language | Locale Code | Contributor | Status |
@@ -71,12 +33,12 @@
7133

7234
## API
7335

74-
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://github.com/ptthanh02/SmartSpawner/wiki/Developer-API-Documentation) for installation instructions and documentation.
36+
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://nighterdevelopment.github.io/smartspawner-docs/developer-api/) for installation instructions and documentation.
7537

7638
## Building
7739

7840
```bash
79-
git clone https://github.com/ptthanh02/SmartSpawner.git
41+
git clone https://github.com/NighterDevelopment/smartspawner.git
8042
cd SmartSpawner
8143
./gradlew build
8244
```
@@ -94,7 +56,7 @@ The compiled JAR will be available in `build/libs/`
9456

9557
## Support
9658

97-
- **Issues & Bug Reports:** [GitHub Issues](https://github.com/ptthanh02/SmartSprawner/issues)
59+
- **Issues & Bug Reports:** [GitHub Issues](https://github.com/NighterDevelopment/smartspawner/issues)
9860
- **Discord Community:** [Join our Discord](https://discord.gg/zrnyG4CuuT)
9961

10062
## Statistics

api/src/main/java/github/nighter/smartspawner/api/SmartSpawnerAPI.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
public interface SmartSpawnerAPI {
1111

1212
/**
13-
* Creates a spawner item with the specified entity type
13+
* Creates a SmartSpawner item with the specified entity type
1414
*
1515
* @param entityType The type of entity this spawner will spawn
1616
* @return An ItemStack representing the spawner
1717
*/
1818
ItemStack createSpawnerItem(EntityType entityType);
1919

2020
/**
21-
* Creates a spawner item with the specified entity type and a custom amount
21+
* Creates a SmartSpawner item with the specified entity type and a custom amount
2222
*
2323
* @param entityType The type of entity this spawner will spawn
2424
* @param amount The amount of the item stack
@@ -27,18 +27,18 @@ public interface SmartSpawnerAPI {
2727
ItemStack createSpawnerItem(EntityType entityType, int amount);
2828

2929
/**
30-
* Gets the entity type from a spawner item
30+
* Gets the entity type from a SmartSpawner item
3131
*
32-
* @param item The spawner item to check
33-
* @return The EntityType of the spawner, or null if the item is not a valid spawner
32+
* @param item The SmartSpawner item to check
33+
* @return The EntityType of the SmartSpawner, or null if the item is not a valid spawner
3434
*/
3535
EntityType getSpawnerEntityType(ItemStack item);
3636

3737
/**
3838
* Checks if an item is a valid spawner created by SmartSpawner
3939
*
4040
* @param item The item to check
41-
* @return true if the item is a valid spawner, false otherwise
41+
* @return true if the item is a valid SmartSpawner, false otherwise
4242
*/
4343
boolean isValidSpawner(ItemStack item);
4444
}

api/src/main/java/github/nighter/smartspawner/api/events/SpawnerBreakEvent.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import org.jetbrains.annotations.NotNull;
77

88
/**
9-
* SpawnerBreakEvent is called when a spawner being broke by a player or an explosion.
9+
* SpawnerBreakEvent is called when a spawner being broken by a player or an explosion.
1010
*/
1111
public class SpawnerBreakEvent extends SpawnerEvent {
1212
private final Entity entity;

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ allprojects {
99
apply plugin: 'maven-publish'
1010

1111
group = 'github.nighter'
12-
version = '1.5.2'
12+
version = '1.5.3'
1313

1414
repositories {
1515
mavenCentral()

core/src/main/resources/gui_layouts/DonutSMP/main_gui.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ buttons:
2323
condition: "shop_integration"
2424
actions:
2525
left_click: "sell_inventory" # Collect EXP and sell items in storage
26+
right_click: "sell_inventory" # Collect EXP and sell items in storage
2627

2728
# Spawner information display without shop integration
2829
# Without shop integration: Both clicks open stacker GUI

core/src/main/resources/mob_drops.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -335,18 +335,6 @@ MOOSHROOM:
335335
amount: 1-3
336336
chance: 100.0
337337

338-
# Reference: https://minecraft.wiki/w/Mooshroom#Drops
339-
# Legacy 1.20 fallback
340-
MUSHROOM_COW:
341-
experience: 1
342-
loot:
343-
LEATHER:
344-
amount: 0-2
345-
chance: 100.0
346-
BEEF:
347-
amount: 1-3
348-
chance: 100.0
349-
350338
# Reference: https://minecraft.wiki/w/Mule#Drops
351339
MULE:
352340
experience: 1

core/src/main/resources/spawners_data.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
# entityType: ENTITY_TYPE
77
# settings: exp,active,range,stop,delay,slots,maxExp,minMobs,maxMobs,stack,maxStack,time,atCapacity
88
# filteredItems: MATERIAL1,MATERIAL2,...
9+
# lastInteractedPlayer: PlayerName
910
# inventory:
1011
# - ITEM_TYPE:amount
1112

0 commit comments

Comments
 (0)