diff --git a/docs/Admin-Guide.md b/docs/Admin-Guide.md deleted file mode 100644 index f506182..0000000 --- a/docs/Admin-Guide.md +++ /dev/null @@ -1,164 +0,0 @@ -# Admin Guide - -The Admin Menu provides server operators with administrative controls and diagnostic information for RS-MobStand. - -This menu is intended for server staff and administrators. - ---- - -# Accessing the Admin Menu - -The Admin button appears within the Main Menu for authorized users. - -Open: - -```text id="u56k0l" -Main Menu - ↓ -Admin -``` - -to access administrative functions. - ---- - -# Administrative Features - -Depending on your server configuration and plugin version, the Admin Menu may contain various management and diagnostic tools. - ---- - -# Reload Configuration - -The Reload Configuration option allows administrators to reload the plugin configuration without restarting the server. - -This is useful when: - -* Adjusting plugin settings -* Testing configuration changes -* Applying updates to configuration files - -### When To Use Reload - -After editing: - -```text id="k7y2gj" -config.yml -``` - -you can reload the plugin to apply changes immediately. - ---- - -# Plugin Version Information - -The Admin Menu displays plugin version information. - -Information may include: - -* Installed Version -* Latest Available Version -* Update Status - -Possible status values: - -```text id="4m7j1f" -Up To Date -``` - -The installed version matches the latest available version. - -```text id="awpjol" -Update Available -``` - -A newer version is available. - -```text id="hrsd1g" -Unable To Check -``` - -The plugin could not reach the update source. - -This may occur when: - -* Internet access is unavailable -* The update source is inaccessible -* The repository is private - ---- - -# Ownership Bypass - -Administrators may bypass normal ownership restrictions. - -This allows staff to: - -* Inspect Mob Stands -* Modify configurations -* Troubleshoot player issues - -without needing ownership of the Mob Stand. - ---- - -# Troubleshooting Player Issues - -When assisting players: - -### Verify Ownership - -Ensure the player owns the Mob Stand or has appropriate permissions. - -### Verify Filters - -Incorrect filter settings are a common cause of unexpected behavior. - -### Verify Radius - -Confirm the Mob Stand is scanning the intended area. - -### Verify Pause Status - -A paused Mob Stand will not process mobs. - ---- - -# Best Practices - -### Reload Sparingly - -Frequent reloads are generally unnecessary. - -### Test Configuration Changes - -Verify changes on a test stand before making server-wide adjustments. - -### Keep Backups - -Maintain backups of configuration files before making major changes. - -### Monitor Updates - -Review plugin updates periodically for bug fixes and new features. - ---- - -# Security - -Administrative access should only be granted to trusted staff members. - -Administrative permissions may allow: - -* Bypassing ownership protection -* Accessing administrative controls -* Modifying player Mob Stands - ---- - -# Related Pages - -* Permissions -* Troubleshooting -* Main Menu -* Installation diff --git a/docs/Changelog.md b/docs/Changelog.md deleted file mode 100644 index 291e016..0000000 --- a/docs/Changelog.md +++ /dev/null @@ -1,56 +0,0 @@ -# Changelog - -All notable changes to RS-MobStand will be documented here. - ---- - -# Unreleased - -## Documentation - -* GitHub repository created -* Wiki created -* Installation guide added -* Player documentation added -* Administrative documentation added - ---- - -# Version 1.0.4 - -## Version Management - -* Migrated to Maven-based version management -* Implemented single source of truth using pom.xml -* Removed version.txt dependency -* Added GitHub version checking - -## Administrative Improvements - -* Added improved version status display -* Added update availability detection -* Added "Unable To Check" status handling - -## Stability - -* Verified multiplayer menu isolation -* Confirmed per-player menu tracking -* Confirmed ownership protection behavior - -## Documentation - -* Added README improvements -* Added GitHub Wiki -* Added installation and support documentation - ---- - -# Future - -Planned ecosystem integrations: - -* RS-ItemMagnet -* RS-Auger -* RS-Warehouse - -Additional features and improvements will be documented as development continues. diff --git a/docs/Creating-Your-First-MobStand.md b/docs/Creating-Your-First-MobStand.md deleted file mode 100644 index a5baebd..0000000 --- a/docs/Creating-Your-First-MobStand.md +++ /dev/null @@ -1,89 +0,0 @@ -# Creating Your First Mob Stand - -This guide will walk you through converting an ordinary Armor Stand into a fully functional Mob Stand. - ---- - -# Requirements - -Before creating a Mob Stand, ensure you have: - -* An Armor Stand -* A Stick -* Permission to use RS-MobStand - ---- - -# Step 1: Place an Armor Stand - -Place an Armor Stand where you want your Mob Stand to operate. - -Choose a location that is close to the mobs you want to manage. - ---- - -# Step 2: Convert the Armor Stand - -Hold a **Stick** in your hand. - -Sneak and right-click the Armor Stand. - -The Armor Stand will immediately convert into a Mob Stand. - -Once converted: - -* The Armor Stand becomes a Mob Stand. -* Ownership is assigned to the player who performed the conversion. -* The Mob Stand is ready to be configured. - ---- - -# Step 3: Open the Mob Stand Menu - -Right-click your Mob Stand to open the main configuration menu. - -From this menu you can configure: - -* Scan Radius -* Leave Alive -* Adult Filters -* Baby Filters -* Gravity -* Pause / Resume - ---- - -# Ownership - -Mob Stands are owned by the player who creates them. - -By default: - -* Owners can modify their own Mob Stands. -* Other players cannot change settings. -* Administrators may bypass ownership restrictions. - ---- - -# Converting Back to an Armor Stand - -If you no longer need a Mob Stand: - -1. Open the Mob Stand menu. -2. Select **Convert Back to Armor Stand**. - -The Mob Stand will immediately return to a normal Armor Stand. - ---- - -# Next Steps - -Now that your Mob Stand has been created, continue with: - -* Main Menu -* Radius Settings -* Leave Alive Settings -* Filters -* Pause and Resume - -These guides explain how each setting affects Mob Stand behavior. diff --git a/docs/FAQ.md b/docs/FAQ.md deleted file mode 100644 index 9ca795d..0000000 --- a/docs/FAQ.md +++ /dev/null @@ -1,126 +0,0 @@ -# Frequently Asked Questions - ---- - -## How do I create a Mob Stand? - -Place an Armor Stand. - -Sneak and right-click it while holding a Stick. - -The Armor Stand will immediately convert into a Mob Stand. - ---- - -## Can other players modify my Mob Stand? - -No. - -Only the owner can modify a Mob Stand unless a player has administrative permissions. - ---- - -## How do I remove a Mob Stand? - -Open the Main Menu and select: - -```text id="y2jlwm" -Convert Back to Armor Stand -``` - -The Mob Stand will immediately return to a normal Armor Stand. - ---- - -## Do Mob Stands survive server restarts? - -Yes. - -All Mob Stand settings are saved automatically. - ---- - -## Can I have multiple Mob Stands? - -Yes. - -Players may create as many Mob Stands as allowed by server rules and performance considerations. - ---- - -## Why is my Mob Stand not processing mobs? - -Check: - -* Pause Status -* Radius Settings -* Adult Filters -* Baby Filters -* Leave Alive Settings - -See the Troubleshooting guide for detailed assistance. - ---- - -## What does Leave Alive do? - -Leave Alive determines how many matching mobs remain alive. - -Example: - -```text id="0g7vqf" -Leave Alive: 5 -``` - -Five matching mobs will always remain. - ---- - -## What does Gravity do? - -Gravity determines whether the Mob Stand behaves like a normal Armor Stand. - -Enabled: - -```text id="pnnc4e" -Falls normally -``` - -Disabled: - -```text id="70x2p4" -Remains fixed in place -``` - ---- - -## Can administrators bypass ownership? - -Yes. - -Players with: - -```text id="x2tq67" -rsmobstand.admin -``` - -may bypass ownership restrictions. - ---- - -## Does RS-MobStand require any dependencies? - -No. - -RS-MobStand operates independently and does not require additional plugins. - ---- - -## Where can I get support? - -Review: - -* Troubleshooting -* Admin Guide - -If additional help is needed, open an issue on GitHub. diff --git a/docs/Filters.md b/docs/Filters.md deleted file mode 100644 index fca9f9f..0000000 --- a/docs/Filters.md +++ /dev/null @@ -1,191 +0,0 @@ -# Filters - -Filters determine which mobs a Mob Stand will manage. - -Using filters allows you to target specific mob types while ignoring others. - -Each Mob Stand maintains separate filter lists for: - -* Adult Mobs -* Baby Mobs - -This provides precise control over farm behavior and mob management. - ---- - -# Adult Filters - -Adult Filters control which adult mobs may be processed. - -Only enabled adult mob types are considered by the Mob Stand. - -Example: - -```text id="6kiz54" -Cow ✓ Enabled -Pig ✓ Enabled -Chicken ✗ Disabled -``` - -Result: - -```text id="mgj55p" -Cows and Pigs may be processed. -Chickens are ignored. -``` - ---- - -# Baby Filters - -Baby Filters control which baby mobs may be processed. - -This allows baby mobs to be treated differently from adults. - -Example: - -```text id="gqz7ir" -Baby Cow ✗ Disabled -Adult Cow ✓ Enabled -``` - -Result: - -```text id="8jlwmr" -Adult cows may be processed. -Baby cows are ignored. -``` - -This is particularly useful for breeding operations. - ---- - -# Why Use Filters? - -Filters provide flexibility and precision. - -Common uses include: - -* Separating breeding stock -* Managing specific farm animals -* Protecting decorative mobs -* Controlling resource production -* Supporting specialized farm layouts - ---- - -# Opening Filters - -Open: - -```text id="ybxbik" -Main Menu - ↓ -Adult Filters -``` - -or - -```text id="7p2qcz" -Main Menu - ↓ -Baby Filters -``` - -to access the desired filter menu. - ---- - -# Enabling a Filter - -When a mob filter is enabled: - -```text id="0rmr5g" -Enabled -``` - -the Mob Stand is allowed to manage that mob type. - ---- - -# Disabling a Filter - -When a mob filter is disabled: - -```text id="v6knu8" -Disabled -``` - -the Mob Stand completely ignores that mob type. - ---- - -# Example Farm Setup - -### Breeding Farm - -Adult Filters: - -```text id="16mubg" -Cow ✓ -Pig ✓ -``` - -Baby Filters: - -```text id="w1cgrh" -Cow ✗ -Pig ✗ -``` - -Result: - -```text id="ikccfc" -Adults may be managed. -Babies are protected until they mature. -``` - ---- - -### Single Species Farm - -Adult Filters: - -```text id="akd7zm" -Cow ✓ -Pig ✗ -Chicken ✗ -Sheep ✗ -``` - -Result: - -```text id="5of87d" -Only cows are managed. -``` - ---- - -# Tips - -### Use Leave Alive Together With Filters - -Combining filters with Leave Alive settings provides maximum control. - -### Separate Different Farms - -Use filters to prevent one Mob Stand from affecting unrelated mobs. - -### Protect Breeding Stock - -Disable baby filters when maintaining breeding populations. - ---- - -# Related Pages - -* Main Menu -* Radius Settings -* Leave Alive Settings -* Gravity Settings -* Pause and Resume diff --git a/docs/Gravity-Settings.md b/docs/Gravity-Settings.md deleted file mode 100644 index 48535d1..0000000 --- a/docs/Gravity-Settings.md +++ /dev/null @@ -1,109 +0,0 @@ -# Gravity Settings - -The Gravity setting controls whether a Mob Stand is affected by Minecraft's normal gravity mechanics. - -This allows players to create both grounded and floating Mob Stand designs. - ---- - -# What Gravity Does - -When gravity is enabled, the Mob Stand behaves like a normal Armor Stand and will fall if there is no supporting block beneath it. - -When gravity is disabled, the Mob Stand remains fixed in place. - ---- - -# Gravity Enabled - -With gravity enabled: - -```text -Gravity: Enabled -``` - -The Mob Stand will: - -* Fall when unsupported -* React to normal Minecraft physics -* Behave like a standard Armor Stand - -This is useful when you want the Mob Stand to remain part of a physical structure. - ---- - -# Gravity Disabled - -With gravity disabled: - -```text -Gravity: Disabled -``` - -The Mob Stand will: - -* Remain suspended in place -* Ignore normal falling behavior -* Stay exactly where it was positioned - -This is useful for: - -* Floating displays -* Decorative installations -* Elevated farm layouts -* Difficult-to-reach locations - ---- - -# Changing Gravity - -Open: - -```text -Main Menu - ↓ -Gravity -``` - -Click the Gravity option to toggle between enabled and disabled states. - -The change takes effect immediately. - ---- - -# Visual Indicator - -The Gravity button displays the current state. - -### Enabled - -The button appears active and indicates that gravity is currently enabled. - -### Disabled - -The button indicates that gravity is currently disabled. - ---- - -# Tips - -### Floating Farm Designs - -Disable gravity to keep Mob Stands suspended in midair. - -### Ground-Based Farms - -Enable gravity if you want the Mob Stand to behave like a normal Armor Stand. - -### Building Adjustments - -You can temporarily disable gravity while positioning a Mob Stand, then re-enable it afterward if desired. - ---- - -# Related Pages - -* Main Menu -* Radius Settings -* Leave Alive Settings -* Filters diff --git a/docs/Home.md b/docs/Home.md deleted file mode 100644 index 11e1482..0000000 --- a/docs/Home.md +++ /dev/null @@ -1,128 +0,0 @@ -# RS-MobStand Wiki - -Welcome to the official RS-MobStand documentation. - -RS-MobStand transforms ordinary Armor Stands into configurable Mob Stands capable of managing nearby mobs through an intuitive graphical interface. - -Designed for survival servers, RS-MobStand provides a lightweight and configurable alternative to traditional mob farm systems while maintaining excellent server performance. - ---- - -# Features - -### Mob Stand Conversion - -Convert ordinary Armor Stands into fully functional Mob Stands. - -### Radius Control - -Configure how far each Mob Stand scans for mobs. - -### Leave Alive Support - -Specify how many mobs remain alive while processing continues. - -### Adult Filters - -Control which adult mobs are managed by a Mob Stand. - -### Baby Filters - -Control which baby mobs are managed by a Mob Stand. - -### Gravity Toggle - -Enable or disable gravity for individual Mob Stands. - -### Pause / Resume - -Temporarily disable Mob Stand processing without removing the stand. - -### Ownership Protection - -Only the owner (or an administrator) can modify a Mob Stand. - -### Persistent Storage - -All Mob Stand settings survive server restarts. - -### Administrative Controls - -Built-in administrative tools for server operators. - ---- - -# Getting Started - -1. Place an Armor Stand. -2. Sneak and right-click the Armor Stand while holding a Stick. -3. Convert the Armor Stand into a Mob Stand. -4. Configure the stand using the menu system. -5. Begin managing nearby mobs. - ---- - -# Wiki Navigation - -## Player Guides - -* Creating Your First Mob Stand -* Main Menu -* Radius Settings -* Leave Alive Settings -* Gravity Settings -* Filters -* Pause and Resume - -## Administration - -* Installation -* Permissions -* Admin Guide -* Troubleshooting -* Changelog - ---- - -# RS Ecosystem - -RS-MobStand is part of the RS Ecosystem. - -```text -Generate - │ - ▼ -RS-MobStand - │ -Collect - ▼ -RS-ItemMagnet - │ -Transport - ▼ -RS-Auger - │ -Store - ▼ -RS-Warehouse -``` - -Together these plugins create a complete automated resource collection and logistics system. - ---- - -# Support - -If you encounter an issue: - -1. Verify your plugin version. -2. Check the Troubleshooting page. -3. Gather any console errors. -4. Open a GitHub issue if necessary. - ---- - -# License - -MIT License -Copyright © 2026 RSScripting diff --git a/docs/Installation.md b/docs/Installation.md deleted file mode 100644 index 0aaee2f..0000000 --- a/docs/Installation.md +++ /dev/null @@ -1,107 +0,0 @@ -# Installation - -This guide explains how to install RS-MobStand on your Minecraft server. - ---- - -# Requirements - -RS-MobStand requires: - -* Minecraft 1.21+ -* Paper Server -* Java 21 or newer - ---- - -# Download - -Download the latest RS-MobStand release from the official GitHub repository. - ---- - -# Installation Steps - -## Step 1 - -Stop your server. - ---- - -## Step 2 - -Place: - -```text id="xx4q8l" -RS-MobStand-x.x.x.jar -``` - -into your server's: - -```text id="hbg7va" -plugins -``` - -folder. - ---- - -## Step 3 - -Start the server. - -RS-MobStand will automatically generate its configuration files. - ---- - -## Step 4 - -Verify the plugin loads successfully. - -You should see startup messages indicating RS-MobStand has been enabled. - ---- - -## Step 5 - -Configure settings if desired. - -Any configuration changes can be applied using: - -```text id="f9icq7" -Admin Menu - ↓ -Reload Config -``` - -or by restarting the server. - ---- - -# Updating - -To update: - -1. Stop the server. -2. Replace the existing jar. -3. Start the server. - -Your Mob Stand data and configuration will remain intact. - ---- - -# Verifying Installation - -Create a test Armor Stand. - -Sneak and right-click it while holding a Stick. - -If the Armor Stand converts successfully, the installation is complete. - ---- - -# Related Pages - -* Creating Your First Mob Stand -* Permissions -* Troubleshooting diff --git a/docs/Leave-Alive-Settings.md b/docs/Leave-Alive-Settings.md deleted file mode 100644 index a676a17..0000000 --- a/docs/Leave-Alive-Settings.md +++ /dev/null @@ -1,134 +0,0 @@ -# Leave Alive Settings - -The Leave Alive setting determines how many matching mobs should remain alive within a Mob Stand's operating area. - -This allows players to automate mob management while still maintaining a breeding population, display mobs, or farm infrastructure. - ---- - -# What Leave Alive Does - -When a Mob Stand processes matching mobs, it will stop once the configured number of mobs remains. - -Example: - -```text -Leave Alive: 5 -``` - -Current matching mobs: - -```text -15 Cows -``` - -Result: - -```text -10 Cows Processed -5 Cows Remain Alive -``` - ---- - -# Why Use Leave Alive? - -Leave Alive gives you greater control over your farms. - -Common uses include: - -* Maintaining breeding stock -* Preventing complete farm depletion -* Keeping decorative mobs alive -* Controlling resource production rates - ---- - -# Setting Leave Alive - -Open: - -```text -Main Menu - ↓ -Leave Alive -``` - -Adjust the value to the desired amount. - -The Mob Stand will automatically respect this limit during operation. - ---- - -# Example Configurations - -## Leave Alive: 0 - -```text -All matching mobs may be processed. -``` - -Best for: - -* Resource-only farms -* Maximum production - ---- - -## Leave Alive: 2 - -```text -Always leave two matching mobs alive. -``` - -Best for: - -* Basic breeding farms -* Simple population maintenance - ---- - -## Leave Alive: 10 - -```text -Maintain a larger breeding population. -``` - -Best for: - -* Large animal farms -* Decorative enclosures -* High-growth breeding systems - ---- - -# Tips - -### Breeding Farms - -A Leave Alive value of 2 or more is recommended. - -### Decorative Areas - -Use a higher Leave Alive value to maintain the desired appearance. - -### Resource Farms - -Use a lower value if maximum production is the goal. - ---- - -# Important Notes - -Leave Alive only applies to mobs that match the current filter settings. - -If a mob is not included in the filters, it is ignored entirely by the Mob Stand. - ---- - -# Related Pages - -* Main Menu -* Radius Settings -* Filters -* Pause and Resume diff --git a/docs/Main-Menu.md b/docs/Main-Menu.md deleted file mode 100644 index f753587..0000000 --- a/docs/Main-Menu.md +++ /dev/null @@ -1,121 +0,0 @@ -# Main Menu - -The Main Menu is the central control panel for your Mob Stand. - -To open it, simply right-click your Mob Stand. - -From here you can access all configuration options available to the stand. - ---- - -# Main Menu Options - -## Convert Back to Armor Stand - -Returns the Mob Stand to a normal Armor Stand. - -Use this option if you no longer need automated mob management. - -**Warning:** Any Mob Stand configuration will be removed. - ---- - -## Admin Menu - -**Operators Only** - -Provides access to administrative tools and plugin information. - -This option is only visible to server operators and administrators. - ---- - -## Pause / Resume Processing - -Temporarily enables or disables Mob Stand processing. - -### When Enabled - -The Mob Stand will continue managing nearby mobs normally. - -### When Disabled - -The Mob Stand remains configured but will not process mobs until re-enabled. - ---- - -## Scan Radius - -Controls how far the Mob Stand searches for nearby mobs. - -Larger radii cover more area but may process additional mobs. - -Select this option to open the Radius Settings menu. - ---- - -## Gravity - -Controls whether the Mob Stand is affected by gravity. - -### Enabled - -The Mob Stand behaves like a normal Armor Stand and can fall. - -### Disabled - -The Mob Stand remains fixed in place. - ---- - -## Leave Alive - -Determines how many matching mobs should remain alive. - -Example: - -```text -Leave Alive: 5 -``` - -If ten matching mobs are present, the Mob Stand will only process five and leave five alive. - -Select this option to open the Leave Alive Settings menu. - ---- - -## Adult Filters - -Configure which adult mobs are managed by this Mob Stand. - -Only enabled adult mob types will be processed. - -Select this option to open the Adult Filters menu. - ---- - -## Baby Filters - -Configure which baby mobs are managed by this Mob Stand. - -Only enabled baby mob types will be processed. - -Select this option to open the Baby Filters menu. - ---- - -# Menu Layout - -Depending on permissions and server settings, some menu options may appear differently. - -Administrators may have access to additional controls. - ---- - -# Related Pages - -* Radius Settings -* Leave Alive Settings -* Filters -* Pause and Resume -* Admin Guide diff --git a/docs/Pause-and-Resume.md b/docs/Pause-and-Resume.md deleted file mode 100644 index 90cb0f3..0000000 --- a/docs/Pause-and-Resume.md +++ /dev/null @@ -1,129 +0,0 @@ -# Pause and Resume - -The Pause feature allows you to temporarily disable a Mob Stand without removing it or changing its configuration. - -This is useful when performing maintenance, redesigning farms, or temporarily stopping resource generation. - ---- - -# What Pause Does - -When a Mob Stand is paused: - -```text id="hldq1q" -Processing Stops -``` - -The Mob Stand remains fully configured but will not manage mobs until processing is resumed. - -All settings remain intact, including: - -* Radius -* Leave Alive -* Adult Filters -* Baby Filters -* Gravity Settings - ---- - -# What Pause Does Not Do - -Pausing a Mob Stand does not: - -* Remove the Mob Stand -* Reset any settings -* Change ownership -* Affect filter configuration -* Convert the Mob Stand back into an Armor Stand - -Think of Pause as an on/off switch for processing. - ---- - -# Pausing a Mob Stand - -Open: - -```text id="s41m2x" -Main Menu - ↓ -Pause Processing -``` - -Once paused, the Mob Stand will stop managing nearby mobs. - ---- - -# Resuming a Mob Stand - -Open: - -```text id="8dxvt0" -Main Menu - ↓ -Resume Processing -``` - -The Mob Stand immediately returns to normal operation using its existing configuration. - ---- - -# Why Use Pause? - -Common reasons include: - -### Farm Maintenance - -Temporarily stop processing while making changes to a farm. - -### Testing Configurations - -Experiment with settings without permanently changing farm behavior. - -### Resource Management - -Disable production until resources are needed. - -### Seasonal Events - -Temporarily disable farms without removing player setups. - ---- - -# Visual Indicators - -The Pause button displays the current state of the Mob Stand. - -### Processing Enabled - -The Mob Stand is actively managing nearby mobs. - -### Processing Disabled - -The Mob Stand is paused and will not process mobs. - ---- - -# Tips - -### Use Pause Before Major Changes - -If you're redesigning a farm, pause the Mob Stand first. - -### No Reconfiguration Required - -After resuming, all previous settings remain unchanged. - -### Safe to Leave Paused - -A Mob Stand can remain paused indefinitely until processing is resumed. - ---- - -# Related Pages - -* Main Menu -* Radius Settings -* Leave Alive Settings -* Filters -* Gravity Settings diff --git a/docs/Permissions.md b/docs/Permissions.md deleted file mode 100644 index 67af965..0000000 --- a/docs/Permissions.md +++ /dev/null @@ -1,171 +0,0 @@ -# Permissions - -RS-MobStand uses permissions to control who can create, manage, and administer Mob Stands. - -Server owners can use these permissions to grant access to players, moderators, and administrators. - ---- - -# Player Permissions - -## Use RS-MobStand - -```text -rsmobstand.use -``` - -Allows a player to: - -* Convert Armor Stands into Mob Stands -* Open Mob Stand menus -* Configure owned Mob Stands -* Use normal plugin functionality - -Recommended for: - -```text -All Players -``` - ---- - -# Administrative Permissions - -## Admin Access - -```text -rsmobstand.admin -``` - -Allows a player to: - -* Access the Admin Menu -* Bypass ownership restrictions -* Modify Mob Stands owned by other players -* Assist with troubleshooting - -Recommended for: - -```text -Administrators -Moderators -Trusted Staff -``` - ---- - -# Ownership Protection - -Even with normal use permissions, players may only modify Mob Stands they own. - -Ownership is automatically assigned when a player converts an Armor Stand into a Mob Stand. - -Without administrative permissions: - -```text -Player A - └─ Can modify Player A's Mob Stands - -Player B - └─ Cannot modify Player A's Mob Stands -``` - -With: - -```text -rsmobstand.admin -``` - -ownership restrictions may be bypassed. - ---- - -# Recommended Permission Setup - -## Survival Servers - -Players: - -```text -rsmobstand.use -``` - -Administrators: - -```text -rsmobstand.use -rsmobstand.admin -``` - ---- - -## Staff Teams - -Moderators: - -```text -rsmobstand.use -rsmobstand.admin -``` - -Administrators: - -```text -rsmobstand.use -rsmobstand.admin -``` - ---- - -# Permission Plugins - -RS-MobStand works with common permission systems including: - -* LuckPerms -* PermissionsEx -* GroupManager -* Other Bukkit-compatible permission managers - ---- - -# Troubleshooting - -### Players Cannot Create Mob Stands - -Verify: - -```text -rsmobstand.use -``` - -has been granted. - ---- - -### Staff Cannot Access Admin Features - -Verify: - -```text -rsmobstand.admin -``` - -has been granted. - ---- - -### Player Cannot Modify Their Mob Stand - -Verify: - -* The player owns the Mob Stand. -* The player has the required permissions. -* The Mob Stand was successfully converted. - ---- - -# Related Pages - -* Admin Guide -* Creating Your First Mob Stand -* Troubleshooting diff --git a/docs/Radius-Settings.md b/docs/Radius-Settings.md deleted file mode 100644 index d4be076..0000000 --- a/docs/Radius-Settings.md +++ /dev/null @@ -1,86 +0,0 @@ -# Radius Settings - -The Radius setting controls how far a Mob Stand searches for nearby mobs. - -Adjusting the radius allows you to balance coverage, efficiency, and farm design. - ---- - -# What Radius Does - -The Mob Stand scans for matching mobs within its configured radius. - -Only mobs located within this area are eligible for processing. - ---- - -# Increasing Radius - -A larger radius allows a Mob Stand to cover a wider area. - -Benefits: - -* Covers larger farms -* Detects mobs farther away -* Reduces the need for multiple Mob Stands - -Considerations: - -* May include mobs you did not intend to manage -* May overlap with other Mob Stands - ---- - -# Decreasing Radius - -A smaller radius limits the Mob Stand to a more focused area. - -Benefits: - -* Greater precision -* Easier farm separation -* Better control over specific mob groups - ---- - -# Choosing a Radius - -The ideal radius depends on your farm design. - -### Small Farms - -Use a smaller radius to target a specific enclosure. - -### Large Farms - -Use a larger radius to cover the entire farm area. - -### Multiple Mob Stands - -When using several Mob Stands nearby, consider reducing radius values to prevent excessive overlap. - ---- - -# Radius Limits - -Server administrators may configure a maximum radius. - -If a radius exceeds the server limit, the Mob Stand will automatically use the highest allowed value. - ---- - -# Tips - -* Start small and increase as needed. -* Avoid unnecessarily large radii. -* Verify the Mob Stand is affecting the intended mobs. -* Use filters alongside radius settings for maximum control. - ---- - -# Related Pages - -* Main Menu -* Leave Alive Settings -* Filters -* Pause and Resume diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md deleted file mode 100644 index 7c60a4c..0000000 --- a/docs/Troubleshooting.md +++ /dev/null @@ -1,265 +0,0 @@ -# Troubleshooting - -This guide covers the most common issues encountered when using RS-MobStand and provides steps to resolve them. - ---- - -# Mob Stand Will Not Convert - -### Symptoms - -* Sneak-right-clicking an Armor Stand does nothing. -* The conversion does not occur. - -### Check - -Verify that: - -* You are holding a Stick. -* You are sneaking. -* You have the required permission. -* The target is a normal Armor Stand. - -### Solution - -Ensure you are: - -```text id="6rj03f" -Sneaking -+ -Holding a Stick -+ -Right-Clicking an Armor Stand -``` - ---- - -# Cannot Open Mob Stand Menu - -### Symptoms - -* Right-clicking a Mob Stand does nothing. -* The menu does not appear. - -### Check - -Verify that: - -* The stand is already converted. -* You own the Mob Stand. -* You have permission to use Mob Stands. - -### Solution - -Try interacting with a Mob Stand that you own. - -Administrators can bypass ownership restrictions using: - -```text id="jhy0k0" -rsmobstand.admin -``` - ---- - -# "You Do Not Own This Mob Stand" - -### Symptoms - -You receive an ownership error message. - -### Cause - -The Mob Stand belongs to another player. - -### Solution - -* Use your own Mob Stand. -* Ask the owner for assistance. -* Have an administrator assist you. - -Administrators with: - -```text id="3u4r6l" -rsmobstand.admin -``` - -may bypass ownership restrictions. - ---- - -# Mob Stand Is Not Processing Mobs - -### Check Pause Status - -Verify the Mob Stand is not paused. - -Open: - -```text id="50s1d7" -Main Menu - ↓ -Pause / Resume -``` - -and ensure processing is enabled. - ---- - -### Check Radius - -Verify the configured radius is large enough to reach the intended mobs. - -Open: - -```text id="kce0j6" -Main Menu - ↓ -Radius -``` - -and review the current value. - ---- - -### Check Filters - -Verify the mob type is enabled in the appropriate filter menu. - -Review: - -* Adult Filters -* Baby Filters - -If a mob is disabled in filters, it will be ignored. - ---- - -### Check Leave Alive - -Verify the Leave Alive setting is not preventing additional processing. - -Example: - -```text id="j11jv0" -Leave Alive: 10 -``` - -If only ten matching mobs exist, no additional processing will occur. - ---- - -# Mobs Are Being Ignored - -### Cause - -The mob type may be disabled in filters. - -### Solution - -Open: - -```text id="yzr39t" -Adult Filters -``` - -or - -```text id="jq4z32" -Baby Filters -``` - -and verify the desired mob type is enabled. - ---- - -# Gravity Is Not Working As Expected - -### Cause - -Gravity may be disabled. - -### Solution - -Open: - -```text id="r5g7t1" -Main Menu - ↓ -Gravity -``` - -and verify the current setting. - ---- - -# Configuration Changes Are Not Taking Effect - -### Cause - -The configuration may not have been reloaded. - -### Solution - -Administrators can use: - -```text id="db0vtg" -Admin Menu - ↓ -Reload Config -``` - -after making configuration changes. - ---- - -# Version Status Shows "Unable To Check" - -### Cause - -The plugin could not contact the update source. - -Possible reasons: - -* No internet access -* GitHub unavailable -* Repository is private - -### Solution - -This does not affect plugin operation. - -RS-MobStand will continue functioning normally. - ---- - -# Server Performance Concerns - -### Recommendations - -* Avoid excessively large radius values. -* Use filters to limit processing. -* Only create Mob Stands where needed. -* Review server performance regularly. - ---- - -# Still Need Help? - -Before requesting support, gather: - -* Minecraft Version -* Paper Version -* RS-MobStand Version -* Screenshots (if applicable) -* Console Errors (if applicable) - -Providing this information helps resolve issues more quickly. - ---- - -# Related Pages - -* Installation -* Permissions -* Admin Guide -* Main Menu diff --git a/readme.md b/readme.md deleted file mode 100644 index 0e3af8f..0000000 --- a/readme.md +++ /dev/null @@ -1,228 +0,0 @@ -

