SpigotCore

From Peirleitner.at Development

SpigotCore is the main library for all my public Minecraft plugins. It contains utils that are used in many projects.

Commands

Main Commands

Command Aliases Syntax Description Permissions Since Notes
/spigotcore None /spigotcore Basic plugin information + Management None 1.0.0 None

Sub-Commands

Main Command: /spigotcore

Argument Aliases Syntax Description Permission Since Notes
setlocation setloc None Set a new Location SpigotCore.command.spigotcore.setlocation 1.0.5 None
deletelocation delloc None Remove a Location SpigotCore.command.spigotcore.deletelocation 1.0.5 None

Features

Administrators

Name Description Since Notes
Central Message Management All message files will be created in plugins/SpigotCore/messages/<Plugin>.yml 1.0.1 None
Update-Checker Checks for updates on SpigotMC.org for all installed resources of mine 1.0.1 Toggleable in config.yml
Debugging All debug messages can be toggled in config.yml 1.0.0 Toggleable in config.yml
Location Management Set and remove Locations 1.0.5 None

Developers

Methods

Name Description Since Notes
ItemBuilder Create ItemStacks with ease 1.0.0 at.peirleitner.spigotcore.util.ItemBuilder.java
CustomLocation Used for saving locations to files with ease 1.0.0 at.peirleitner.spigotcore.util.CustomLocation.java
CustomPlayer Get and store attributes to a specific player 1.0.0 at.peirleitner.spigotcore.util.CustomPlayer.java
GsonFactory Manage JSON-Files with ease 1.0.0 at.peirleitner.spigotcore.util.GsonFactory.java
Logging Log on different levels directly to the console 1.0.0 at.peirleitner.spigotcore.SpigotCore.java
SkullGrabber Get skulls with Base64 strings and/or URLs 1.0.0 at.peirleitner.spigotcore.util.SkullGrabber.java
UUIDFetcher Get UUIDs/Names via HTTP request 1.0.0 at.peirleitner.spigotcore.util.UUIDFetcher.java
Message Mangement Register and get messages easily | Create a new instance to use 1.0.1 at.peirleitner.spigotcore.manager.MessageManager.java
World Management Create, Remove, Load, Unload, Reset and Backup Worlds with ease 1.0.0 at.peirleitner.spigotcore.manager.WorldManager.java
Util Manager Spawn Holograms, set AI/Silent, format to new Hex Colors and more 1.0.0 at.peirleitner.spigotcore.manager.UtilManager.java
LocationManager Save and delete Locations 1.0.5 at.peirleitner.spigotcore.manager.LocationManager.java

API

Events
# Name Description Cancellable Since Notes
001 PlayerArmorEquipEvent Called when equipping armor Yes PLANNED None
002 PlayerArmorUnEquipEvent Called when unequipping armor Yes PLANNED None
003 AnvilBreakEvent Called when an Anvil breaks Yes PLANNED None

Configuration

Main Configuration

Key Default Value Description Since Type Notes
debug true Should debugging be enabled? 1.0.0 boolean Sets this value for all plugins using SpigotCore's debug mode
prefix SC Change the plugin's prefix here 1.0.0 String None
check-for-updates true Should the plugin check for updates? 1.0.1 boolean Checks for updates for all installed plugins using SpigotCore

Settings

Main Key: Settings.<Key>

Key Default Value Description Since Type Notes
date_format dd-MM-YYY The default date format that will be used 1.0.0 String Used for translating timestamps into an actual date

WorldManager

Main Key: WorldManager.world.<Key>

Key Default Value Description Since Type Notes
defaultValues.difficulty PEACEFUL Default difficulty used on world creation 1.0.0 enum Also counts for importing worlds
defaultValues.clear.monster true Should monsters be killed on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.clear.item true Should items be killed on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.clear.animal true Should animals be killed on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.clear.villager false Should villagers be killed on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.clear.armorstand false Should armostands be killed on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.clearWeather true Should the weather be set to clear on world creation? 1.0.0 boolean Also counts for importing worlds
defaultValues.time 0 The time will be set to on world creation 1.0.0 long Also counts for importing worlds
defaultValues.disabledGameRules ANNOUNCE_ADVANCEMENTS List of disabled gamerules on world creation 1.0.0 enum Collection
backup.defaultWorlds false Should default worlds be backuped? 1.0.0 boolean None
backup.cache false Should the cache folder be backuped? 1.0.0 boolean For PaperSpigot users
backup.logs false Should the logs folder be backuped? 1.0.0 boolean None
backup.plugins false Should the plugins folder be backuped? 1.0.0 boolean None

Messages

Main Key: message.<Key>

Key Default Value Since Type
no-permission &cYou are not allowed to perform this action. 1.0.0 String
player-offline &cThat player is offline. 1.0.0 String
player-null &cThat player has never been on this server. 1.0.0 String
no-console &cThis action may only be performed by a player. 1.0.0 String
no-target-yourself &cYou cannot provied yourself for this action. 1.0.1 String