Skip to content

README.md

Latest commit

 

History

History
125 lines (92 loc) · 4.83 KB

README.md

File metadata and controls

125 lines (92 loc) · 4.83 KB

banner

Modrinth discord-plural

Requirements

  • Minecraft Version: 1.21+
  • Server Software: Paper, Folia or compatible forks
  • Java Version: 25+
  • Dependency: SmartSpawner 1.6.6+

Commands

Command Description Aliases
/ssaspawnerlimiter reload Reload plugin configuration /ssalimiter reload
/ssaspawnerlimiter info Check spawner count in current chunk /ssalimiter info
/ssaspawnerlimiter check <player> Check spawner limit for player's chunk /ssalimiter check <player>
/ssaspawnerlimiter checkplayer <player> Check player's global spawner count /ssalimiter checkplayer <player>
/ssaspawnerlimiter stats View plugin statistics /ssalimiter stats

Permissions

Bypass Permissions

Permission Description Default
ssaspawnerlimiter.bypass Bypass spawner chunk limit false
ssaspawnerlimiter.perplayer.bypass Bypass per-player spawner limit (unlimited) false

Per-Player Limit Tiers

You can create custom limit tiers using the permission pattern: ssaspawnerlimiter.perplayer.<number>

Examples:

  • ssaspawnerlimiter.perplayer.1500 → Allows 1500 spawners globally
  • ssaspawnerlimiter.perplayer.2000 → Allows 2000 spawners globally
  • ssaspawnerlimiter.perplayer.5000 → Allows 5000 spawners globally
  • ssaspawnerlimiter.perplayer.10000 → Allows 10000 spawners globally
  • Any number you want!

Note: Players with multiple tier permissions will get the highest value. Default limit is configured in config.yml as max_spawners_per_player.

Command Permissions

Permission Description Default
ssaspawnerlimiter.command.use Base permission for all commands op
ssaspawnerlimiter.command.reload Use reload command op
ssaspawnerlimiter.command.info Use info command op
ssaspawnerlimiter.command.check Use check command op
ssaspawnerlimiter.command.checkplayer Use checkplayer command op
ssaspawnerlimiter.command.stats Use stats command op

How It Works

SSASpawnerLimiter provides two independent limit systems:

Chunk-Based Limit

Limits spawner stacks per chunk to prevent chunk overloading:

  • 1 spawner block with 64 stacks = 64 count
  • 1 spawner block with 6 stacks = 6 count
  • Total in chunk: 70 count
  • Default: 100 spawners per chunk

Per-Player Limit

Limits total spawner stacks a player can place globally:

  • Tracks all spawners placed by each player across the entire server
  • Default: 1000 spawners per player
  • Can be increased via permission nodes (1500, 2000, 5000, etc.)
  • Bypass permission for unlimited spawners

Both systems can be enabled/disabled independently in config.yml:

enable_chunk_limit: true      # Enable chunk-based limiting
enable_player_limit: true     # Enable per-player limiting

Stack Counting Example

  • Player places 1 spawner with stack size 10 → Adds 10 to both chunk and player count
  • Player breaks that spawner → Removes 10 from both counts
  • Player stacks spawner from 10 to 20 → Adds 10 more to both counts
  • Counts never go below 0 (zero-floor protection)

This ensures fair limiting based on actual spawner capacity, not just physical blocks.

Database

The plugin uses SQLite to store spawner data in two tables:

  • spawner_chunks - Chunk spawner counts
  • player_spawners - Per-player spawner counts

SQLite Viewer - Free online tool to view and edit SQLite databases

Database location: plugins/SSASpawnerLimiter/spawner_limits.db

Building

git clone https://github.com/NighterDevelopment/SSASpawnerLimiter.git
cd SSASpawnerLimiter
./gradlew build

The compiled JAR will be available in build/libs/

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes and test thoroughly
  4. Commit your changes (git commit -m 'Add amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Submit a pull request

Support

License

This project is licensed under the GPLv3 License - see the LICENSE file for details.