Ultimate Industrial Farm – Expand Storage Adapters, Farm automation, Industrial customization

This is an all in one plugin, with a single plugin you can extend the use of storage adaptors on multiple entities.
Automate farming: Hitch & Trough automatic food supply, automatic dung collection, which you can then send to the composter.
Automated Chicken Coop, with water collector for automatic refill, container to insert food for automatic refill and for egg collection, change Eggs Production Speed.
You can also enable Auto Pet, and artificial sunlight, this way the chickens will always have maximum love and maximum sunlight.

You can also customize Beehive: set it to always be outdoors, disable humidity, set temperature, change growth rate, change production speed, multiplies honey production, change how much XP to increase to the Nucleus for each honeycomb produced, Nucleus’s XP start grade, etc…

Customizing settings for Industrial conveyor: change Maximum stack size to move, item movement frequency

Composter: automatic item split.

Automate Planter Box, and much more.

Expand your industrial and farming horizons with this plugin!

Compatible with Oxide/Umod and Carbon.

VIDEO

Below you can see an example video on how to use the plugin.

SUPPORTED ENTITIES:

1. Beehive
2. Furnace
3. Hobo Barrel
4. Stone Fireplace
5. Mail Box
6. Drop Box
7. Large Planter Box
8. Small Planter Box
9. Triangle Planter Box
10. Rail Road Planter
11. Triangle Rail Road Planter
12. Minecart Planter
13. Bath Tub Planter
14. Single Plant Pot
15. Hitch & Trough
16. Fridge
17. Small Generator
18. Composter
19. Mixing Table
20. Cooking Workbench
21. Recycler
22. Barbeque
23. Cursed Cauldron
24. Camp Fire
25. Survival Fish Trap
26. Auto Turret
27. SAM Site
28. Flame Turret
29. Shotgun Trap
30. Snow Machine
31. Fogger-3000
32. Chicken Coop

More entities will be added in the future or upon request, via a support ticket

FARMING AUTOMATION:

The plugin allows you to automate farming

1. Chicken Coop: A water container is added to the chicken coop, and a storage container where you can add food and where it will find the eggs produced.
   The water for the chicken coop is automatically refilled via the water container and the food is automatically taken from the storage container.
   There is also a Storage Adaptor to move food and eggs as you like.

   You can also enable Auto Pet, and artificial sunlight, this way the chickens will always have maximum love and maximum sunlight, change Eggs Production Speed.
2. Hitch & Trough: 2 Storage Adaptors and a storage container are added to the Hitch & Trough.
   1 Storage Adaptor can be used for automatic food refill.
   The dung produced by the horses is collected and automatically moved into a storage container.
   Above this container there is another Storage Adaptor to automate the automatic movement of the dung produced, for example by sending it to a composter.
3. Beehive: set it to always be outdoors, disable humidity, set temperature, change growth rate, change production speed, multiplies honey production, change how much XP to increase to the Nucleus for each honeycomb produced, Nucleus’s XP start grade, etc…
4. Industrial conveyor: change Maximum stack size to move, item movement frequency
5. Composter: automatic item split.

PERMISSIONS:

The plugin can work in various ways.

1. Assigning permissions for individual Storage Adaptors and farming automation
2. Creating custom groups with the ability to set limits for each entity
3. Or a mix of both

To use the plugin, it is mandatory to assign ultimateindustrialfarm.use permissions to the player.

If you want to use the plugin via permissions, these are the available permissions:

• ultimateindustrialfarm.admin: Allows use as admin, e.g. bypassing building permits (soon also bypassing limits)
• ultimateindustrialfarm.bypass.building_privilege: Allows you to bypass building privileges
• ultimateindustrialfarm.composter.autosplit: Allows you to enable composter automatic item splitting. The “Enable usage of composter auto split? Set this value to false if you do not use auto split, to improve performance.” parameter must be set to true to use the auto split system.

FOR INDUSTRIAL

These permissions enable the use of Storage Adaptors on the various entities.

