Documentation
<font size=6>Work in progress.
For more commands, see this forum thread.</font>
For more commands, see this forum thread.</font>
Installation
Installing Spawn is very simple. Just download the current version of Spawn.jar, drop it in your plugins folder, throw a reload, and you're good to go.Config
As of v0.2, Spawn will automatically generate a complete config file with sane defaults and some default aliases and safeguards set. You may want to review the configuration file, particularly: if you are NOT running any permissions plugins, then you need to make sure permissions: is set to false! (This is another issue I intend to resolve!) See also: ConfigCommands
This guide is written assuming that you will use the commandline /spawn. However, there may be other plugins that use the command /spawn; in that case, Spawn will *not* interfere. If all else fails, you should be able to use the /ent command, as this is the one command that is explicitly reserved for Spawn. Otherwise, you can choose from these command aliases: /spawn, /sp, /s, /ent, /spawn-entity, /se. This also goes for /spawn-admin, /sp-admin, /s-admin, /ent-admin, /spawn-entity-admin, and /se-admin.Administrator Commands | ||
---|---|---|
Command | Permission | |
/spawn-admin | spawn.admin | |
Prints help, listing only the commands to which the user has access | ||
/spawn-admin reload | spawn.admin | |
Reloads the plugin. Use this to make config file changes take effect. | ||
/spawn-admin save | spawn.admin | |
Saves the configuration file. This will automatically be called when the plugin is disabled. Actually at this point, this is a pretty pointless command; the only things that would be saved are automatic changes: e.g. an entity is blacklisted because it threw an exception, or a new entity has been spawned that the plugin didn't know about before. | ||
/spawn-admin reset | spawn.admin | |
This is the nuclear option. Your configuration file will be ERASED and replaced with a default copy. Useful for when you've messed it up somehow but don't want to deal with figuring out how or why. | ||
Spawning Entities... | ||
<font size=4>See also: How do I customize Entities?</font> | ||
Command | Permission | |
/spawn | spawn.spawn | |
Prints help, listing only the commands to which the user has access | ||
/spawn Entity | spawn.spawn-ent.Entity | |
Spawns an instance of org.bukkit.entity.Entity. This is case-sensitive, and must come from the actual class name of the Entity you wish to spawn! | ||
/spawn ALIAS | spawn.spawn-ent.(entities) | |
Spawns the entity referred to by ALIAS (non-case-sensitive). If multiple entities are referred to by this alias, then randomly chooses one to spawn. If the user does not have the right to spawn one or more of the referred entities, then those entities will not be chosen. If a target ALIAS comes with default parameters, these will be applied. | ||
/spawn ALIAS/param/param | spawn.spawn-ent.(entities) | |
Spawns the entity referred to by ALIAS (non-case-sensitive) with custom parameters. If a target ALIAS comes with default parameters that conflict with yours, yours will be applied last (usually means yours will override them). | ||
/spawn ALIAS NUMBER | spawn.spawn-ent.ALIAS | |
Spawns the desired NUMBER of entities referred to by ALIAS. If multiple entities are referred to by this alias, each spawned entity is randomly chosen. | ||
/spawn Entity;Entity2 | spawn.spawn-ent.Entity, spawn.spawn-ent.Entity2 | |
Spawns an Entity riding an Entity2 | ||
/spawn Entity/param;Entity2/param | spawn.spawn-ent.Entity, spawn.spawn-ent.Entity2 | |
Spawns a customized Entity riding a customized Entity2 | ||
...And Killing Them | ||
Command | Permission | Console? |
/spawn kill | spawn.kill | YES |
Kills all entities on the default kill list as defined in the configuration file | ||
/spawn kill RADIUS | spawn.kill | NO |
Kills all entities on the default kill list within RADIUS of where the player is standing (cannot be run from console) | ||
/spawn kill Entity | spawn.kill-ent.Entity | YES |
Kills all instances of org.bukkit.entity.Entity. This is case-sensitive, and must come from the actual class name of the Entity you wish to spawn! | ||
/spawn kill ALIAS | spawn.kill-ent.(entities) | YES |
Kills all entities referred to by ALIAS (non-case-sensitive). If the user does not have the right to kill one or more of the referred entities, then those entities will not be killed. If a target ALIAS comes with default parameters, these will be applied. | ||
/spawn kill ALIAS RADIUS | spawn.spawn-ent.(entities) | NO |
Kills all ALIAS within RADIUS of where the player is standing (cannot be run from console) |
Ugh... sorry for the atrocious formatting. Despite the plethora of markup options, we don't seem to have much versatility when it comes to tables, lists, etc.
Joren