Plugins¶
The plugins configuration file, config/plugins.js.
This file should export an object of plugin objects:
{
'Plugin Name': {
source: 'spigot',
resource: Number,
zip_path?: String || RegEx,
jar: String
},
}
{
'Plugin Name': {
source: 'github',
repository: String,
asset: String || RegEx,
zip_path?: String || RegEx,
jar: String
},
}
{
'Plugin Name': {
source: 'jenkins',
host: String,
job: String,
artifact: String || RegEx,
zip_path?: String || RegEx,
jar: String
},
}
Plugin properties¶
source
source¶
Required
Sources: spigot, github, jenkins
Type: String
The source of the plugin - one of:
spigotgithubjenkins
jar
jar¶
Required
Sources: spigot, github, jenkins
Type: String
The filename of the file on the server, like EssentialsX.jar.
zip_path
zip_path¶
Optional
Sources: spigot, github, jenkins
Type: String or RegEx
The name and location of the file to extract if the plugin download in compressed/zipped.
If you know the exact file name, set this to a string ('Filename.jar'). If the file name changes every time, use regex (/BungeeTabListPlus_BukkitBridge-\S*\.jar/g).
resource
resource¶
Required
Sources: spigot
Type: Number
The spigot resource ID. This is the number at the end of the URLs: https://www.spigotmc.org/resources/essentialsx.9089 9089.
repository
repository¶
Required
Sources: github
Type: String
The GitHub repository of the plugin - org/repo or user/repo.
asset
asset¶
Required
Sources: github
Type: String or RegEx
The name of the asset to download. If the name of the asset is different every time, you can either use RegEx, or if the name is predictable and included the tag name, you can use the {{tag}} placeholder.
host
host¶
Required
Sources: jenkins
Type: String
The web address for jenkins instance, like https://ci.example.net.
artifact
artifact¶
Required
Sources: jenkins
Type: String or RegEx
The name of the artifact to download. If the name of the artifact is different every time, you can either use RegEx, or if the name is predictable and included the build number, you can use the {{build}} placeholder.