Scrap Leviathan 1.0.0

[ ✓ ] Works on any host. [ ✓ ]

The plugin needs the free CrashExtensions library. Can't upload DLLs on your host? No problem: the zip includes a small installer plugin. Drop it in your plugins folder, run crashext.install, restart once, and you're done.

Scrap Leviathan puts a giant sea serpent made of scrap metal in your ocean. It roams the whole sea and hunts whatever it finds: boats first, then swimmers, then players standing on the shore. Gunshots and explosions draw it in. When it attacks, the water foams, the neck rises head first out of the sea and towers over its prey, the neck follows its target and the tail swings free.

It bites with a lunge and flips small open boats, breathes a jet of fire like a military flamethrower with arcing fireballs on top, and circles round to strike from another side between attacks. Its armor takes reduced damage; its two eyes and three glowing cores take a lot more, and every core you burst strips the armor around it.

Kill it and the carcass floats with locked crates on its back. They open 20 seconds after the kill, and when the carcass sinks, whatever was not looted slides to the seabed with a lamp on each crate and a cyan circle on the map. The top damage dealers get paid. It all runs on its own on a schedule, and nothing goes on the client: the leviathan is built from parts every Rust client already has.

Jump to: Features · Screenshots · Trailer · How a hunt goes · Commands · Permissions · Works with · Install · Configuration · Test server · FAQ

Features

For players

• A sea monster boss fight. A scrap serpent roams the whole ocean with its humps breaking the surface, then rises head first out of the water and towers over you. The reared neck follows its target and the tail swings free.
• It hunts you. Boats first, then swimmers, then players on the shore. Gunshots and explosions within 300 m count as noise and pull it in.
• You see it coming. The water foams for a moment before the neck comes up.
• It fights back. Lunging bites that flip small open boats (35% of bites by default) and tip the crew into the water, a military flamethrower breath with arcing fireballs on top, and a dive between attacks to strike again from another side.
• Weak points. The armor takes reduced damage. Its two eyes and three glowing cores take a lot more, and each core you burst strips the armor around it.
• Every weapon works. Bullets, rockets, torpedoes, cannonballs and explosions all hit it.
• Shared boss bar. Name, SURFACED or SUBMERGED, its three cores and its health, above the hotbar for everyone near the fight.
• Loot worth the fight. A floating carcass with locked crates on its back. They open 20 seconds after the kill, and whatever is not looted when the carcass sinks slides to the seabed, each crate with a lamp on it and a cyan circle on the map for divers.

For server owners

• Set and forget. Three deep-water territories are found on your map by itself (the same spots for the whole wipe), and hunts start on a timer with a minimum player count. A red circle on the map follows the leviathan wherever it swims.
• Your own territories. Add spots by coordinates with their own name and radius, or keep it inside its territory instead of roaming the whole ocean.
• Scales with the crowd. Health grows with the players around when it spawns, up to a cap you set.
• Rewards. Economics money and ServerRewards points for the top damage dealers, up to 10 places.
• Stays where it belongs. It keeps away from safe zones, oil rigs and the Cargo Ship and never leaves the water. Big boats (tugboats and player-built boats) are never flipped or damaged unless you turn that on, and its fire is aimed at players and doesn't damage bases.
• NCP toasts. With the free NCP plugin loaded, event messages show as toasts and the crate cooldown as a progress bar. Without NCP they go to chat.
• Announcements. Start, low health, kill and leave in chat, to everyone or only nearby, and an optional Discord webhook.
• Works with your loot plugins. The crates are the native heli or Bradley crates, so BetterLoot fills them, and you can pick an AlphaLoot profile.
• Every number in the config. Health, damage taken, every attack, speeds, crates, rewards, timers and territories, each with a safe range.
• Four languages. English, Spanish, Brazilian Portuguese and Russian built in.

For developers

• Hooks. OnScrapLeviathanStart, OnScrapLeviathanKilled, and OnScrapLeviathanBite, which you can veto to spare a player. See the FAQ.

Screenshots

Every screen below is Scrap Leviathan running in Rust.

Reared over the sea, with the shared boss bar above the hotbar

Its head and spiked neck tower over a rowboat	A flamethrower jet at a player with a rocket launcher

Rockets hit the reared neck while the boss bar drops	Killed: the carcass floats on the surface

Locked crates ride the carcass until they unlock	Unlooted crates sink to the seabed, each with a lamp

A cyan circle on the map marks the crates on the seabed

Trailer

The Scrap Leviathan trailer (click to play, 50 seconds)

How a hunt goes

• It starts. A hunt picks one of the sea territories, everybody gets a message with the grid, and a red circle on the map follows the leviathan wherever it swims.
• It hunts. It roams the whole ocean and goes for the closest prey: boats first, then swimmers, then players near the shore. Gunshots and explosions within 300 m pull it in too.
• It rises. The water foams, then the neck rises head first out of the sea. While it is up it bites, flips small open boats and breathes fire. Between attacks it dives and circles round to strike from another side.
• You hit it. The armor takes 30% of a hit by default, an eye or a core takes double. Each burst core strips the armor around it, and that stretch of body takes much more after that.
• It dies. The carcass floats with 4 locked crates on its back, which open 20 seconds after the kill. After 3 minutes the carcass sinks and whatever was not looted slides to the seabed, with a lamp on each crate and a cyan circle on the map. The top damage dealers get paid.
• Or it leaves. If nobody is near it for 8 minutes, or the 30 minute hunt runs out, it dives into the deep. The next hunt is scheduled by itself, 2 hours later by default.

