Complete Build System / Sandbox System 2.3.2

BuildSystem is a creative building and sandbox system for Rust servers.

Players get their own plot (or claim one anywhere on the map), build for free with god mode and noclip, save and reload their bases, share them with the community, and invite friends to build with them. As the server owner you get configurable ranks and limits, an in-game admin panel, and a ready-to-use map with 160 plots.

Jump to: Features · What's included · Ranks · Permissions · Commands · Configuration · Developers

Features

Plots and claims

• Three build modes: fixed plots, procedural claims (players roam the map and /claim any spot), or both
• Normal and VIP plot categories, each split into grass, desert, dirt, and snow biomes
• Players pick a biome from the start menu, and plots are handed out in order or at random
• Central lobby with spawn, respawn, dome, and teleport handling
• Map markers, coloured domes, and boundary protection for every plot
• Sound isolation, so players only hear what happens inside their own plot
• Damage outside the plot radius is blocked

Creative building

• Free building and repairing, all blueprints unlocked, crafting without workbenches
• God mode and noclip, with separate rules for the lobby, plots, and roaming
• Auto-upgrade to any grade as you place, and upgrade or downgrade the whole plot in one click
• Auto-lock for doors and boxes, open or close all doors at once
• Turn all electrics on or off, or use No Electricity mode to power everything without wiring
• A stability toggle: switch it off and nothing collapses while you build
• Built-in hammer remove (hold R)
• Remove deployables, remove vehicles, wipe to foundation, or clear the whole plot
• Vehicles from the F1 spawn menu (configurable list)
• Build cost calculator with total cost and 24h upkeep
• Entity and vehicle limits per rank, shown on a live HUD

Symmetry building

• Hit a foundation with the hammer to set the centre, and every piece you place, upgrade, rotate, or remove is mirrored
• Square, triangle, and hexagon layouts
• Single, Quad, Rot2, Rot3, Rot4, and Rot6 modes
• Visual guides, plus pause, resume, cycle, and disable controls
• Mirrored copies count toward the player's entity limit

Saving and loading

BuildSystem has its own save system, so CopyPaste is not required.

• Save, load, rename, and delete builds from the My Builds menu
• Plots auto-save when the owner leaves or disconnects, and when the server saves or shuts down
• Restores entities, inventories, locks, authorisations, signs, vehicles, and electrical/IO wiring
• Saves and loads run one at a time in a queue, with a timeout
• Unlimited saves by default, or per-rank save limits
• Every save file is backed up, and a console command restores it
• Migrates old CopyPaste saves

Community builds

• Publish a build to the in-game community gallery, with or without a Rust camera photo
• Browse builds as cards, or load one with a share code
• Each build has a title, description, author, photo, and star rating
• Preview an imported build before saving your own copy
• Admins can hide, edit, re-photo, or remove any published build

Building with friends

• Invite a player, or ask to join their plot, from chat or from the player list in the menu
• Accept, decline, or cancel requests
• Guests are authorised on the plot's cupboards and turrets automatically
• The owner chooses what guests can do: build, remove, demolish, craft, and save/copy. All of these start off.
• Guests are sent back safely when the owner leaves

Export and import (optional)

This is off by default. When you turn it on, players can move builds in and out of the server in CopyPaste format, for example to test a base in Fortify, build bases for Raidable Bases, or move bases between servers.

• Export a plot to a link on bases.hionet.com, to a file on the server, or both
• Import from a link, or from files you approve in data/copypaste/approvedfiles
• Allowed per rank, with a cooldown

Player menu

Players open it with /build or the middle mouse button. It has these tabs:

• Start: pick a plot biome, or go exploring to claim your own spot
• Build Tools: the Upgrade, Symmetry, Personal, Remove, Doors, Electrical, Save Manager, Build Cost, and Plot Manager cards
• My Builds: saved builds, save slots, and publishing
• Community Builds: the shared build gallery
• Join Other Player: the online player list and join requests
• Settings: what guests can do on your plot
• Info: your server's Discord and website links

