PixelStudios Documentation

website·Indexed 31 days ago

https://wiki.pixelstudios.dev

Documentation for PixelStudios plugins, including Guilds (and Guilds Tasks), Wool Wars, and EpicAchievements. Covers installation, configuration, player commands, developer APIs, and PlaceholderAPI integration for Minecraft server plugins.

Tokens
19.9K
Snippets
99
Records
150
Agent score
53%

What's inside PixelStudios

  1. Overview of Wool Wars minigame

    Wool Wars is a round-based minigame where two or more teams compete to fill a central arena area with wool. The team with the most points at the end of the match wins. Key gameplay mechanics include:

    • Powerups: Spawn in the arena to provide special effects and perks.
    • Kits: Players select a kit before each round, each featuring a unique special ability that can be used once per round.
  2. Overview of Guilds plugin features

    Guilds is a plugin designed primarily for PVP servers or lobbies that allows players to create, invite, and manage guilds. Key features include:

    • Member Management: Guilds have an owner and members. Members have ranks and toggle preferences for guild chat, join/leave messages, and notifications. Officers can mute or kick members, and ownership can be transferred via /guild transfer.
    • Custom Ranks: Guilds can create ranks with specific display names, permissions, priority, and the ability to set a rank as default.
    • Customization: Guilds can set a unique TAG (with color), a description, and a Message of the Day (MOTD) shown when players join the server.
    • Guild Settings: Options for visibility (public/private) and online mode (filtering commands to show only online members).
    • Progression & Rewards: Includes a leveling system to unlock features, a quest system for experience, custom reward conditions, and a task-based achievement system.
  3. Use Guild-wide placeholders with PlaceholderAPI

    To use these placeholders, you must have PlaceholderAPI installed. These placeholders provide general information about the guild the player belongs to, such as name, level, and member counts.
    %guilds_name%                  - Player's guild name (e.g., LeoGuild)
    %guilds_uuid%                  - Player's guild UUID
    %guilds_level%                 - Player's guild level
    %guilds_xp%                    - Player's guild experience
    %guilds_tag%                   - Player's guild TAG (e.g., LeoTag)
    %guilds_tag_color%              - Tag formatted via config guild-tag.format
    %guilds_tag_formatted%          - Tag formatted via config guild-tag.format
    %guilds_members%                - Total number of guild members
    %guilds_online%                - Number of online guild members
    %guilds_creation_time%          - Guild creation time (long)
    %guilds_creation_time_formatted- Guild creation time (formatted date)
  4. Use Achievement and Tier Placeholders

    These placeholders provide detailed information about specific achievements and their tiers, including progress tracking and requirements:
    {achievement_id}                   - The achievement's unique identifier
    {achievement_name}                 - The achievement's name
    {achievement_description}          - The achievement's description
    {achievement_type}                 - The achievement's type (challenge / tiered)
    {achievement_task}                 - The achievement's task type
    {achievement_progress}             - The player's progress in the achievement
    {achievement_progress_percentage} | The percentage of progress in the achievement
    {achievement_progress_bar}        - A progress bar that displays the current progress
    {achievement_permission}           - The permission required to progress in the achievement
    {achievement_requirements}         - The achievements required to progress in the achievement
    {tier}                              - The tier number
    {tier_roman}                       - The tier number in roman numerals
    {tier_requirement}                 - The requirement to complete the tier
    {tier_rewards}                     - The list of rewards
    {tier_progress_percentage}        - The percentage of progress in the tier
    {tier_progress_bar}               - A progress bar that displays the current tier progress
    {tier_unlock_percentage}          - The percentage of players that have unlocked the tier
    {tier_unlock_date}                - The date when the tier was unlocked
  5. Understand the purpose of Guild Games

    Guild Games are not integrated game modes or plugin features. Instead, they serve as a list of games that a guild typically plays. This metadata is primarily used to allow users to filter guilds by the games they play within the Guild Finder.
  6. Use general guild metadata placeholders

    The following placeholders can be used in commands and menus to display general information about a guild. Note that some placeholders may not be available in all messages or menus.
    PlaceholderDescription
    {guildName}Guild's name
    {players} or {members}Total members count
    {onlinePlayers}Online members count
    {offlinePlayers}Offline members count
    {maxPlayers}Maximum members count
    {description}Guild's description
    {motdEditor}Name of the latest MOTD editor
    {editTime}Latest MOTD edit time
    {creationTime}Formatted guild creation time
    {guildTag}Guild's tag (or 'none' if null)
    {guildTagColor}Guild's tag color
    {guildTagColorName}Guild's tag color name (e.g., DARK_AQUA)
    {guildTagFormatted}Formatted guild's tag (based on guild-tag.format config)
  7. Understand the Guild Quest system mechanics

    The quest system rewards guilds with XP when a specific number of quests are completed within a set time limit. Progress is reset weekly at a configured day and time.
  8. Prerequisites for using Guilds Tasks

    The Guilds Tasks plugin is a separate extension and requires the base Guilds plugin to be installed and active in order to function.
  9. Use guild rank placeholders

    These placeholders provide details about a specific guild rank, including its display name, priority, and formatting.
    PlaceholderDescription
    {rankName}Rank's internal name
    {rankDisplayName}Rank's display name
    {rankTag}Rank's tag
    {rankTagFormatted}Formatted rank's tag (based on guild-rank-tag.format config)
    {rankTagColor}Rank's tag color
    {rankPriority}Rank's priority level
    {rankMembers}Formatted list of members in the rank
  10. Retrieve specific achievement data using placeholders

    To get detailed information about a specific achievement, use the achievement-specific placeholder. You must provide the achievement <id> and the specific data type requested. The [tier] argument is optional and defaults to 1 if omitted.
    %achievements_achievement_<id>_<points/requirement/progress/percentage/bar/unlocked/date>_[tier]%
  11. Use Category Placeholders

    Use these placeholders to display information about a specific achievement category:
    {category_id}           - The category's unique identifier
    {category_name}         - The category's name
    {category_description}  - The description of the category
    {category_permission}   - The permission required to access the category
    {category_achievements} | The number of achievements in the category
    {category_servers}      - The servers where the achievements can be completed