• ultimateindustrialfarm.industrial.nostorageadaptorrequired: Allows you to place Storage Adaptors without having them in your inventory, if used via command, or not to use storage adaptors present in your inventory.
• ultimateindustrialfarm.industrial.all: Enable use on all industrial entities
• ultimateindustrialfarm.industrial.beehive: For the entity Beehive
• ultimateindustrialfarm.industrial.furnace: For the entity Furnace
• ultimateindustrialfarm.industrial.hobobarrel: For the entity Hobo Barrel
• ultimateindustrialfarm.industrial.fireplacestone: For the entity Stone Fireplace
• ultimateindustrialfarm.industrial.mailbox: For the entity Mail Box
• ultimateindustrialfarm.industrial.dropbox: For the entity Drop Box
• ultimateindustrialfarm.industrial.planterbox: For the entity PlanterBox
• ultimateindustrialfarm.industrial.hitchtrough: For the entity Hitch & Trough
• ultimateindustrialfarm.industrial.fridge: For the entity Fridge
• ultimateindustrialfarm.industrial.fuelgenerator: For the entity Small Generator
• ultimateindustrialfarm.industrial.composter: For the entity Composter
• ultimateindustrialfarm.industrial.mixingtable: For the entity Mixing Table
• ultimateindustrialfarm.industrial.cookingworkbench: For the entity Cooking Workbench
• ultimateindustrialfarm.industrial.recycler: For the entity Recycler
• ultimateindustrialfarm.industrial.barbeque: For the entity Barbeque
• ultimateindustrialfarm.industrial.cursedcauldron: For the entity Cursed Cauldron
• ultimateindustrialfarm.industrial.campfire: For the entity Camp Fire
• ultimateindustrialfarm.industrial.fishtrap: For the entity Survival Fish Trap
• ultimateindustrialfarm.industrial.autoturret: For the entity Auto Turret
• ultimateindustrialfarm.industrial.samsite: For the entity SAM Site
• ultimateindustrialfarm.industrial.flameturret: For the entity Flame Turret
• ultimateindustrialfarm.industrial.guntrap: For the entity Shotgun Trap
• ultimateindustrialfarm.industrial.snowmachine: For the entity Snow Machine
• ultimateindustrialfarm.industrial.fogmachine: For the entity Fogger-3000

• ultimateindustrialfarm.industrial.auto_recycler: Automatically start the recycler when it receives items via the Storage Adaptor

FOR FARMING AUTOMATION

These permissions enable farming automatizion on the various entities.

• ultimateindustrialfarm.farm.all: Automatize all farming entities
• ultimateindustrialfarm.farm.chickencoop: Automatize Chicken Coop entity
• ultimateindustrialfarm.farm.hitchtrough: Automatize Hitch & Trough entity
• ultimateindustrialfarm.farm.beehive: Allow Beehive customization

GROUPS AND LIMITS

The plugin creates 4 default groups: Default, vip1, vip2, vip3.
You can add more groups or rename groups.
For example, if you change the group vip1 to vip_elite, the permission ultimateindustrialfarm.vip_elite will be created
If you create a new group, for example vipvanilla, the permission ultimateindustrialfarm.vipvanilla will be created.

In the configuration file there is this configuration for managing groups:

1. Role Permission: Here you can set the configurations for the various roles:
   1. Priority. (lower = higher priority) — Each group has its own property, the lower this number is, the more important the group is. This is useful in the case where a player has more roles assigned. In this case, the group with the lowest priority will be assigned, the most important group. Negative numbers are also allowed.
   2. Settings
      1. Enable Composter Auto Split: Allows you to enable composter automatic item splitting. Default False (The “Enable usage of composter auto split? Set this value to false if you do not use auto split, to improve performance.” parameter must be set to true to use the auto split system)
      2. Industrial Settings
         1. Enable Customization: If set to true, enables Industrial customization. Default False
         2. Industrial Conveyor, Maximum stack size to move. Greater value = more items moved: The size of the stack to move, the larger the value, the more items will be moved. Default 128 (vanilla value)
         3. Industrial Conveyor, item movement frequency. Lower value = faster movement (value is an interval measured in seconds): Frequency in seconds to move items. The lower the value, the faster the items will be moved. Default 5 (vanilla value)
   3. Storage Adaptors Limits: Here you can set the limit of Storage Adaptors that you can add to the entity. You can set the limit for each entity.
      1. 0 disables the use of Storage Adaptors for this entity.
      2. -1 you can add Storage Adaptors without limits
   4. Farming Automation Limits: Here you can set the limit of how many farming entities can be automated.
      You can set the limit for each entity.
      1. 0 disables auto farming for this entity.
      2. -1 auto farming for this entity without limits.
   5. More for Chicken Coop:
      1. Enable Chicken Auto Pet: If enabled, the chickens will have Auto Pet, so that the chickens always have the love at its maximum, and make them happy automatically. Default False
      2. Enable Artificial Sunlight: If enabled, the chickens will have artificial light automatically, so that they always have maximum sunlight, and make them happy automatically. Default False
      3. Artificial Sunlight Value, from 0 to 100: If Enable Artificial Sunlight is TRUE, you can set the value of artificial sunlight to a value between 0 and 100. However, if for example you set the value of artificial sunlight to 40 and the chicken receives 50 as real sunlight, then the value will not be changed. You can think of this property as the minimum value of sunlight below which the value cannot go. Default 0.0
      4. Eggs Production. Minimum minutes between production: Minimum time in minutes for egg production. Default 10 minutes
      5. Eggs Production. Maximum minutes between production: Maximum time in minutes for egg production. Default 50 minutes
         1. Eggs will be produced in this time interval.
   6. More for Beehive
      1. Force Beehive Outside: Forces the Beehive to always be considered outside, even if placed inside the base. Default False
      2. Disable Humidity: If set to true, disables humidity, so that humidity is always at the best value. Default false
      3. Temperature, from 0 to 50 (0 do not modify). 23 is perfect value: Set the temperature you prefer. If the value is 0, it does not change the temperature. The optimal value is 23. Default 0.0
      4. Growth rate of the honeycomb in the hive and directly affects the rate at which honey is generated: Change the growth rate, to increase or decrease production. Default 1 (vanilla value)
      5. Configure the speed at which hives produce honey. A lower value would make hives produce honey faster: Change the production speed, to increase or decrease the production time. Default 120 seconds (vanilla value)
      6. Multiplies honey production (if value is less than or equal to 1, does not change production): Apply a multiplier to the honeycomb produced. Default 1 (vanilla value)
      7. How much the Nucleus’s XP should be increased per honeycomb generated: Changes the number of XP to be increased at the Nucleus for each honeycomb produced. Default 2 (vanilla value)
      8. Nucleus’s XP start grade: Changes the grade of the Nucleus’s when inserted into the Beehive. Default 3 (vanilla value)

NB: speed produce, the value for the production speed does not directly indicate the time to produce 1 honey. In Rust Vanilla, it basically takes about 5 cycles of 120 seconds to produce honey, so 1 honey every 10 minutes.
If you set the speed to 20 seconds, it means that it will take you 1:40 minute to produce 1 honey.
You just calculate the seconds * 5, and you get the production time.

Once the group is created, you will need to assign the related permission to the player, for example: ultimateindustrialfarm.vip1
In this case you can avoid assigning permissions for each individual entity.
If the limit for an entity is different from 0, the player will be able to add the Storage Adaptor to the entity or automate the entities for farming without the need to assign permissions for the individual entities.

When he reaches the limit, he will not be able to add new Storage Adaptors for the entity or automate other entities for farming.

The ultimateindustrialfarm.use permission is always mandatory and must be assigned to the player

COMMANDS FOR PLAYERS

Commands can be typed in chat (by putting the / character in front of the command)