You can hide any Build Tools card or button from the config or the admin panel, and the remaining cards close up the gap.

Admin panel

Admins open it with /badmin. It has these tabs:

• Dashboard: server overview
• Categories: create, rename, and remove plot categories
• Slots: add, remove, teleport to, and identify plot slots
• Plots: active plots and their players; teleport, delete, or send to the lobby
• Community: manage published builds and their photos
• Maintenance: reload categories, refresh markers and UI, create or recreate the lobby, run plot cleanups
• Permissions: a quick reference for BuildSystem permissions
• Settings: search and edit config values in game; changes apply immediately

Destructive actions ask for confirmation, back up what they change, and are logged.

What's included

• 12 plugins: BuildAdmin, BuildConfig, BuildCore, BuildCosts, BuildGuests, BuildIO, BuildLang, BuildMirror, BuildOptions, BuildPlots, BuildSaves, BuildUI
• 5 build maps with the same lobby and plot layout, so you can pick the one you like
• Plot data for 160 plots: 124 normal and 36 VIP, across grass, desert, dirt, and snow
• An install guide, server startup arguments, and upgrade notes

Procedural and combined modes also work on your own custom or procedural maps.

BuildSystem runs on both Oxide and Carbon.

Ranks

Every limit a player has comes from a rank in BuildConfig.json. A rank is one block in the Ranks list:

{
  "Permission": "buildcore.vip",
  "Max entities": 6000,
  "Max vehicles": 8,
  "Plot radius (meters)": 120.0,
  "Claim radius (meters)": 120.0,
  "Max saved builds": 6,
  "Plot types they can use": [ "normal", "vip" ],
  "Allow export and import": true,
  "Allow symmetry": true
}

Default ranks

Adding your own rank

1. Open oxide/config/BuildConfig.json (Carbon: carbon/configs/BuildConfig.json).
2. Copy one block in the Ranks list, paste it below, and change the permission, for example to buildcore.elite.
3. Change the limits you want.
4. Reload the config with oxide.reload BuildConfig (Carbon: c.reload BuildConfig). The new permission registers itself.
5. Grant it with oxide.grant group elite buildcore.elite (Carbon: c.grant group elite buildcore.elite).

How ranks combine:

• The rank with the empty permission is the base for every player, so don't delete it.
• A player with several ranks gets the best value of each setting, so the order in the list doesn't matter.
• Any rank can unlock any plot type. Nothing is hardcoded to "VIP".
• Start custom permissions with buildcore., otherwise Oxide logs a warning for each one.

Permissions

Server admins (ownerid) have full admin access without any permission.

Commands

Player commands

You can rename /build and /claim or add more names for them in the config. For example, add b to Chat commands in the Build menu section to get /b.

Admin commands

Most admin work is done from the /badmin panel. These console commands cover the jobs the panel doesn't. Run them from the server console, RCON, or F1 as an admin.

Configuration

All settings are in one file, BuildConfig.json, and the setting names are plain English. You can also change most of them in game from the Settings tab in /badmin.

Developers

Hooks

API calls you can use from your own plugin:

// Which zone a player is in: "lobby", "plot_...", or null
string zone = BuildPlots?.Call<string>("GetPlayerZoneName", player);
string zoneAt = BuildPlots?.Call<string>("GetZoneNameAtPosition", position);

// The player's combined rank values
var rank = BuildConfig?.Call("ResolvePlayerTier", player) as Dictionary<string, object>;

// Guests
object ownerId = BuildGuests?.Call("API_IsGuest", player);  // owner's ulong, or null
bool canBuild = BuildGuests?.Call<bool>("API_CanGuestBuild", player) ?? false;

// Limits
int used = BuildOptions?.Call<int>("GetPlotEntityCount", zone) ?? 0;
int max = BuildOptions?.Call<int>("GetMaxEntitiesForPlayer", player) ?? 0;

If you need another hook or more detail on any of these, contact me.