SpigotGuilds

From Peirleitner.at Development

This project is currently in active development and not available to public.

To try out a snapshot version please visit this page.

Main Commands

Command Aliases Syntax Description Permissions Since Notes
/spigotguilds /spigotguild /spigotguilds Version output None 1.0.0 None
/guild /g, /guilds /g <Argument> Main command None 1.0.0 None

Guilds

Ranks

Name Icon Since Notes
LEADER NETHERITE_CHESTPLATE 1.0.0 The creator of the Guild
ADMIN DIAMOND_CHESTPLATE 1.0.0 None
MODERATOR IRON_CHESTPLATE 1.0.0 None
MEMBER CHAINMAIL_CHESTPLATE 1.0.0 Default rank after joining a Guild

Commands

Main Command: /guild

Argument Syntax Description Default Guild Rank Since Needs a Guild to perform Notes
settings None Open the Guild Management GUI LEADER PLANNED Yes None
shop None Open the Guild Store ADMIN PLANNED Yes None
leave None Leave your current guild None 1.0.0 Yes Leaders need to use /guild disband
disband None Leave and delete your current Guild LEADER 1.0.0 Yes Should only be performed by leaders
menu None Open the Guild Menu None 1.0.2 Yes Graphical overview of the Guild
invite <Player> Invite a player to your Guild MODERATOR 1.0.0 Yes None
kick <Player> Kick a player out of the Guild MODERATOR 1.0.0 Yes None
accept <Name> Accept a guild invitation None 1.0.0 No Can only be used if you have no guild
deny <Name> Decline a guild invitation None 1.0.0 No Can only be used if you have no guild
info <Tag> Get information about a Guild None PLANNED No None
join <Tag> Join a public Guild None 1.0.2 No None
create <Name> <Tag> Create a new Guild None 1.0.0 No Can only be used if you have no guild
rank <Player> <Rank> Change a members guild rank LEADER 1.0.0 Yes The rank LEADER can not be set

Permissions

Guild Ranks

Default Guild Rank Name Description Since Notes
ADMIN MEMBER_KICK Allows to kick members out of the guild 1.0.0 None
ADMIN BASE_SET Allows to set the Guild Base 1.0.1 Deletes the old Base Location if already set
ADMIN TOGGLE_PUBLIC Allows to toggle the Public-Mode of the Guild 1.0.2 Public Guilds can be joined by anyone
ADMIN SHOP_PURCHASE Allows to make purchases in the Guild-Store PLANNED None
MODERATOR MEMBER_INVITE Allows to invite members to the guild 1.0.0 None
MODERATOR WARP_SET Allows to set Guild-Warps PLANNED None
MODERATOR WARP_DELETE Allows to delete Guild-Warps PLANNED None
MEMBER WARP_USE Allows to use Guild-Warps PLANNED None
MEMBER BASE_USE Allows to teleport towards the Guild Base PLANNED None
MEMBER CHEST_USE Allows to access Guild-Chests PLANNED None

Trusted

Name Description Enabled by default Since Notes
BASE_USE Allows to teleport towards the Guild Base Yes PLANNED None
WARP_USE Allows to use Guild-Warps Yes PLANNED None

Stats

Name Description Default Value Since Notes
MAX_MEMBERS How many members a guild is capable of holding at max 20 1.0.0 The absolute maximum. Size has to be purchased via Guild Store
MAX_WARPS How many warps a guild is capable of holding at max 10 PLANNED The absolute maximum. Size has to be purchased via Guild Store

Configuration

Main Configuration

Key Default Value Description Since Type Notes
new-guild-created-broadcast true Should a new guild creation be broadcasted? 1.0.0 boolean None
guild-rank-no-permission-message true Should you receive a message if you don't have the needed GuildRank? 1.0.0 boolean None
guild-command-help-with-prefix true Should the plugin's prefix be attached on the help page? 1.0.0 boolean None
guild-command-help <Too long> The messages displayed on the help page 1.0.0 List<String> ColorCodes (&) allowed

Guild Configuration

Main path: Guild.<Key>

Key Default Value Description Since Type Notes
max-name-length 10 How long a Guild Name can be at max 1.0.0 Integer None
max-tag-length 5 How long a Guild Tag can be at max 1.0.0 Integer None
max-invited-size 30 How many invitations a guild is able to hold at the same time 1.0.0 Integer If reached, old invitations need to be deleted in order to invite new players to the guild

Guild Stat Configuration

Main path: Guild.stat.<Key>

Key Default Value Description Since Type Notes
max_members.minValue 5 Max member size on guild creation 1.0.0 Integer None
max_members.maxValue 20 Max member size total 1.0.0 Integer None

