Wiki https://github.com/whome09/RayClean
version: [1.13+]
RayClean Plugin Wiki
Plugin Overview
RayClean is a powerful Minecraft server item cleanup plugin designed for Spigot/Paper servers. It provides multiple cleanup modes including automatic cleanup, manual cleanup, and radius cleanup, effectively reducing server lag caused by dropped items.
Compatibility
Core Functions
Installation Steps
plugins/
├── RayClean-1.0.0.jar
└── RayClean/
└── config.yml
Command List
Basic Commands
Command Aliases Description Permission
/rayclean /rc, /rclean Show help info rayclean.use
/rayclean help - Show command help rayclean.use
Cleanup Commands
Command Description Permission Example
/rayclean clean Clean dropped items in all worlds rayclean.use /rc clean
/rayclean clean [world_name] Clean dropped items in specific world rayclean.use /rc clean world
/rayclean clean all Clean dropped items in all worlds rayclean.use /rc clean all
/rayclean radius <radius> Clean items within specified radius rayclean.use /rc radius 20
Admin Commands
Command Description Permission Example
/rayclean auto [on/off] Enable/disable auto cleanup rayclean.admin /rc auto on
/rayclean countdown [on/off] Enable/disable countdown rayclean.admin /rc countdown off
/rayclean reload Reload plugin configuration rayclean.admin /rc reload
Permission System
Permission Nodes
Permission Description Default
rayclean.* All permissions OP
rayclean.use Basic functions OP
rayclean.admin Admin functions OP
Permission Group Configuration Examples
LuckPerms Configuration:
/lp group moderator permission set rayclean.use true
/lp group admin permission set rayclean.admin true
PermissionsEx Configuration:
groups:
moderator:
permissions:
- rayclean.use
admin:
permissions:
- rayclean.admin
⚙️ Configuration File
Auto Cleanup Settings
auto-clean:
# Enable auto cleanup
enabled: true
# Cleanup interval (seconds)
interval: 300
# Countdown time (seconds)
countdown: 60
# Warning reminder time points
warnings: [60, 30, 10, 5, 3, 2, 1]
# Enabled worlds (empty list means all worlds)
worlds: []
Countdown Display Settings
countdown-display:
# Enable countdown display
enabled: true
# Display type: TITLE, ACTIONBAR, or BOTH
type: ACTIONBAR
# Title settings
title:
text: "&c&lCleanup Countdown"
subtitle: "&eCleanup in {time} seconds"
fade-in: 10 # Fade in time (ticks)
stay: 40 # Stay time (ticks)
fade-out: 10 # Fade out time (ticks)
# Actionbar settings
actionbar:
text: "&c&lWarning: &eCleanup in {time} &cseconds!"
Whitelist Settings
# Whitelist (items that won't be cleaned)
whitelist:
- DIAMOND # Diamond
- EMERALD # Emerald
- NETHERITE_INGOT # Netherite Ingot
- ENCHANTED_BOOK # Enchanted Book
- GOLDEN_APPLE # Golden Apple
- ELYTRA # Elytra
- SHULKER_BOX # Shulker Box
# ... more items
Drop Prevention Settings
prevent-drops:
# Enable drop prevention
enabled: false
# Blacklist (these items won't drop)
blacklist:
- COBBLESTONE # Cobblestone
- DIRT # Dirt
- GRAVEL # Gravel
- SAND # Sand
- NETHERRACK # Netherrack
Message Customization
messages:
# Basic messages
no-permission: "&cYou don't have permission to use this command!"
config-reloaded: "&aConfiguration reloaded!"
# Cleanup related messages
clean-broadcast: "&a[RayClean] &eCleaned &b{count} &edropped items!"
clean-warning: "&e[RayClean] &cWarning: &eCleanup in &c{time} &eseconds!"
auto-clean-complete: "&a[RayClean] &eAuto cleanup complete! Cleaned &b{count} &eitems!"
# Status messages
auto-clean-enabled: "&a[RayClean] &eAuto cleanup &aenabled&e!"
auto-clean-disabled: "&c[RayClean] &eAuto cleanup &cdisabled&e!"
Usage Tutorial
Quick Start
Manually clean all dropped items:
/rayclean clean
Clean items within 30 blocks around player:
/rayclean radius 30
Check auto cleanup status:
/rayclean auto
Advanced Configuration
Set custom cleanup interval:
auto-clean:
interval: 600 # Change to 10 minutes
countdown: 30 # 30 second countdown
Enable only in specific worlds:
auto-clean:
worlds:
- world # Overworld
- world_nether # Nether
Add custom whitelist items:
whitelist:
- DIAMOND_SWORD # Diamond Sword
- DIAMOND_PICKAXE # Diamond Pickaxe
- CUSTOM_ITEM # Custom Item
Admin Operations
Temporarily disable auto cleanup:
/rayclean auto off
Reload configuration file:
/rayclean reload
Disable countdown display:
/rayclean countdown off
❓ Frequently Asked Questions
Installation and Configuration
Q: Plugin doesn't work after installation? A: Please check:
Q: Whitelist items are still being cleaned? A: Please confirm:
Q: Countdown display doesn't show? A: Please check:
prevent-drops:
enabled: true
blacklist:
- COBBLESTONE
Q: Radius cleanup command shows "Players only"? A: This command can only be executed by players in-game, not from console.
Performance and Compatibility
Q: Will the plugin affect server performance? A: RayClean is optimized with minimal performance impact. Proper cleanup actually improves server performance.
Q: Is it compatible with other plugins? A: RayClean is compatible with most plugins. Contact the developer if conflicts occur.
Support and Feedback
If you encounter issues or have suggestions during use, feel free to:
version: [1.13+]
RayClean Plugin Wiki
Plugin Overview
RayClean is a powerful Minecraft server item cleanup plugin designed for Spigot/Paper servers. It provides multiple cleanup modes including automatic cleanup, manual cleanup, and radius cleanup, effectively reducing server lag caused by dropped items.
Compatibility
- Minecraft Version: 1.13+
- Server: Spigot, Paper
Core Functions
- Auto Cleanup: Automatically clean dropped items on schedule
- Manual Cleanup: Administrators can manually execute cleanup
- Radius Cleanup: Clean items within specified range around players
- World Cleanup: Target specific worlds for cleanup
- Countdown Alerts: Countdown warnings before cleanup
- Multiple Display Types: Support for title and actionbar display
- Whitelist Protection: Protect important items from being cleaned
- Blacklist Prevention: Prevent specific items from dropping
- Config Hot Reload: Reload configuration without restart
- Multi-World Support: Configurable to enable only in specific worlds
- Permission Management: Fine-grained permission control system
- Custom Messages: Fully customizable message system
Installation Steps
- Download Plugin: Download the RayClean-1.0.0.jar file
- Place File: Put the JAR file in your server's plugins/ directory
- Restart Server: Restart the server to load the plugin
- Configure Plugin: Edit the generated configuration file (optional)
plugins/
├── RayClean-1.0.0.jar
└── RayClean/
└── config.yml
Command List
Basic Commands
Command Aliases Description Permission
/rayclean /rc, /rclean Show help info rayclean.use
/rayclean help - Show command help rayclean.use
Cleanup Commands
Command Description Permission Example
/rayclean clean Clean dropped items in all worlds rayclean.use /rc clean
/rayclean clean [world_name] Clean dropped items in specific world rayclean.use /rc clean world
/rayclean clean all Clean dropped items in all worlds rayclean.use /rc clean all
/rayclean radius <radius> Clean items within specified radius rayclean.use /rc radius 20
Admin Commands
Command Description Permission Example
/rayclean auto [on/off] Enable/disable auto cleanup rayclean.admin /rc auto on
/rayclean countdown [on/off] Enable/disable countdown rayclean.admin /rc countdown off
/rayclean reload Reload plugin configuration rayclean.admin /rc reload
Permission System
Permission Nodes
Permission Description Default
rayclean.* All permissions OP
rayclean.use Basic functions OP
rayclean.admin Admin functions OP
Permission Group Configuration Examples
LuckPerms Configuration:
/lp group moderator permission set rayclean.use true
/lp group admin permission set rayclean.admin true
PermissionsEx Configuration:
groups:
moderator:
permissions:
- rayclean.use
admin:
permissions:
- rayclean.admin
⚙️ Configuration File
Auto Cleanup Settings
auto-clean:
# Enable auto cleanup
enabled: true
# Cleanup interval (seconds)
interval: 300
# Countdown time (seconds)
countdown: 60
# Warning reminder time points
warnings: [60, 30, 10, 5, 3, 2, 1]
# Enabled worlds (empty list means all worlds)
worlds: []
Countdown Display Settings
countdown-display:
# Enable countdown display
enabled: true
# Display type: TITLE, ACTIONBAR, or BOTH
type: ACTIONBAR
# Title settings
title:
text: "&c&lCleanup Countdown"
subtitle: "&eCleanup in {time} seconds"
fade-in: 10 # Fade in time (ticks)
stay: 40 # Stay time (ticks)
fade-out: 10 # Fade out time (ticks)
# Actionbar settings
actionbar:
text: "&c&lWarning: &eCleanup in {time} &cseconds!"
Whitelist Settings
# Whitelist (items that won't be cleaned)
whitelist:
- DIAMOND # Diamond
- EMERALD # Emerald
- NETHERITE_INGOT # Netherite Ingot
- ENCHANTED_BOOK # Enchanted Book
- GOLDEN_APPLE # Golden Apple
- ELYTRA # Elytra
- SHULKER_BOX # Shulker Box
# ... more items
Drop Prevention Settings
prevent-drops:
# Enable drop prevention
enabled: false
# Blacklist (these items won't drop)
blacklist:
- COBBLESTONE # Cobblestone
- DIRT # Dirt
- GRAVEL # Gravel
- SAND # Sand
- NETHERRACK # Netherrack
Message Customization
messages:
# Basic messages
no-permission: "&cYou don't have permission to use this command!"
config-reloaded: "&aConfiguration reloaded!"
# Cleanup related messages
clean-broadcast: "&a[RayClean] &eCleaned &b{count} &edropped items!"
clean-warning: "&e[RayClean] &cWarning: &eCleanup in &c{time} &eseconds!"
auto-clean-complete: "&a[RayClean] &eAuto cleanup complete! Cleaned &b{count} &eitems!"
# Status messages
auto-clean-enabled: "&a[RayClean] &eAuto cleanup &aenabled&e!"
auto-clean-disabled: "&c[RayClean] &eAuto cleanup &cdisabled&e!"
Usage Tutorial
Quick Start
- After installing the plugin, the server will automatically generate default configuration
- By default, auto cleanup runs every 5 minutes
- 60 seconds before cleanup, countdown reminders begin
- Important items (diamonds, emeralds, etc.) won't be cleaned
Manually clean all dropped items:
/rayclean clean
Clean items within 30 blocks around player:
/rayclean radius 30
Check auto cleanup status:
/rayclean auto
Advanced Configuration
Set custom cleanup interval:
auto-clean:
interval: 600 # Change to 10 minutes
countdown: 30 # 30 second countdown
Enable only in specific worlds:
auto-clean:
worlds:
- world # Overworld
- world_nether # Nether
Add custom whitelist items:
whitelist:
- DIAMOND_SWORD # Diamond Sword
- DIAMOND_PICKAXE # Diamond Pickaxe
- CUSTOM_ITEM # Custom Item
Admin Operations
Temporarily disable auto cleanup:
/rayclean auto off
Reload configuration file:
/rayclean reload
Disable countdown display:
/rayclean countdown off
❓ Frequently Asked Questions
Installation and Configuration
Q: Plugin doesn't work after installation? A: Please check:
- Server version is 1.13+
- Server has been restarted
- No error messages in console
Q: Whitelist items are still being cleaned? A: Please confirm:
- Item names are correct (use Minecraft material IDs)
- Configuration file format is correct
- /rayclean reload has been executed
Q: Countdown display doesn't show? A: Please check:
- countdown-display.enabled is set to true
- Display type setting is correct
- Server supports Title/ActionBar API
prevent-drops:
enabled: true
blacklist:
- COBBLESTONE
Q: Radius cleanup command shows "Players only"? A: This command can only be executed by players in-game, not from console.
Performance and Compatibility
Q: Will the plugin affect server performance? A: RayClean is optimized with minimal performance impact. Proper cleanup actually improves server performance.
Q: Is it compatible with other plugins? A: RayClean is compatible with most plugins. Contact the developer if conflicts occur.
Support and Feedback
If you encounter issues or have suggestions during use, feel free to:
- Contact the developer
- Report bugs
- Suggest new features
Resource Information
Author:
----------
Total Downloads:
18
First Release:
Aug 5, 2025
Last Update:
Aug 5, 2025
Category:
---------------
All-Time Rating:
0 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings