SpawnHeli

Features

• Allows players to spawn, fetch and despawn personal helicopters
• Supports Minicopters, Scrap Transport Helicopters, and Attack Helicopters
• Allows configurable cooldowns using permissions
• Allows preventing decay damage to personal helicopters
• Allows spawning personal helicopters with configurable fuel
• Allows personal helicopters to function without fuel
• Allows personal helicopters to be auto mounted when spawned or fetched
• Allows personal helicopters to takeoff instantly
• Allows configuring multiple spawn/fetch/despawn commands
• Allows automatically fetching helicopters, as well as optionally repairing them, when using the spawn command, to simplify the experience for players

Quick start

Allow all players to spawn Minicopters

1. To allow all players to spawn a Minicopter, run the command o.grant group default spawnheli.minicopter.spawn.
2. To allow all players to fetch their existing Minicopter, run the command o.grant group default spawnheli.minicopter.fetch.
3. To allow all players to despawn their existing Minicopter, run the command o.grant group default spawnheli.minicopter.despawn.
4. To make it so the /mymini command automatically fetches the player's existing Minicopter if they have one, set Minicopter -> Auto fetch to true in the config and reload the plugin.
5. To make it so fetching an existing Minicopter automatically repairs it, set Minicopter -> Repair on fetch to true in the config and reload the plugin.

Following the above steps, players will be able to spawn their Minicopter as often as every hour by default, but that can be changed in the configuration at Minicopter -> Spawn cooldowns -> Default cooldown (seconds).

Migrating from v2 to v3

This plugin has recently been redesigned to support spawning multiple types of helicopters. Previously it only allowed spawning Minicopters. Here are the steps you should take to update to v3.

1. Delete plugins/SpawnMini.cs
2. Copy config/SpawnMini.json to config/SpawnHeli.json
3. Add plugins/SpawnHeli.cs
4. Review config/SpawnHeli.json to verify everything looks right, make changes as necessary, and reload SpawnHeli if you make changes
5. Grant permissions as necessary

All of the plugin permission have been renamed. Here are the highlights.

• spawnmini.mini -> spawnheli.minicopter.spawn
• spawnmini.nocd -> spawnheli.minicopter.nocooldown
• spawnmini.nomini -> spawnheli.minicopter.despawn
• spawnmini.nodecay -> spawnheli.minicopter.nodecay
• spawnmini.unlimitedfuel -> spawnheli.minicopter.unlimitedfuel
• spawnmini.fmini -> spawnheli.minicopter.fetch
• spawnmini.fuel.<amount> -> spawnheli.minicopter.fuel.<amount> (replace <amount> with a number like 100)
• Spawn/fetch cooldown permissions are more complicated. Previously, you could define an arbitrary permission like spawnmini.<whatever>, which will now be spawnheli.minicopter.cooldown.spawn.<whatever>. or spawnheli.minicopter.cooldown.fetch.<whatever>.

Note: Some servers dynamically grant permissions to players or groups via other plugins or external systems. If you are doing that, you will need to update the configurations of those plugins or external systems to refer to the new permissions.

Caution: If you use a system or plugin (like Timed Permissions) to grant permissions to specific players (less of a concern for assigning permissions to groups) for a limited time, it might not be straight forward for you to back-fill the new permissions to the players who have been temporarily assigned the old permissions. If you are concerned about this case, you should plan to delay the v3 migration until an upcoming server wipe (assuming the temporary permissions would be revoked when the server is wiped).

Permissions

Basic permissions

Allow the player to spawn a helicopter (e.g., /mymini, /myheli, /myattack):

• spawnheli.all.spawn
• spawnheli.minicopter.spawn
• spawnheli.scraptransport.spawn
• spawnheli.attackhelicopter.spawn

Allow the player to fetch their existing helicopter (e.g,. /fmini, /fheli, /fattack):

• spawnheli.all.fetch
• spawnheli.minicopter.fetch
• spawnheli.scraptransport.fetch
• spawnheli.attackhelicopter.fetch

Note: The fetch permissions are required to make the spawn command fetch the player's existing helicopter when using the "Auto fetch": true configuration option.

Allow the player to despawn their existing helicopter (e.g., /nomini, /noheli, /noattack):

• spawnheli.all.despawn
• spawnheli.minicopter.despawn
• spawnheli.scraptransport.despawn
• spawnheli.attackhelicopter.despawn

Allow the player's helicopter to function without fuel:

• spawnheli.all.unlimitedfuel
• spawnheli.minicopter.unlimitedfuel
• spawnheli.scraptransport.unlimitedfuel
• spawnheli.attackhelicopter.unlimitedfuel

Disable decay damage to the player's helicopter:

• spawnheli.all.nodecay
• spawnheli.minicopter.nodecay
• spawnheli.scraptransport.nodecay
• spawnheli.attackhelicopter.nodecay

Allow the player to spawn their helicopter as often as they would like:

• spawnheli.all.nocooldown
• spawnheli.minicopter.nocooldown
• spawnheli.scraptransport.nocooldown
• spawnheli.attackhelicopter.nocooldown

Caution: Allowing helicopters to be respawned too frequently could be abused by players to reduce server performance. Alternatively, you can rely on the default cooldown configuration option, and/or grant non-zero cooldowns using permissions (see below).

Allow the player to auto mount their helicopter when spawning or fetching it (requires feature to be enabled in the config, and permissions are only necessary if configured to require permission):

• spawnheli.all.automount
• spawnheli.minicopter.automount
• spawnheli.scraptransport.automount
• spawnheli.attackhelicopter.automount

Allow the player's helicopter to takeoff instantly, bypassing engine startup time (requires feature to be enabled in the config, and permissions are only necessary if configured to require permission):

• spawnheli.all.instanttakeoff
• spawnheli.minicopter.instanttakeoff
• spawnheli.scraptransport.instanttakeoff
• spawnheli.attackhelicopter.instanttakeoff

Fuel permissions

The following permissions come with the plugin's default configuration. Each one determines how much fuel the helicopter spawns with.

Minicopters:

• spawnheli.minicopter.fuel.100 -- 100 fuel.
• spawnheli.minicopter.fuel.500 -- 500 fuel.
• spawnheli.minicopter.fuel.1000 -- 1000 fuel.

Scrap Transport Helicopters:

• spawnheli.scraptransport.fuel.100 -- 100 fuel.
• spawnheli.scraptransport.fuel.500 -- 500 fuel.
• spawnheli.scraptransport.fuel.1000 -- 1000 fuel.

Attack Helicopters:

• spawnheli.attackhelicopter.fuel.100 -- 100 fuel.
• spawnheli.attackhelicopter.fuel.500 -- 500 fuel.
• spawnheli.attackhelicopter.fuel.1000 -- 1000 fuel.

Additional permissions may be defined by adding them to Fuel profiles requiring permission per vehicle type in the configuration.

Note: If a player is granted multiple fuel permissions for a given helicopter type, the last one will apply, according to the profile order in the configuration.

Caution: Allowing helicopters to spawn with fuel could be abused to generate lots of fuel if the player is granted a low spawn cooldown. As an alternative to spawning helicopters with fuel, consider granting the spawnheli.minicopter.unlimitedfuel permission.

Spawn cooldowns

The following permissions come with the plugin's default configuration. Each one determines how often players can spawn helicopters.

Minicopters:

• spawnheli.minicopter.cooldown.spawn.1hr -- 1 hour.
• spawnheli.minicopter.cooldown.spawn.10m -- 10 minutes.
• spawnheli.minicopter.cooldown.spawn.10s -- 10 seconds.

Scrap Transport Helicopters:

• spawnheli.scraptransport.cooldown.spawn.1hr -- 1 hour.
• spawnheli.scraptransport.cooldown.spawn.10m -- 10 minutes.
• spawnheli.scraptransport.cooldown.spawn.10s -- 10 seconds.

Attack Helicopters:

• spawnheli.attackhelicopter.cooldown.spawn.1hr -- 1 hour.
• spawnheli.attackhelicopter.cooldown.spawn.10m -- 10 minutes.
• spawnheli.attackhelicopter.cooldown.spawn.10s -- 10 seconds.

Additional permissions may be defined by adding them to Spawn Cooldowns -> Cooldown profiles requiring permission per vehicle type in the configuration.

Note: If a player is granted multiple spawn cooldown permissions for a given helicopter type, the last one will apply, according to the profile order in the configuration.

Caution: Allowing helicopters to be respawned too frequently could be abused by players to reduce server performance. Instead of allowing helicopters to be spawned frequently, consider granting the fetch permission, setting a reasonable fetch cooldown, enabling "Auto fetch": true, and enabling "Repair on fetch": true.

Fetch cooldowns

The following permissions come with the plugin's default configuration. Each one determines how often players can fetch their existing helicopters.

Minicopters:

• spawnheli.minicopter.cooldown.fetch.1hr -- 1 hour.
• spawnheli.minicopter.cooldown.fetch.10m -- 10 minutes.
• spawnheli.minicopter.cooldown.fetch.10s -- 10 seconds.

Scrap Transport Helicopters:

• spawnheli.scraptransport.cooldown.fetch.1hr -- 1 hour.
• spawnheli.scraptransport.cooldown.fetch.10m -- 10 minutes.
• spawnheli.scraptransport.cooldown.fetch.10s -- 10 seconds.

Attack Helicopters:

• spawnheli.attackhelicopter.cooldown.fetch.1hr -- 1 hour.
• spawnheli.attackhelicopter.cooldown.fetch.10m -- 10 minutes.
• spawnheli.attackhelicopter.cooldown.fetch.10s -- 10 seconds.

Additional permissions may be defined by adding them to Fetch Cooldowns -> Cooldown profiles requiring permission per vehicle type in the configuration.

Note: If a player is granted multiple fetch cooldown permissions, the last one will apply, according to the profile order in