- Required Dependencies
- https://chaoscode.io/resources/chaos.321/
This plugin requires the Chaos extension -> https://chaoscode.io/resources/chaos.321/
Spawn Control gives you complete access to Rusts spawn system, from both spawns groups found in monuments, and spawn populations that populate the world with tree, animals, ore, etc
Features
- Provides access to adjust every field for all types of spawn handlers on the map
- Easy to use UI lets you make changes quickly and see the results instantly
- Easily adjust spawn settings for monument spawn groups
- Teleport to spawn group locations on the map
- Add or change the entities spawned by spawn groups and individual spawns
- Easily adjust spawn settings and filters for spawn populations
- Splits each spawn population and monument spawn group collection in to their own data file which can be found easily and modified by hand if so desired
Permissions
spawncontrol.admin - Required to use the chat command to open the UI
Chat Commands
/sc - Opens the UI menu
Console Commands
sc.killgroups - Kill entities from all spawn groups on the map
sc.fillgroup - Trigger a refresh for all spawn groups on the map
sc.enforcelimits - Enforce spawn population limits. If there are more active entities then allowed, this will clean them up
sc.fillpopulations - Trigger all spawn populations to spawn additional entities, if they are below the imposed limit
sc.populationreport - Print out the current spawn report to console
sc.populationsettings - Print out the current spawn population settings to console
Spawn Populations & ConVar Spawn Populations
Spawn populations control the spawning of bulk world items such as wood, stones, ores, plants, trees, etc
ConVar spawn populations are the same, but have a convar server variable that lets you adjust the density value. These are typically used for animals, NPCs, vehicles, etc
In the spawn population editor there are 3 panels;
Settings - Contains all the settings for the population
Resources - The list of resources that are spawned via the spawn population
Spawn Filter - This is used to control where these entities can spawn
Settings
Target Density - This controls the overall number of entities the population should spawn. A higher number increase the desired number of entities
Spawn Rate - The base spawn rate for entities. This is affected by both the convar 'spawn.max_rate' and the option Scale w/ Server Population
Cluster Size - The cluster size is used to spawn entities close to each other (in clusters)
Cluster Dithering - This applies a noise value to clustered spawns so they don't all spawn on top of each other
Spawn Attempts - Is essentially how many entities to spawn per spawn tick. Initial being on initial start up, and repeating being during server operation
Enforce Population Limits - When enabled, this will kill off entities if the number that has spawned is greater then the limit determined by the target density
Scale w/ Spawn Filter - This scales the desired number of entities based on the settings in the spawn filter
Scale w/ Server Population - This scales the desired number of entities based on how many players are on the server
Scale w/ Large Maps - This scales the desired number of entities based on the size of the map
Spawn Filter
The spawn filter is used to determine valid spawn points on the map based on the values provided. If you are not a map maker, Rust maps have 3 informational maps that are used by spawn filters;
Splat - Is a map with information of the terrain textures in each point of the world
Biome - Is a map with information of the terrain biomes in each point of the world (Arid, Arctic, Temperate and Tundra)
Topology - Is a map with information of what type of area each point of the world is
The job of a spawn filter is to evaluate these maps to determine spawn positions based on the values provided in the spawn filter
Splat Filter - Entities will only spawn on the selected splats
Biome Filter - Entities will only spawn on the selected biomes
Topology Any - Entities will only spawn on any of the selected topologies
Topology All - Entities will only spawn on areas where all the selected topologies are present
Topology Not - Entities will not spawn on any are where the selected topologies are preset
Upon changing a spawn filter, a button in the top right title 'Update Distribution' will become active. See below for more information
Spawn Distributions
Spawn Distributions are paired to Spawn Populations, and is essentially a map of the world that contains valid spawn positions. This map is normally calculated during server start up based on the values of the spawn filter for each spawn population.
When you change the spawn filter of a spawn population these distribution maps become invalid and require a update before the spawn filter is correctly applied.
However, updating these during normal server operation is a costly process (100-150ms each for a decent sized map)
The 'Update Distribution' button that is shown in the Spawn Population UI will allow you to force update the corresponding distribution if you so please, otherwise custom spawn filter values will be automatically applied during the next server start up in place of the vanilla calculations.
There is also a option in the configuration "Update spawn distributions on plugin reload (slow)" which is disabled by default.
Enabling this option will trigger Spawn Distributions to update with custom spawn filter values when the plugin is loaded/reloaded if the server has already started.
If you enable this option, be aware that there will be a lag spike during the reload, the length of which is based solely on the number of customized spawn filters you have.
Configuration
Spawn Control gives you complete access to Rusts spawn system, from both spawns groups found in monuments, and spawn populations that populate the world with tree, animals, ore, etc
|
|
|
|
|
|
|
Features
- Provides access to adjust every field for all types of spawn handlers on the map
- Easy to use UI lets you make changes quickly and see the results instantly
- Easily adjust spawn settings for monument spawn groups
- Teleport to spawn group locations on the map
- Add or change the entities spawned by spawn groups and individual spawns
- Easily adjust spawn settings and filters for spawn populations
- Splits each spawn population and monument spawn group collection in to their own data file which can be found easily and modified by hand if so desired
Permissions
spawncontrol.admin - Required to use the chat command to open the UI
Chat Commands
/sc - Opens the UI menu
Console Commands
sc.killgroups - Kill entities from all spawn groups on the map
sc.fillgroup - Trigger a refresh for all spawn groups on the map
sc.enforcelimits - Enforce spawn population limits. If there are more active entities then allowed, this will clean them up
sc.fillpopulations - Trigger all spawn populations to spawn additional entities, if they are below the imposed limit
sc.populationreport - Print out the current spawn report to console
sc.populationsettings - Print out the current spawn population settings to console
Spawn Populations & ConVar Spawn Populations
Spawn populations control the spawning of bulk world items such as wood, stones, ores, plants, trees, etc
ConVar spawn populations are the same, but have a convar server variable that lets you adjust the density value. These are typically used for animals, NPCs, vehicles, etc
In the spawn population editor there are 3 panels;
Settings - Contains all the settings for the population
Resources - The list of resources that are spawned via the spawn population
Spawn Filter - This is used to control where these entities can spawn
Settings
Target Density - This controls the overall number of entities the population should spawn. A higher number increase the desired number of entities
Spawn Rate - The base spawn rate for entities. This is affected by both the convar 'spawn.max_rate' and the option Scale w/ Server Population
Cluster Size - The cluster size is used to spawn entities close to each other (in clusters)
Cluster Dithering - This applies a noise value to clustered spawns so they don't all spawn on top of each other
Spawn Attempts - Is essentially how many entities to spawn per spawn tick. Initial being on initial start up, and repeating being during server operation
Enforce Population Limits - When enabled, this will kill off entities if the number that has spawned is greater then the limit determined by the target density
Scale w/ Spawn Filter - This scales the desired number of entities based on the settings in the spawn filter
Scale w/ Server Population - This scales the desired number of entities based on how many players are on the server
Scale w/ Large Maps - This scales the desired number of entities based on the size of the map
Spawn Filter
The spawn filter is used to determine valid spawn points on the map based on the values provided. If you are not a map maker, Rust maps have 3 informational maps that are used by spawn filters;
Splat - Is a map with information of the terrain textures in each point of the world
Biome - Is a map with information of the terrain biomes in each point of the world (Arid, Arctic, Temperate and Tundra)
Topology - Is a map with information of what type of area each point of the world is
The job of a spawn filter is to evaluate these maps to determine spawn positions based on the values provided in the spawn filter
Splat Filter - Entities will only spawn on the selected splats
Biome Filter - Entities will only spawn on the selected biomes
Topology Any - Entities will only spawn on any of the selected topologies
Topology All - Entities will only spawn on areas where all the selected topologies are present
Topology Not - Entities will not spawn on any are where the selected topologies are preset
Upon changing a spawn filter, a button in the top right title 'Update Distribution' will become active. See below for more information
Spawn Distributions
Spawn Distributions are paired to Spawn Populations, and is essentially a map of the world that contains valid spawn positions. This map is normally calculated during server start up based on the values of the spawn filter for each spawn population.
When you change the spawn filter of a spawn population these distribution maps become invalid and require a update before the spawn filter is correctly applied.
However, updating these during normal server operation is a costly process (100-150ms each for a decent sized map)
The 'Update Distribution' button that is shown in the Spawn Population UI will allow you to force update the corresponding distribution if you so please, otherwise custom spawn filter values will be automatically applied during the next server start up in place of the vanilla calculations.
There is also a option in the configuration "Update spawn distributions on plugin reload (slow)" which is disabled by default.
Enabling this option will trigger Spawn Distributions to update with custom spawn filter values when the plugin is loaded/reloaded if the server has already started.
If you enable this option, be aware that there will be a lag spike during the reload, the length of which is based solely on the number of customized spawn filters you have.
Configuration
JSON:
{
"Spawn Handler": {
"Tick Interval (seconds)": 60.0,
"Minimum spawns per tick": 100,
"Maximum spawns per tick": 100
},
"Update spawn distributions on plugin reload (slow)": false,
"Version": {
"Major": 2,
"Minor": 0,
"Patch": 0
}
}