• /uif help— Print help information.
• /uif ad or /uif adaptor— Adds the Storage Adapter to the entity you are looking at.
• /uif fm or /uif farm— Automate farming of the entity you are looking at, if the entity is enabled for farming.
• /uif unfm or /uif unfarm— Remove the Automated farming/Custom configurations, of the entity you are looking at, if the entity is enabled for farming.

CONFIGURATION

In the configuration file, in addition to the section for RolePermission, these properties are present

1. TimeZone: Default: Europe/London
2. Chat Command: Here you can add, edit or delete Commands can be typed in chat (by putting the / character in front of the command), or from console.
3. ChatPrefix: Chat message prefix.
4. Use Clan/Team. If TRUE allows placing Industrial Storage Adaptor or Automatize Farm on clan/team member entities: If set to true it allows you to place the Storage Adaptor or Automatize Farm on clan/team member entities. Default True
5. ShowMessageInfo (If set to TRUE, show a message info to the player, when place an entity for farming that can be automated): If set to true, show a message about how to automate the entity when an entity that is enabled for auto farming or customization is placed. Default true
6. Show UI to enable auto farming or view auto farming/customization information: If set to true it displays a when opening an entity for farming which can be automated or custom configurations applied, if you have permissions. Default true
7. Show UI even if you don’t have permissions. Only as a preview if for example it requires VIP: Show the UI also to players without permissions, as a preview. They will not be able to perform operations, this is to show the existence of this option if for example permissions are only available with VIP. Default true
8. Farming Automation. Interval to perform checks for automated farming. (ex. refilling water, food, collecting eggs, Beehive, ecc.): How many seconds should it handle the process to perform checks for automated farming. (ex. refilling water, food, collecting eggs, Chicken Coop, Beehive, ecc.). Default 20 (seconds)
9. Enable usage of composter auto split? Set this value to false if you do not use auto split, to improve performance: Set this value to true only if you want to use the auto split system of the composter, so as to improve performance if you do not use the auto split system. Default false
10. Improve performance by disabling some checks during auto split. If set to true, it may cause some fertilizer to fall out of the composter in some cases: Improve performance by disabling some controls during the auto split of the composter. It increases performance a lot but it may cause some fertilizer to fall out of the composter in some cases. Default false
11. Debug Mode. Print debug information in console: If set to True, prints warning/error messages to the console, for debugging problems. Default False

LOCALIZATION

The plugin is translated into the following languages:

• English
• Italian
• Spanish
• French
• German
• Dutch
• Turkish
• Chinese (Simplified – zh-CN)
• Chinese (Traditional  – zh-TW)

Translation files are located in the /oxide/lang or /carbon/lang folder, here is an example of a /oxide/lang/en/UltimateIndustrialFarm.json translation file.

You can add translations for other languages by adding them to the folder: /oxide/lang or /carbon/lang

NEW FEATURES

These new features are planned to be added:

• Storage Adapter support for Mining Quarry and Mining Pump Jack

You can also propose new features via a support ticket

LICENSE

Digital Content Copyright License

Intellectual Property:
This digital content is protected by copyright under international and local laws. All rights are reserved and any unauthorized use is prohibited. The content purchased may not be reproduced, distributed, transmitted, or used in any form or by any means without the written permission of the copyright holder, except as required by law.

Terms of Use:
1. Personal Use: Your purchase of this digital content grants you a non-exclusive, non-transferable, revocable license for personal use. The content may not be shared or distributed to third parties.
2. Limitations: You may not modify, alter, adapt, create derivative works from, sell, or license this content without the written permission of the copyright holder.
3. Backup: You may make one backup copy of the content for your personal use, provided that it is not distributed.

Warranties and Responsibilities:
The copyright holder makes no warranties regarding the accuracy, completeness or suitability of the content for a particular purpose. In no event shall the copyright holder be liable for any damages arising from the use or inability to use the purchased digital content.

Permission Requests:
For requests for permission to use or other information, please contact:

Andrea Angelozzi – Scalbox
[email protected]