-

RS-MobStand

-

- Automated Mob Farming for Modern Minecraft Servers -

- - -

- -![Minecraft](https://img.shields.io/badge/Minecraft-1.21%2B-green) -![Platform](https://img.shields.io/badge/Platform-Paper-orange) -![Storage](https://img.shields.io/badge/Storage-YAML-blue) -![Status](https://img.shields.io/badge/Status-Stable-success) -![Development](https://img.shields.io/badge/Development-Active-brightgreen) -![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple) - -

- ---- - -## Overview - -**RS-MobStand** is a powerful automated mob farming plugin designed for Minecraft servers that want reliable resource generation without the performance impact of traditional mob farms. - -Players convert Armor Stands into Mob Stands and configure them through intuitive GUI menus while server owners maintain full control through configurable settings, permissions, filters, and administrative tools. - -Built from the ground up with performance, scalability, and long-term server operation in mind. - ---- - -## Why RS-MobStand? - -Traditional mob farms often create: - -* Excessive entity counts -* Server lag -* Chunk-loading issues -* Complex redstone systems -* Difficult balancing - -RS-MobStand replaces those systems with a clean, configurable solution that is easy for players to use and easy for administrators to manage. - ---- - -## Documentation - -See the complete documentation: - -- [Home](docs/Home.md) -- [Installation](docs/Installation.md) -- [Creating Your First ItemMagnet](docs/Creating-Your-First-MobStand.md) -- [Filters](docs/Filters.md) -- [Radius Settings](docs/Radius-Settings.md) -- [Pause and Resume](docs/Pause-and-Resume.md) -- [Admin Guide](docs/Admin-Guide.md) -- [Troubleshooting](docs/Troubleshooting.md) -- [Storage and Persistence](docs/Storage-and-Persistence.md) -- [Permissions](docs/Permissions.md) -- [Changelog](docs/Changelog.md) - -# Features - -### Automated Mob Farming - -Manage nearby mobs without traditional mob grinders. - -### Dynamic GUI Menus - -Simple and intuitive inventory-based interfaces. - -### Adult & Baby Filters - -Configure which mobs are affected by each Mob Stand. - -### Radius Controls - -Fine-tune stand operation and efficiency. - -### Leave Alive Support - -Maintain a configurable number of mobs while still automating management. - -### YAML Storage - -Reliable persistent storage that survives server restarts. - -### Armor Stand Ownership - -Protect Mob Stands from unauthorized access. - -### Chunk-Safe Design - -Built to behave correctly across chunk loads and unloads. - -### Performance Focused - -Designed to minimize server impact while maximizing functionality. - -### Administrative Tools - -Powerful management tools for staff and server operators. - ---- - -# RS Ecosystem - -RS-MobStand is the resource generation component of the growing **RS Ecosystem**. - -```text -┌─────────────┐ -│ RS-MobStand │ -└──────┬──────┘ - │ Generate - ▼ -┌──────────────┐ -│ RS-ItemMagnet│ -└──────┬───────┘ - │ Collect - ▼ -┌───────────┐ -│ RS-Auger │ -└─────┬─────┘ - │ Transport - ▼ -┌─────────────┐ -│ RS-Warehouse│ -└─────────────┘ - Store -``` - -Together these plugins create a complete automated resource collection and logistics system. - ---- - -# Screenshots - -### Main Menu - -*Coming Soon* - -### Mob Stand Interface - -*Coming Soon* - -### Administrative Menu - -*Coming Soon* - -### In-World Mob Stand - -*Coming Soon* - ---- - -# Installation - -1. Download the latest release. -2. Place the jar into your server's `plugins` folder. -3. Restart the server. -4. Configure settings as desired. -5. Convert an Armor Stand into a Mob Stand. -6. Enjoy automated mob management. - ---- - -# Performance - -RS-MobStand was designed with long-term server operation in mind. - -Features include: - -* YAML persistence -* Chunk-safe processing -* Efficient task management -* Optimized stand handling -* Minimal server overhead - ---- - -# Development Status - -| Component | Status | -| -------------------- | ---------- | -| Core System | ✅ Complete | -| GUI System | ✅ Complete | -| YAML Storage | ✅ Complete | -| Administrative Tools | ✅ Complete | -| Optimization | ✅ Complete | -| Public Release | 🚧 Pending | - ---- - -# Contributors - -### Big Pappa - -Project Creator -Founder of RSScripting - -### Atlas - -Architecture, Design & Development Support - ---- - -# Support - -If you encounter a bug or have a feature request, please open an issue in the GitHub repository. - ---- - -# License - -# License - -This project is licensed under the MIT License. - -See the LICENSE file for details. - ---- - -

- Built by RSScripting -

- -

- Generate • Collect • Transport • Store -