Commands

Chat, for owners or a player with scrapleviathan.admin:

• /leviathan start - start a hunt now in a random territory.
• /leviathan spawn - spawn one in the deep sea near you (no time limit).
• /leviathan kill - kill it now (no damage rewards are paid).
• /leviathan despawn - remove it right away.
• /leviathan status - its health, cores alive, where it is and its territory.
• /leviathan territories - list the territories with their grid and radius.

Admin

From the server console, RCON or a player with scrapleviathan.admin:

• leviathan.start - start a hunt now.
• leviathan.spawn <player> - spawn one in the deep sea near that player.
• leviathan.kill - kill it now.
• leviathan.despawn - remove it.
• leviathan.status - its health and where it is.
• leviathan.territories - list the territories.

Permissions

• scrapleviathan.admin - the commands above. Owners can always use them. Players need no permission to fight it.

oxide.grant user YOUR_STEAM_ID scrapleviathan.admin

Works with

• NCP: free, optional: event messages as toasts and the crate cooldown as a progress bar instead of chat lines
• Economics / ServerRewards: optional top damage rewards
• AlphaLoot: fill the crates from a profile you name
• BetterLoot: fills the crates by itself (they are the native heli or Bradley crates)
• TruePVE: works as is: the leviathan can hurt players and small boats, and players can hurt it
• Carbon: same code path as Oxide

Install

1. Install the extension, once per server. Stop the server, copy Oxide.Ext.CrashExtensions.dll into RustDedicated_Data/Managed (Carbon: carbon/extensions) and start it again. The console prints Loaded extension CrashExtensions with its version. An older copy of the DLL is simply overwritten: it is one shared file for all our plugins.
2. Install the plugin. Copy ScrapLeviathan.cs into oxide/plugins (Carbon: carbon/plugins). It compiles on its own and creates its config.
3. That's it. The first hunt starts 30 minutes after the server is up, then every 2 hours. To see it now, stand near deep water and type /leviathan start.

Plugin does not compile? The extension is missing or too old: check the folder and restart again. On a hosting panel, upload the DLL with the file manager or SFTP, and keep a copy in case the panel resets that folder on an update.

Host doesn't allow DLL uploads? Put CrashExtInstaller.cs from the zip in your plugins folder and run crashext.install once in the server console: it downloads the extension from GitHub, checks it and puts it in place. Restart once and Scrap Leviathan loads.

Configuration

Everything lives in oxide/config/ScrapLeviathan.json (Carbon: carbon/configs/ScrapLeviathan.json). Every value has a safe range: a value out of range keeps the plugin unloaded, leaves your file untouched and tells you in the console what to fix. The keys you will most likely touch are explained in the README.

Config sections (click to expand)

Test server

Available on our test server. A hunt starts 30 minutes after the server starts and then every 2 hours while someone is online: watch chat for the grid, take a boat out to sea and make some noise.

client.connect 91.229.114.54:28015

FAQ

Q: Do players need a client mod?
A: No. The leviathan is built from parts every Rust client already has, so it works on any map with no downloads.

Q: Will it wreck my players' bases?
A: Its fire is aimed at players and doesn't damage bases. Its bites hurt players and small boats; big boats (tugboats and player-built boats) are never flipped or damaged unless you turn on DamagePlayerBoats.

Q: Can it hurt players in safe zones?
A: No. It stays away from safe zones, oil rigs and the Cargo Ship, and players in a safe zone or on the Cargo Ship, sleeping, in noclip or spectating are never targets.

Q: Do I need Economics or ServerRewards?
A: No. They are optional rewards. Without them the leviathan still leaves its crates.

Q: My map has little deep water. Will it work?
A: It looks for open, deep water away from monuments, safe zones and oil rigs. A small map may get fewer than 3 territories: run /leviathan territories to check, and add your own spots under Territories if you need them.

Q: It dies too fast or too slow. What do I change?
A: Health, HealthPerExtraPlayer, MaxHealthMultiplier, BodyDamage and CoreDamage. Any attack can be weakened or turned off by setting its damage to 0.

Q: Does it work on Carbon?
A: Yes. The extension goes into carbon/extensions instead of RustDedicated_Data/Managed, and the plugin into carbon/plugins.

Q: How do I translate it?
A: English, Spanish, Brazilian Portuguese and Russian are built in. Edit oxide/lang/en/ScrapLeviathan.json, or copy it into another language folder and translate its values: each player reads their own game language.

Q: Does it contact any outside service?
A: It downloads its few health bar pictures once from the Venux CDN, rust-cui.crashplugins.space, which your server then keeps. Nothing about your server or your players is sent. The Discord webhook is the only other request, and only if you fill it in.

Q: Can other plugins react to the leviathan?
A: Yes. Scrap Leviathan calls void OnScrapLeviathanStart(Vector3 position, string territory) when a hunt starts and void OnScrapLeviathanKilled(Vector3 position, ulong topDamager) when it dies (topDamager is 0 when an admin killed it). Return anything but null from object OnScrapLeviathanBite(BasePlayer player) to spare a player from a bite or the fire.

Questions, ideas or bug reports? Use the Support tab of this file or join our Discord.