GangsX
  • GangsX
  • Overview
    • Features
    • Commands & Permissions
    • Placeholders
    • Changelogs
      • v1.3
      • v1.2
      • v1.1
  • Product Guides
    • Configuring The Plugin
  • Previews
    • config.yml
    • quests.yml
    • tournament.yml
    • locale.yml
  • API Usage
    • Developer API
    • Events
      • GangCreateEvent
      • GangDisbandEvent
      • GangPermissionUpdateEvent
      • GangShopPurchaseEvent
      • PlayerJoinGangEvent
      • PlayerLeaveGangEvent
Powered by GitBook
On this page
  • config.yml - Configuration Options
  • quests.yml
  • tournament.yml
  • pending-actions.yml
  • locale.yml
  1. Product Guides

Configuring The Plugin

A guide on how to change basic settings through the configuration.

When the files are generated, you will notice that there is many files, every single menu within this plugin can be configured inside of GangsX/guis/{menu}.yml, Settings are configured from config.yml, messages from locale.yml, Tournaments from tournament.yml, and quests from quests.yml

config.yml - Configuration Options

  • License Key & Database Connection

  • Plugin Integrations & Toggle debug mode

  • Which statistic Gang Top is ordered by

  • Cache to database save interval

  • Enable Disband GUI

  • Gang Name Regex Validation - Set to only numbers & letters by default

  • Enable Commands - Toggle different commands being enabled

  • Blacklist Gang Names

  • Blacklist Words (used for description)

  • Broadcast Player Options

  • Command Cooldowns

  • Define Gang Role Prefixes & Icons

  • Define Min & Max length for Names, Titles & Descriptions

  • Gang, Ally & SocialSpy chat format

  • Define default gang permissions

  • Define default gang upgrades

  • Configure Gang Levels - Add as many as you want, use any gang statistic in requirements

  • Configure Gang Milestones - Add as many as you want, create them under the statistic configuration section

  • Configure Gang Boosts

quests.yml

  • Define Daily Quests reset Time

  • Define Weekly Quests reset Time

  • Define Weekly Quests reset Day

  • Define the amount of daily quests that will be assigned

  • Define the amount of weekly quests that will be assigned

  • Set the statistic ID, description, target & statistic type

  • Configure the "complete" and "incomplete" GUI item for each quest

  • Set the rewards, commands & sound executed when the quest has been completed.

tournament.yml

  • Define amount of gangs rewarded

  • Configure the "broadcastMinutes" intervals

  • Do NOT manually edit active, startTime, remainingTime, type or gangScores

  • Define all tournament related messages

  • Set all tournament rewards & the message sent if they are in the top amount of gangs defined

pending-actions.yml

  • This file is used to save pending actions, which are generated via the /gadmin executeforall <gang> <command> command. If there are any players in the gang currently offline when the command is executed, then they are stored in this file, and executed against the players UUID when they login.

locale.yml

  • Any other of the plugins messages are stored within this file, There is over 130 messages to configure so have fun :)

Previousv1.1Nextconfig.yml

Last updated 5 months ago