Developer

API

Event

# Name Description Cancellable Since Notes
001 GuildCreateEvent Called when a guild is created Yes PLANNED None
002 GuildSettingToggleEvent Called when toggling a setting Yes PLANNED None
003 GuildShopPurchaseEvent Called when purchasing something from the Guild Shop Yes PLANNED None
004 GuildPlayerLeaveEvent Called when leaving a Guild Yes PLANNED None
005 GuildDisbandEvent Called when disbanding a Guild Yes PLANNED None
006 GuildPlayerInviteSendEvent Called when inviting a Player towards the Guild Yes PLANNED None
007 GuildPlayerKickEvent Called when kicking someone out of the Guild Yes PLANNED None
008 GuildPlayerInviteAcceptEvent Called when accepting a Guild invitation Yes PLANNED None
009 GuildPlayerInviteDeclineEvent Called when rejecting a Guild invitation Yes PLANNED None
010 GuildPlayerJoinEvent Called when joining a public Guild Yes PLANNED None
011 GuildPlayerRankChangeEvent Called when changing the Guild Rank of a Player Yes PLANNED None
012 GuildChestOpenEvent Called when opening a Guild Chest Yes PLANNED None
013 GuildChestCloseEvent Called when closing a Guild Chest Yes PLANNED None
014 GuildEconomyAddEvent Called when adding Economy towards the Guild Yes PLANNED None
015 GuildWarStartEvent Called when a GuildWar is starting Yes PLANNED None
016 GuildWarPlayerDeathEvent Called when a Player dies inside a GuildWar Yes PLANNED None
017 GuildWarEndEvent Called when a GuildWar is ending Yes PLANNED GuildWarEndReason (FINISH, SURRENDER, ...)

GuildManager

Source: at.peirleitner.spigotguilds.manager.GuildManager.java

Method Description Since Type Notes
getGuilds() Get all guilds 1.0.0 Collection<Guild> None
getByName(@Nonnull String name) Get a guild by its name 1.0.0 Guild None
getByTag(@Nonnull String tag) Get a guild by its tag 1.0.0 Guild None
isNameTaken(@Nonnull String name) If a name is already taken 1.0.0 boolean None
isTagTaken(@Nonnull String tag) If a tag is already taken 1.0.0 boolean None
getMaxNameLength() Get the maximum name length 1.0.0 Integer Get it from config.yml
getMaxTagLength() Get the maximum tag length 1.0.0 Integer Get it from config.yml
getGuildForPlayer(@Nonnull UUID uuid) Get the guild for a player 1.0.0 Guild None
hasGuild(@Nonnull UUID uuid) If the player has a guild 1.0.0 boolean None
create(@Nonnull Player player, @Nonnull String name, @Nonnull String tag) Create a new guild 1.0.0 void None
accept(@Nonnull Player player, @Nonnull String guildName) Accept a guild invitation 1.0.0 void None
deny(@Nonnull Player player, @Nonnull String guildName) Decline a guild invitation 1.0.0 void None
leave(@Nonnull Player player) Leave your current guild 1.0.0 void None
getGuildRanksAsString() Get all available ranks as a string 1.0.0 String None
save() Save guilds to the .json file 1.0.0 void None

Guild

Source: at.peirleitner.spigotguilds.guild.Guild.java

Method Description Since Type Notes
getName() Get the guild's name 1.0.0 String None
getTag() Get the guild's tag 1.0.0 String None
getMembers() Get the guild's members 1.0.0 HashMap<UUID, GuildRank> None
getGuildRank(@Nonnull UUID uuid) Get a player's GuildRank 1.0.0 GuildRank None
hasMinimumGuildRank(@Nonnull UUID uuid, @Nonnull GuildRank neededGuildRank) Checks if the player has the minimum guild rank 1.0.0 boolean None
setGuildRank(@Nonnull Player player, @Nonnull OfflinePlayer target, @Nonnull GuildRank guildRank) Set a player's guild rank 1.0.0 void None
getStats() Get this guild's stats 1.0.0 HashMap<GuildStat, Integer> None
getInvited() Get the invited player list 1.0.0 Collection<UUID> None
notifyGuildMembers(@Nonnull String message) Notify all guild members 1.0.0 void None
kick(@Nonnull Player player, @Nullable OfflinePlayer target) Kick a member out of the guild 1.0.0 void None
disband() Disband the guild 1.0.0 void None
invite(@Nonnull Player guildMember, @Nullable OfflinePlayer invited) Invite a player to the guild 1.0.0 void None