Skip to content

#2 Configuration

zThana edited this page Sep 3, 2024 · 8 revisions

876f2b722154b00aeb2b29c7b9852f18bc6849eb

Placeholders (PlaceholderAPI support)

All placeholders available through PlaceholderAPI are supported within the configuration files. Additionally, " %prefix%" gets translated to the configured prefix string.

You can use hex colors by using the following format: &#RRGGBB (e.g. &#FF0000 for red). You can customize the prefix of hex colors (the "&#" part) in the config.yml file.

For the placeholders shown below, replace "racename" with the name of an existing race.

These placeholders can be used in the configuration files:

Placeholder Description
%player_name% Player's name
%player_displayname% Player's display name
%player_race% Player's race name (for internal use)
%player_race_displayname% Display name of the player's race
%player_race_level% Player's race level (-1 if level system is disabled)

These placeholders can be used in other plugins:

Placeholder Description
%racesofthana_player_race% Player's race (for internal use)
%racesofthana_player_race_displayname% Player's race's display name
%racesofthana_totalcount_racename% Total count of a certain race
%racesofthana_onlinecount_racename% Total online count of a certain race
%racesofthana_race_level% Player's race level (-1 if level system is disabled)
%player_race_experience% Player's race experience (-1 if level system is disabled)

Configuration Files

config.yml

# --------------------------- #
#   Races of Thana // Thana   #
# --------------------------- #

gui-slots: 27
update-reminder: true
force-race-on-join: false # Only works if default-race is not set to "none"

# none = no default race (nullifies force-race-on-join)
# gui = open gui on join
# race-name = no gui, player is race on join
default-race: none

# Are players required to have explicit permissions for each race (true)
# or do they have them all unlocked by default (false)?
# The permission-node per race is racesofthana.race.<racename>
# For example, an elf would need: racesofthana.race.elf
# While this value is set to true, players will not see the races they don't have permissions to within the GUI.
# (Operators and users with * permissions will see it at all times)
per-race-permissions: false

levels:
  enabled: true
  # Level 1 requires 85 XP, level 2 requires 180 XP, level 3 requires 285 XP, and so on
  formula: 50+(25*level)+(10*(level^2))
  level-cap: 100

world-settings:
  # Races are nullified within these worlds.
  blacklisted-worlds:
    - sandbox
    - exampleWorld2
  worldname:
    # permanent-time can either be day or night.
    # The plugin will consider the world to always be stuck in the specified time.
    # Time-based attributes, potion effects, permissions and commands will not go through the day/night cycle.
    # Note that this does not affect the actual time within the world.
    permanent-time: day # The world is considered to be in permanent day-time
  worldname2:
    permanent-time: night # The world is considered to be in permanent night-time

# Race tokens are items that players can use to change their race.
token:
  enabled: true
  # Do players need to have the racesofthana.token.use permission in order to use the token?
  permission-required: false
  # The itemstack the racechange npc will be accepting.
  # If you modify this item, previous copies of the race token will not automatically update and will thus become invalid.
  itemstack:
    display-name: '&6Race Token'
    material: NETHER_STAR
    durability: 0
    lore:
      - '&eGive this to the race npc'
      - '&eto change your race!'
    item-flags:
      - HIDE_ATTRIBUTES
# Every race can have a different token cost, which can be set inside each race's file.
# For example, `token-cost: 2` would require the player to have 2 race tokens in their inventory in order to select that race.

# Decorative items within the race selection GUI.
# Race-specific items are modified within their own configuration file.
gui:
  banner0:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 0
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner1:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 1
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner2:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 2
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner3:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 3
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner4:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 4
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner5:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 5
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner6:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 6
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner7:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 7
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner8:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 8
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner9:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 9
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner10:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 17
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner11:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 18
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner12:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 19
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner13:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 20
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner14:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 21
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner15:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 22
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner16:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 23
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner17:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 24
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner18:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 25
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    item-flags:
      - HIDE_ATTRIBUTES
  banner19:
    display-name: '&0'
    material: BLACK_STAINED_GLASS_PANE
    durability: 0
    slot: 26
    lore:
      - '&4» &cSelect your race!'
      - ''
      - '&6» &3Hover over a race'
      - '&6» &3for more info!'
    enchantments:
      - DURABILITY:1
      - FIRE_ASPECT:1

lang.yml

prefix: '&9Races of Thana&c: '

permissions:
  no_permission: '&cYou do not have permission!'

gui:
  race_gui_name: '&c&eSelect your race!'
  preview_gui_name: '&c&ePreview all races!'

command:
  insufficient_arguments: '&cInsufficient arguments for this command!'
  player_only: '&cThis command can only be used by players!'
  count_header: '&e. . . &6Races of Thana &c- Overview (Online) &e. . .'
  count_line: '&e  » %race_displayname%&c: &7%amount%'
  count_footer: '&e. . . &6End of Overview &e. . .'

token:
  refund: '&cYou were given back your token!'
  give_wrong_item: '&cThat is not a race-token!'
  no_item_in_hand: '&cYou must hold an item in your main hand to set it as the race token!'
  not_enough: '&cYou do not have enough tokens! You need &7%amount%&c.'
  changed: '&aRace token has been changed.'
  not_changed: '&aRace token has not been changed.'
  given: '&aYou have given a race token to %player_displayname%.'
  not_available: '&cRace token is not available.'

player:
  no_race: '&6You don''t have a race!'
  no_race_target: '&c%player_displayname% doesn''t have a race!'
  race_unset: '&6The race of the specified player has been unset!'
  not_specified: '&cYou should specify a player!'
  offline: '&cThat player is offline!'

race:
  invalid: '&cThat race does not exist!'
  home:
    teleport: '&aYou have been teleported to your race''s home!'
    invalid: '&cYour race''s home doesn''t exist!'
  inspect:
    format: '&6You are a(n) %racesofthana_player_race_displayname%&6!'
    format_others: '&6%player_displayname% is a(n) %player_race_displayname%&6!'
  chat:
    format: '&7[%player_race_displayname%&7] &9%player_displayname%&7: &f%message%'
    enabled: '&aRace chat enabled.'
    disabled: '&cRace chat disabled.'

hooks.yml

# If you use CombatLogX, you can make it compatible with Races of Thana by enabling it (set to true).
combatlogx:
  enabled: false
  prevent-in-combat:
    # true = cannot teleport to `/races spawn` in combat
    home-teleport: true
    # true = cannot change race in combat
    change-race: true
    # message player receives when attempting to go to `/races spawn` in combat
    teleport-message: "&cYou cannot teleport to the race spawn while in combat!"
Clone this wiki locally