Jump to content

Requirements

The zip includes Oxide.Ext.CrashExtensions.dll, the bundled UI and animation framework. Copy it into RustDedicated_Data/Managed (Carbon: carbon/extensions) and restart the server once on first install.

Player commands

Command & Description

  • /battlepass/bp - Open the battle pass
  • /leaderboard/lb - Open the leaderboard
  • /bphud - Per-player HUD settings: vitals row, tier bar, XP gain popups

Every chat command and its aliases are configurable.

Admin commands

Run these from the server console (F1 or RCON). In game they need either auth level 2 or the battlepass.admin permission.

Player progression

Command & Description

  • battlepass.addxp <player|steamid> <amount> - Give XP to a player. Tiers are recalculated, so this can trigger tier-ups and their rewards
  • battlepass.removexp <player|steamid> <amount> - Take XP away
  • battlepass.settier <player|steamid> <tier> - Move a player straight to a tier
  • battlepass.reset <player|steamid> - Wipe one player's progress, claims and challenges
  • battlepass.resetall confirm - Start a new season: resets every stored player. The word confirm is required, without it the command only warns

Player arguments accept a name, a partial name or a SteamID, and work on offline players.

Premium

Command & Description

  • battlepass.givepremium <player|steamid> - Grant the premium pass
  • battlepass.revokepremium <player|steamid> - Take the premium pass back

Maintenance

Command & Description

  • battlepass.leaderboard - Post the leaderboard to your Discord webhook now
  • battlepass.reloadimages - Re-fetch the UI images (unchanged files are skipped)
  • battlepass.pruneimages [days] - Clear cached images older than days (default 30), in the background
  • battlepass.killorphanvendors - Remove Item Collector vendors left behind by an older build after a reload

Permissions

  • battlepass.premium - access to the premium reward track
  • battlepass.admin - use the admin commands above without being server auth level 2
  • battlepass.xpboost - XP multiplier for the players you grant it to

Integrations

Premium purchase: Economics, ServerRewards, BankSystem, IQEconomic, or an in-game item such as scrap. An optional Oxide group restriction limits who may buy.

Event XP: Raidable Bases (all difficulties), Abandoned Bases, Armored Train, Convoy, Caravan, Harbor, Gas Station, Arctic Base, Sputnik, Shipwreck, Junkyard, Satellite Dish, Water, Air, Power Plant, Airfield, Space, Supermarket, Tugboat Pirates, Flying Cargo, Dungeon, Ferry Terminal, Triangulation, Survival Arena, Zombie Infection, Paintball, Gun Game and generic multi-events. Zone Manager and SkillTree are supported too.

Discord: optional webhook announcements for tier ups, reward claims, premium purchases and the leaderboard, using Discord Components V2.

FAQ

Do my players have to download anything?
No. The only files that ever reach a client are the small icon set the plugin registers on boot, and they are cached after the first time.

Does it work with Carbon?
Yes, Oxide and Carbon are both supported.

Can I run a season longer than a wipe?
Yes. The season end date is a config value and progress is stored per player, independent of the map wipe.

What happens when the season ends?
The menu shows the season as finished and stops awarding XP. battlepass.resetall starts the next one.

Can players buy premium in game?
Yes, through Economics, ServerRewards, BankSystem or IQEconomic, and you can limit who may buy it by Oxide group.

Is the web editor required?
No. It is there so you never have to hand-edit JSON, but every setting remains a normal config file you can edit directly.

I am coming from 3.x, what do I need to do?
Install the new DLL, drop in the new .cs and restart once. Your config and player data carry over; the plugin rewrites its own files and removes the settings that no longer exist.


About Us

Codefling is the largest marketplace for plugins, maps, tools, and more, making it easy for customers to discover new content and for creators to monetize their work.

Downloads
3m
Total downloads
Customers
12k
Customers served
Files Sold
170.7k
Total sales
Payments
3.7m
Processed total
×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.