Bukkit

Configuration file settings

The configuration file, config.yml, is located in your /plugins/spawn folder. You can directly edit this file and then do a /spawn-admin reload to apply the settings. If you mess it up somehow and get frustrated, you can always do a /spawn-admin reset to nuke it and start over.

spawn:

horizontal-speed-limit: 10.0

Normally, player velocity is limited by Notch and other entities going fast do not affect lag. HOWEVER - if you spawn a player riding an entity with an extreme horizontal velocity, this can bring your server to its knees. If you've ever shot a player on a horizontal vector at 2,000,000 velocity, you'll know what I'm talking about... extreme lag and needless chunk generation on a massive scale. The default of 10 is plenty fast for our purposes... do NOT recommend increasing.

use-permissions: true

Tells the plugin that you are using a Nijikokun-compatible Permissions plugin. If set to false, then only ops can use this plugin.

spawn-limit: 100

This also protects the server from lag by limiting the number of entities that can be spawned at once. Our server typically bogs down around 300-400 or so.

size-limit: 50

Consider that when a slime dies, it (sometimes) produces two more slimes the next size down. So slimes at size 50 mean that potentially they could produce 2^50 slimes. So far this has actually been ok on our server, and if it becomes a problem, you can clean up by /spawn kill slime.

never:

spawn:

This is a list of entities that the plugin will NEVER spawn under ANY circumstances. Entries may get automatically added to this list if they are run and an IllegalArgumentException is generated (e.g. /spawn Entity will never work because it was never intended to be used by itself). Some of these have been manually added to the default list due to other problems that can bring down the server (e.g. Fish generated never-ending exceptions)

kill:

This is a list of entities that will NEVER be killed under ANY circumstance. For now, mostly the same as the previous list, and here's why: Typing /kill entity kills *every* entity. Like... all of them. Including the stuff that lets the player interact with the server... not good.

alias:

This is a list of aliases that let the plugin know what a player means when they ask to spawn something. I will list some examples here:

werewolf:

This is the name the player will type to get the creature.

- Wolf

This is the name of the class the entity belongs to according to Bukkit. This is CASE-SENSITIVE and MUST consist of the formal class name (e.g. org.bukkit.entity.Wolf -- take the stuff after the last period)

werewolf-parameters: /a

This is the default parameter(s) that will be assigned to this alias. In this example, this makes it so that typing /spawn werewolf is the same as typing /spawn wolf/a which makes an angry wolf.

projectile:

- Arrow

- Egg

- Fireball

- Snowball

Aliases can link to multiple entities. In this example, running /spawn projectile 10 would result in 10 projectiles being spawned, each one of them randomly selected from this list.

kill:

This is a list of creatures that will be killed by default when you run /spawn kill. Note that even if you have wolves and sheep in this list, as the default does, that OWNED wolves and NAKED sheep will NEVER be killed unless you specifically select them. They are hardcoded out as an exception.

player-alias:

example:

- JohnDoe

- JohnDoesBrother

This section deals with player aliases. In this example, typing /spawn example would result in either John Doe or John Doe's brother being tp'd to your target spot. Please try your best to avoid having these aliases conflict with creature aliases, but if they do conflict, these should take priority. This is for situations where you want to randomly pick from a list of players to mess with. One way to use this might be to have a group of players called "admins" and to let the server owner summon all of them at once (/spawn admin 100 should do the trick, as should /spawn admin;fireball/v:2 100)