FarmRoute

Project details

Project: FarmRoute

dev language: c# oxide

Plugin language: en

Author: RustFlash

Video: https://www.youtube.com/watch?v=9HCDEDJ7lxs

Description

FarmRoute is a zone-based farming system for Rust that spawns configurable farmable prefabs inside a defined farming area and guides players through a simple loop:

Farm (pick up spawned prefab) → (optional) Convert → Buy

Each route is fully configurable and stored as its own JSON file in the Oxide data folder.

Features:

Route-based zones (Farm / Buyer / optional Converter): Create a route by placing zones in-game. A route becomes active as soon as at least FarmingZone + BuyerZone are set.

Prefab spawning inside the farming zone: Spawns SpawnMax prefabs using SpawnPrefab and keeps the amount stable by respawning when a spawned entity is removed/killed.

Controlled farming interaction (blocks default pickup): Spawned route entities can’t be picked up normally; instead an interaction is started (permission + “busy” checks included).

Automatic menu UI inside Converter/Buyer zones: If a player stands inside Converter or Buyer zone, a small UI opens with a START (1x) button and auto-closes when leaving the zone.

Per-route permissions: Every route registers its own permissions (farm / convert / buy) for clean access control.

Optional per-skin stack caps: The plugin can enforce stack limits per item+skin (and split overflow into multiple stacks).

Commands:

Admin command: /farmroute

• /farmroute setfarm <name> <radius>
• /farmroute setbuyer <name> <radius>
• /farmroute setconvert <name> <radius> (optional)
• /farmroute removefarm <name>
• /farmroute removebuyer <name>
• /farmroute removeconvert <name>
• /farmroute list
• /farmroute show <n>
• /farmroute interact <name> <convert|buy> (manual start for testing)

Permissions:

1. farmroute.admin – Admin commands.
2. farmroute.use – Basic usage permission.
3. Per-route permissions (auto-registered per route name):
   • farmroute.route.<routeName>
   • farmroute.converter.<routeName>
   • farmroute.buyer.<routeName>

Config:

FarmRoute has a small config focused on UI + spawn/interaction tuning.

• UI Background Color (HEX)
• UI Text Color (HEX)
• UI Accent Color (HEX)
• UI Progress Bar Color (HEX)
• UI Error Color (HEX)
• Allow Global Stack Size Override
• Interaction Cancel Distance
• Minimum Spawn Distance Between Prefabs
• Maximum Spawn Attempts Per Prefab

Data / Persistence

Routes are stored per folder under:

oxide/data/FarmRoute/<routeName>/<routeName>route.json

Quick setup (minimal)

1. Stand where you want the farming zone center and run:
   /farmroute setfarm myroute 30
2. Stand where you want the buyer zone center and run:
   /farmroute setbuyer myroute 10
3. Optional converter zone:
   /farmroute setconvert myroute 10

As soon as farming + buyer are set, the route becomes active and starts spawning prefabs.

load, run, enjoy 💝