Skip to content

Latest commit

 

History

History
502 lines (358 loc) · 19.9 KB

plugin-files-explained.mdx

File metadata and controls

502 lines (358 loc) · 19.9 KB
Raw
id title sidebar_label
files
Plugin files explained
Plugin files explained

import FileFetch from '@site/src/components/FileFetch'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

a.k.a Plugin configuration section

Basic files

arenas.yml

This file is only for in-game usage. It's not recommended to edit it while the server is on! The file contains all information about created arenas. <Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

bungee.yml

BungeeCord configuration is there. You must enable bungee support first in config.yml. Set BungeeActivated to true to enable it.

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

:::note What is MOTD Manager? MOTD Manager modifies server's MOTD to make it readable by Server Bungeecord systems like Timo Cloud, CloudNet and Bungee Signs. MOTD is based on game state if that option is enabled. :::

config.yml

config.yml is very well commented. No need to explain more any part of it.

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

mysql.yml

Here you can set up MySQL plugin configuration. You need to enable MySQL first in config.yml. Set DatabaseActivated option to true.

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

rewards.yml

Here you can set up rewards that your players can get after specific triggers. Commands are executed by default BY CONSOLE, use "p:" to preform command by player. You can also use chance to execute command adding "chance(NUMBER):" (ex chance(10):) at the beginning of command. Learn more about the Placeholders you can use at rewards.yml

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

spectator.yml

Edit the spectator menu items

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

special_items.yml

Edit the special items, you can get on different plugin stages. Stages:

  • SERVER_JOIN,
  • WAITING_FOR_PLAYERS,
  • ENOUGH_PLAYERS_TO_START,
  • LOBBY,
  • IN_GAME,
  • SPECTATOR,
  • ENDING

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

permissions.yml

Set your own permission to boost specific groups or players. You can also look up the custom permission part of the wiki, see custom permissions

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

powerups.yml

Set up different powerups to make the minigame more fun. You can add as much as you want! Make sure to enable powerups on your config.yml

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

Additional plugin specific files

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

Additional content

Language and locales

Plugin is 95% translatable via language.yml and some other additional files such as special_items.yml.

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}>

However, you can use localization support which is implemented in our plugins.

To change locale of plugin go to config.yml and modify locale value. :::warning Our locales system generates temporary files on ~/locales

The only file you should edit is the language.yml on the main plugin folder! :::

How can I edit my locale?

:::important We have been looking for a perfect solution for a very long time. Currently you can change your locale by editing the language.yml. It works like this: The plugin loads the selected locale and everything in the language.yml that doesn't match the standard English sentence. It overwrites the locale and so you have your locale overwritten. So always remember to edit only in the language.yml. :::

Valid localizations:

Type the following command to see a list of available locales!

<Tabs groupId="minigame" defaultValue="villagedefense" queryString values={[ {label: 'VillageDefense', value: 'villagedefense',}, {label: 'BuildBattle', value: 'buildbattle',}, {label: 'MurderMystery', value: 'murdermystery',}, {label: 'TheBridge', value: 'thebridge',}, ]}> 

/villagedefenseadmin locales <arenaname>

/buildbattleadmin locales <arenaname>

/murdermysteryadmin locales <arenaname>

/thebridgeadmin locales <arenaname>

:::tip You can always translate our plugin for free by joining here (click) :::

Stats storage types

Current stats storage types for player statistics:

  • Flat file (.yml) - enabled by default
  • MySQL (database) - can be enabled in config.yml (see mysql.yml)