Requirements
The zip includes Oxide.Ext.CrashExtensions.dll (v1.12.7; BattlePass 4.0.4 needs v1.11.9 or newer), the bundled UI and animation framework. Copy it into RustDedicated_Data/Managed (Carbon: carbon/extensions) and restart the server once. Or copy VenuxUpdater.cs, also in the zip, next to BattlePass.cs and run venux.install in the server console: it installs the extension for you, and it makes no web request until you run one of its commands or turn one of its switches on.
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.
Hi momochi, thanks for the questions and sorry for the slow reply! 1. Blueprints as rewards Not yet. A reward always gives the item itself. I'll add blueprint rewards in the next update, using a simple "Is Blueprint" option on each reward. 2. Admin-only permissions All the admin tools already need the battlepass.admin permission (or server admin): battlepass.addxp, removexp, settier, givepremium, revokepremium, reset and resetall. To give it to someone: oxide.grant user <steamid> battlepass.admin Opening the pass itself has no permission right now, so every player can open it. If you'd like to keep the pass hidden from players while you test the balance, tell me and I'll add an optional battlepass.use permission in the same update. 3. Japanese UI Yes. Oxide shows each player the language their Rust client uses. Copy oxide/lang/en/BattlePass.json to oxide/lang/ja/BattlePass.json, translate the values (not the keys), then reload the plugin. Players with Rust set to Japanese will see your translation. Reward names and challenge names come from the config or web editor, so translate those there. Japanese text is wider than English, so a few long lines may need to be shorter. 4. Custom reward names You're right. Right now "Display Name" only changes the name shown in the Battle Pass UI. The item the player receives keeps its default Rust name. The next update will give the item your custom name too. Thanks for the feedback, it really helps!
Hey, did you restarted the server?
Hello, I know, ill fix tonight
Hello, the old version still works fine! This was just a revamp of the UI. You can create a ticket asking for them to add it and without a problem they'll add it if they know what they are doing.
could you potentially add kayak icon ? :3
What for? its compiling just right sir. You want a feature maybe?
Hello! Any update for june & mays update?
