autospigot
SpigotMC Rapid Development Framework
- Manage and build spigot versions.
- Setup and run spigot servers.
- Automatically update plugins during development.
Installation
You need to install NodeJS and NPM in order to install and use autospigot.
npm i -g autospigot
Servers
Configuration
- dir
<string>
- The working directory for the server relative to the directory of the configuration file. Default is the current directory. - version
<string>
- A valid spigot version likelatest
,1.12.2
or1.13
. Default is"latest"
- type
<string>
- The server type. This can bespigot
orcraftbukkit
. Default is"spigot"
- eula
<boolean>
- Iftrue
, autospigot will automatically accept the EULA when the server is started. Default isfalse
- plugins
<array>
- An array of plugin filenames (relative to the directory of the configuration file) to watch for plugins.- The last part of the filename can be a glob pattern.
- pluginManager
<object>
- The plugin manager configuration.- awaitWriteFinish
<boolean> | <object>
- Setting totrue
or an object will cause the file system watcher to wait until changes are written to disk. Default isfalse
.- stabilityThreshold
<number>
- The number of milliseconds a file must stay unchanged before updating a plugin. - pollInterval
<number>
- The interval in milliseconds for checking the filesize for changes.
- stabilityThreshold
- awaitWriteFinish
Start
Start an autospigot server.
This will automatically install the required spigot or craftbukkit versions.
autospigot start
config
is the path of the configuration file. Default isautospigot.json
Versions
rev
can belatest
or any version supported by the spigot build tools.
Install
Install a specific server version if not installed.
autospigot install
Update
Update or install a specific server version.
autospigot update
Remove
Remove a specific server version if installed.
autospigot remove
Clear
Remove all installed versions.
autospigot clear
List
List all installed versions.
autospigot list # Outputs something like: 1.13 => 1.13-R0.1-SNAPSHOTlatest => 1.12.2-R0.1-SNAPSHOT
Storage
The directory where build tools and spigot versions are stored depends on the platform you are working on.
Path | Platform |
---|---|
<AppData>/autospigot |
Windows |
~/.autospigot |
any other |
The following specific paths exist in the autospigot storage directory:
Filename | Description |
---|---|
build-tools.jar |
The latest build tools version that was used. |
build-tools-meta.json |
Used to ensure that the local build tools are the latest. |
versions/<rev>/craftbukkit.jar |
Craftbukkit server for a specific version. |
version/<rev>/spigot.jar |
Spigot server for a specific version. |
version/<rev>/meta.json |
Internal meta information of the installed version. |