About Auto Chicken Coop
═══════════════════════════════════════════════════════════════════════════════
AUTOCHICKENCOOP v1.5.0
Full Industrial Automation for Chicken Coops
by romzar.games
═══════════════════════════════════════════════════════════════════════════════
DESCRIPTION
-----------
AutoChickenCoop transforms chicken coops into fully automated industrial
production units! Automatically attach storage adaptors and fluid splitters to
chicken coops, enabling complete integration with Rust's industrial system.
Features automatic water transfer, egg hatching, chicken breeding optimization,
and advanced chicken protection systems.
COMPATIBLE WITH BOTH OXIDE/uMOD AND CARBON FRAMEWORKS
KEY FEATURES
------------
✓ Automatic Storage Adaptor Attachment
- Automatically attaches industrial storage adaptor to every chicken coop
- Connect conveyors directly to collect eggs and feathers
- Full industrial automation integration
- No player interaction required - completely automatic
✓ Automatic Fluid Splitter System
- Fluid splitter automatically attached to every coop
- Automatic water transfer from connected industrial sources
- Smart IO chain detection for water sources
- Configurable transfer rates based on IO setup
- Never manually fill water again!
✓ Auto-Hatch System
- Automatically hatches eggs when chicken count is below max
- Configurable max chickens per coop
- Perfect for automated breeding farms
✓ Chicken Love & Sunlight Control
- Force max love (100%) for constant breeding readiness
- Force max sunlight (100%) for optimal health
- Separate permissions for love and sunlight control
- Works on all chickens in automated coops
- Automatic attribute updates
✓ Advanced Chicken Protection
- Protect chickens from unauthorized damage
- Only owner and team/clan/friends can damage chickens
- Integrates with: Friends API, Clans, BetterTeams
- Configurable protection options
- Perfect for PvE servers
✓ Group-Based Limits System
- Configure different coop limits per permission group
- Perfect for VIP tiers and donation rewards
- Unlimited permission available for admins/special players
- Players get helpful upgrade messages when limit reached
- Data persistence - limits maintained across restarts
✓ Smart Water Transfer System
- Automatic detection of water in connected IO chains
- Supports multiple water sources (tanks, pumps, etc.)
- Transfer rate based on IO configuration
- Prevents water duplication and exploits
- Efficient batch processing for multiple coops
✓ Fully Configurable
- Adjust adaptor and splitter position/rotation
- Configure auto-hatch settings (max chickens, interval)
- Configure love/sunlight update intervals
- Configure chicken protection rules
- Fine-tune all aspects to match your server
✓ Admin Management Tools
- Reset command to reposition all adaptors/splitters
- Debug command for water transfer troubleshooting
- Check water status for specific coops/splitters
- Limit check command for players
- Comprehensive logging
✓ Automatic Cleanup & Optimization
- Removes adaptors/splitters when coops are destroyed
- No orphaned entities
- Automatic cleanup of old data (30 days)
- Dirty bit tracking for efficient saves
- Randomized auto-save to reduce I/O spikes
✓ Data Persistence
- Per-player data files for optimal performance
- Tracks all coops, adaptors, splitters, and chickens
- Automatic save on server save, player disconnect, and interval
- Backup system for corrupted data
- Clean and optimized performance
INSTALLATION
------------
1. Upload AutoChickenCoop.cs to oxide/plugins/
2. The plugin will auto-generate its config file on first load
3. Grant permissions to players/groups (see PERMISSIONS section)
4. Reload the plugin if needed: o.reload AutoChickenCoop
PERMISSIONS
-----------
autochickencoop.use
- Required for players to have automated chicken coops
- Without this permission, coops work normally (no automation)
autochickencoop.love.max
- Forces 100% love on all chickens in automated coops
- Ensures constant breeding readiness
- Updates automatically at configured interval
autochickencoop.autohatch
- Enables automatic egg hatching in chicken coops
- Automatically moves eggs to hatching slot
- Maintains configured max chicken count
autochickencoop.sunlight
- Forces 100% sunlight on all chickens in automated coops
- Ensures optimal health regardless of actual sunlight
- Perfect for indoor farms
autochickencoop.unlimited
- Bypass all chicken coop limits
- Perfect for admins or special players
- No maximum coop count
autochickencoop.admin
- Required to use admin commands
- For server administrators only
autochickencoop.{group}
- Group-specific limits configured in config file
- Examples: autochickencoop.default, autochickencoop.vip,
autochickencoop.premium
- Players get the highest limit from all their group permissions
PERMISSION EXAMPLES
-------------------
Grant to all players with basic automation (3 coops):
o.grant group default autochickencoop.use
o.grant group default autochickencoop.default
Grant VIP with auto-hatch and more coops (6 coops):
o.grant group vip autochickencoop.use
o.grant group vip autochickencoop.vip
o.grant group vip autochickencoop.autohatch
Grant premium with full automation (12 coops):
o.grant group premium autochickencoop.use
o.grant group premium autochickencoop.premium
o.grant group premium autochickencoop.autohatch
o.grant group premium autochickencoop.love.max
o.grant group premium autochickencoop.sunlight
Grant unlimited coops to admins:
o.grant group admin autochickencoop.use
o.grant group admin autochickencoop.unlimited
o.grant group admin autochickencoop.autohatch
o.grant group admin autochickencoop.love.max
o.grant group admin autochickencoop.sunlight
Grant admin permissions:
o.grant group admin autochickencoop.admin
COMMANDS
--------
/chickencoop.limit (Chat)
- Check your current chicken coop limit and usage
- Shows how many automated coops you have vs your limit
- Available to all players with .use permission
- Example output: "Automated Chicken Coops: 2/6"
/autochickencoop.reset (Chat) or autochickencoop.reset (Console)
- Requires: autochickencoop.admin permission
- Removes all old adaptors/splitters and recreates them
- Useful when adjusting position/rotation or limits in config
- Shows statistics: coops found, adaptors removed, splitters removed,
entities created
- Respects player limits when recreating automation
/chickencoop.debug (Chat) - Admin Only
- Requires: autochickencoop.admin permission
- Shows comprehensive water transfer debug information
- Displays total coops/chickens tracked
- Shows coops with water, splitter configs, active splitters
- Shows water transfer timer status
- Perfect for troubleshooting water issues
/chickencoop.checkwater (Chat) - Admin Only
- Requires: autochickencoop.admin permission
- Look at a chicken coop or fluid splitter
- Shows detailed water status for that specific entity
- Displays water amount, transfer calculations, IO connections
- Shows water source chain and transfer rates
- Best tool for diagnosing individual coop issues
CONFIGURATION
-------------
File Location: oxide/config/AutoChickenCoop.json
Default Configuration:
{
"Enabled": true,
"StorageAdaptorPosition": {
"x": -0.5,
"y": 1.45,
"z": -1.0
},
"StorageAdaptorRotation": {
"x": -15.0,
"y": 0.0,
"z": 0.0
},
"FluidSplitterPosition": {
"x": 0.1,
"y": 0.9,
"z": -1.0
},
"FluidSplitterRotation": {
"x": 0.0,
"y": 90.0,
"z": 0.0
},
"LoveSystem": {
"UpdateInterval": 30.0,
"ForceUpdateOnPet": true
},
"AutoHatch": {
"Enabled": true,
"MaxChickens": 4,
"CheckInterval": 30.0
},
"ChickenProtection": {
"Enabled": true,
"OnlyOwnerAndTeamCanDamage": true,
"CheckFriends": true,
"CheckClans": true,
"CheckBetterTeams": true
},
"GroupLimits": {
"default": 3,
"vip": 6,
"premium": 12
}
}
Configuration Options:
- Enabled: Set to false to disable the plugin without unloading
- StorageAdaptorPosition: Position offset relative to the coop (X, Y, Z)
* Default values position adaptor on upper back of coop
* Adjust to match your server's aesthetic preferences
- StorageAdaptorRotation: Rotation of the adaptor in degrees (X, Y, Z)
* Default: -15° pitch for proper alignment
- FluidSplitterPosition: Position offset relative to the coop (X, Y, Z)
* Default values position splitter on side of coop
* Must be positioned to allow IO connections
- FluidSplitterRotation: Rotation of the splitter in degrees (X, Y, Z)
* Default: 90° yaw for proper IO orientation
- LoveSystem:
* UpdateInterval: Seconds between love/sunlight updates (default: 30)
* ForceUpdateOnPet: Force update when chicken is pet (default: true)
- AutoHatch:
* Enabled: Enable/disable auto-hatch system (default: true)
* MaxChickens: Maximum chickens per coop before stop hatching (default: 4)
* CheckInterval: Seconds between auto-hatch checks (default: 30)
- ChickenProtection:
* Enabled: Enable/disable chicken protection (default: true)
* OnlyOwnerAndTeamCanDamage: Only owner/team can damage (default: true)
* CheckFriends: Check Friends API (default: true)
* CheckClans: Check Clans plugin (default: true)
* CheckBetterTeams: Check BetterTeams plugin (default: true)
- GroupLimits: Dictionary of group names and their coop limits
* "default": 3 = Players with autochickencoop.default get 3 coops
* "vip": 6 = Players with autochickencoop.vip get 6 coops
* "premium": 12 = Players with autochickencoop.premium get 12 coops
* Add as many custom groups as you want
* Players with multiple group permissions get the highest limit
* Permissions are automatically registered from this config
HOW IT WORKS
------------
1. Player with 'use' permission places a chicken coop
2. Plugin checks if player has reached their group limit
3. If within limit, plugin automatically attaches:
- Storage adaptor (for eggs/feathers collection)
- Fluid splitter (for automatic water supply)
4. If limit reached, player receives message with upgrade information
5. Player connects industrial components:
- Water source (tank, pump) to fluid splitter INPUT
- Conveyors to storage adaptor OUTPUT for egg/feather collection
6. Water automatically transfers to coop every 10 seconds
7. If auto-hatch enabled and player has permission:
- Eggs automatically move from storage to hatching slot
- System maintains max chicken count
8. If love.max permission: Chickens always at 100% love (breeding ready)
9. If sunlight permission: Chickens always at 100% sunlight (healthy)
10. Chicken protection prevents unauthorized damage
11. When coop destroyed, all automation removed and count updated
12. Player data saved persistently across server restarts
CHICKEN PROTECTION SYSTEM
-------------------------
Advanced protection prevents unauthorized damage:
Protection Levels:
1. Owner: Always allowed to damage their own chickens
2. Team: Rust team members allowed (if OnlyOwnerAndTeamCanDamage = true)
3. Friends: Friends API integration (if CheckFriends = true)
4. Clans: Clans plugin integration (if CheckClans = true)
5. BetterTeams: BetterTeams plugin integration (if CheckBetterTeams = true)
How It Works:
- OnEntityTakeDamage hook intercepts all chicken damage
- Checks if chicken is in an automated coop (has parent coop)
- Gets coop owner ID
- Checks if attacker is authorized (owner/team/friend/clan)
- Blocks damage if unauthorized
- Returns null (allows damage) if authorized
Configuration:
- Enabled: Turn entire protection system on/off
- OnlyOwnerAndTeamCanDamage: Core protection toggle
- CheckFriends/Clans/BetterTeams: Individual integration toggles
- Disable specific integrations if you don't have those plugins
ADMIN WORKFLOW
--------------
Initial Setup:
1. Configure GroupLimits in config file for your server tiers
2. Configure auto-hatch settings (max chickens, interval)
3. Configure love/sunlight update intervals
4. Configure chicken protection rules
5. Adjust adaptor/splitter positions if needed
Permission Setup:
6. Grant 'use' permission and group limit permissions to players/groups
7. Grant auto-hatch permission to VIP+ tiers
8. Grant love.max and sunlight to premium tiers
9. Grant 'unlimited' permission to admins or special players
10. Grant 'admin' permission to administrators
Maintenance:
11. Use /autochickencoop.reset command to apply config changes
12. Use /chickencoop.debug to monitor water transfer system
13. Use /chickencoop.checkwater to diagnose specific coops
14. Monitor player limits and upgrade requests
15. Enjoy players' creative automated chicken farms within balanced limits!
PERFORMANCE
-----------
• Lightweight and optimized
• Efficient per-player data file system
• Batch processing for entity initialization
• Safe to use on high-population servers
COMPATIBILITY
-------------
• Works with vanilla Rust
• Compatible with all industrial system items
• Integrates with: Friends API, Clans, BetterTeams
• No conflicts with other plugins
• Standalone - no dependencies required (friends/clans optional)
• Works with building plugins (CopyPaste, etc.)
• Oxide/uMod Framework - Fully Compatible
• Carbon Framework - Fully Compatible
• Single plugin file works on both frameworks automatically
TROUBLESHOOTING
---------------
Q: Adaptors/splitters aren't appearing on coops
A: Check that players have the 'autochickencoop.use' permission
Q: Multiple adaptors on one coop
A: Use /autochickencoop.reset command to clean up and recreate
Q: Want to change adaptor/splitter position
A: Edit the config file, reload plugin, then use /autochickencoop.reset
Q: Water isn't transferring to coops
A: Use /chickencoop.checkwater while looking at coop to diagnose
Verify IO connections from water source to fluid splitter
Check that water source has water in it
Ensure fluid splitter is properly connected
Q: Eggs aren't auto-hatching
A: Verify player has autochickencoop.autohatch permission
Check that coop has eggs in slot 3
Verify chicken count is below MaxChickens config value
Check AutoHatch.Enabled = true in config
Q: Chickens not at max love/sunlight
A: Verify player has autochickencoop.love.max and/or autochickencoop.sunlight
Check LoveSystem.UpdateInterval in config (default: 30s)
Wait for next update cycle
Q: Players without permission have automation
A: Existing coops keep automation. Remove permission and use
/autochickencoop.reset
Q: Chickens being damaged by other players
A: Enable ChickenProtection in config
Verify OnlyOwnerAndTeamCanDamage = true
Check that protection integrations are enabled
Q: Player can't place more coops
A: They've reached their group limit. Check with /chickencoop.limit
Grant them a higher tier permission or .unlimited permission
Q: How do I change a player's limit?
A: Grant them the permission for a higher tier group:
o.grant user PlayerName autochickencoop.vip
Q: Player data not saving
A: Check oxide/data/AutoChickenCoop/ folder exists and has write permissions
Data saves automatically when coops are placed/destroyed
Check server console for error messages
Q: Want to reset all player data
A: Delete files in oxide/data/AutoChickenCoop/ folder and use
/autochickencoop.reset
Q: How to add custom group limits?
A: Edit config file GroupLimits section, add your group and limit:
"elite": 20
Then grant permission: o.grant group elite autochickencoop.elite
Q: Water transfer rate too slow/fast
A: Transfer rate is calculated based on IO chain configuration
Add more pumps or tanks to increase rate (10 per pump/tank)
Maximum rate is 100 water per 10 seconds
Use /chickencoop.checkwater to see current transfer calculations
Q: Auto-hatch too fast/slow
A: Adjust AutoHatch.CheckInterval in config
Lower value = checks more often (faster response)
Higher value = checks less often (lower CPU usage)
Default: 30 seconds is balanced
Q: Love/Sunlight updates not frequent enough
A: Adjust LoveSystem.UpdateInterval in config
Lower value = updates more often
Higher value = updates less often (lower CPU usage)
Default: 30 seconds is balanced
SUPPORT
-------
For support, questions, or feature requests, please contact:
Discord: romzar
VERSION HISTORY
---------------
v1.4.0 - Group-Based Limits & Data Persistence
• Group-based limits system (VIP tiers)
• Per-player data persistence
• Automatic data cleanup (30 days)
• Dirty bit tracking for efficient saves
• /chickencoop.limit command
• Automatic upgrade suggestions when limit reached
• Enhanced water transfer system
• Batch entity processing on server init
• Randomized auto-save intervals
• Performance optimizations
v1.3.0 - Chicken Protection & Team Integration
• Chicken protection system
• Friends API integration
• Clans integration
• BetterTeams integration
• Configurable protection rules
v1.2.0 - Auto-Hatch System
• Automatic egg hatching
• Smart chicken count management
• Configurable max chickens
• Auto-hatch permission
v1.1.0 - Admin Tools & Debug
• /autochickencoop.reset command
• /chickencoop.debug command
• /chickencoop.checkwater command
• Enhanced logging
v1.0.0 - Initial Release
• Storage adaptor automation
• Fluid splitter automation
• Automatic water transfer
• Love control system
• Sunlight control system
LICENSE
-------
This plugin is provided for use on Rust game servers.
Redistribution or resale of this plugin is prohibited.
© 2025 romzar.games - All rights reserved.
═══════════════════════════════════════════════════════════════════════════════
Thank you for using AutoChickenCoop!
Build the ultimate automated chicken farm on your server!
═══════════════════════════════════════════════════════════════════════════════
