Skip to content

Configurations

Jump to bottom
NFRCG edited this page Aug 22, 2023 · 1 revision

config.yml

This configuration is responsible for all plugin messages and settings. The full configuration (without comments) can be found here.

Messages

  • All messages support MiniMessage and PlaceholderAPI parsing.
  • Messages and some settings can be reloaded using /credits reload.
  • Changing the command prefix will only apply after a server restart.
prefix: '<hover:show_text:''<green><viewer>: <viewer_credits> Credits''><gold><bold>CREDITS</bold> '
add-user: <target> has been added to the database!
argument-parse-failure-no-input-was-provided: No input was provided
argument-parse-failure-boolean: Could not parse boolean from <input>
argument-parse-failure-enum: '<input> is not one of the following: <acceptableValues>'
argument-parse-failure-flag-unknown-flag: Unknown flag <flag>
argument-parse-failure-flag-duplicate-flag: Duplicate flag <flag>
argument-parse-failure-flag-no-flag-started: No flag started. Don't know what to do with <input>
argument-parse-failure-number: <input> is not a valid number in the range <min> to <max>
argument-parse-failure-player: <red><input> does not exist in our database!
argument-parse-failure-string: <input> is not a valid string of type <stringMode>
argument-parsing: '<red>Error: <argument_error>'
balance: <green>You have <sender_credits> credits! You have redeemed <sender_redeemed> Credits.
balance-other: <green><target> has <target_credits> credits! They have redeemed <target_redeemed> Credits.
cancel-prompt: <red>You have cancelled the current operation.
command-execution: <red>There was an error executing this command!
command-prefix: credits
credits-add: <green>You have given <amount> Credits to <target>.
credits-add-all: <green>You have given <amount> Credits to all online players!
credits-add-user: <green><amount> Credits have been added to your balance by <sender>. You have <target_credits> Credits.
credits-pay: <green>You have paid <amount> Credits to <target>. You now have <sender_credits> Credits.
credits-pay-same-user: <red>Users cannot pay themselves! Cancelling transaction...
credits-pay-user: <green><sender> has paid you <amount> credits. You have <target_credits> credits.
credits-redeem: <green>You have redeemed <amount> Credits into <skill>. You have <target_credits> Credits remaining.
credits-redeem-all: <green>You have redeemed <amount> Credits into <skill> for all online players!
credits-redeem-prompt: <gray>How many credits would you like to redeem into <green><skill>? <gray>You have <green><sender_credits> <gray>Credits available.
credits-redeem-sudo: <green>You have redeemed <amount> Credits into <skill> for <target>. They have <target_credits> Credits remaining.
credits-redeem-user: <green><sender> has redeemed <amount> Credits into <skill> for you! You have <target_credits> Credits remaining.
credits-set: <yellow>You have set <target>'s Credits to <amount>.
credits-set-all: <yellow>You have the credit balance of all online players to <amount>!
credits-set-user: <yellow>Your MCMMO Credit balance has been set to <amount> by <sender>.
credits-take: <red>You have taken <amount> Credits from <target>.
credits-take-all: <red>You have taken <amount> Credits from  all online players!
credits-take-user: <red>You had <amount> removed from your Credit balance by <sender>. You now have <target_credits> Credits.
invalid-leaderboard: <#FF253C>This leaderboard page is invalid or not enabled!
invalid-sender: '<red>Invalid command sender! You must be of type: <gray><correct_sender>'
invalid-syntax: '<red>Invalid syntax! Correct syntax: <gray><correct_syntax>'
leaderboard-entry: '<rank>. <green><target>: <white><target_credits>'
leaderboard-title: <#FF253C>MCMMO Credits Leaderboard
login-message: <hover:show_text:'<green>You have <sender_credits> credits!'><yellow>Hover to see your MCMMO Credit balance!
mcmmo-profile-fail: The mcMMO Profile for <target> is not loaded! Aborting operation...
mcmmo-skill-cap: <red>You cannot redeem this many credits into <skill>, due to the Level Cap (<cap>).
no-permission: '<hover:show_text:''<red>Required permission: <permission>''><red>You do not have permission to do this!'
not-enough-credits: <red>You do not have enough credits to do this!
not-enough-credits-other: '<red><target> does not have enough credits for: <transaction>!'
reload: <green>The configuration file has been reloaded.

Settings

  • Database and Converter settings cannot be reloaded.

Plugin Settings

settings:
  add-user-message: true
  metrics-enabled: true
  leaderboard-enabled: false
  leaderboard-page-size: 10
  send-login-message: true
  user-tab-complete: true

Database Settings

  • All options are ignored except when the database type is MYSQL.
  • Database settings cannot be reloaded.
  • The "url" section represents a JDBC URL used by MYSQL. H2 and SQLITE URLs are created programmatically.
settings:
  database:
    type: H2
    url: jdbc:mysql://127.0.0.1:3306/DATABASE_NAME
    user: root
    password: passw0rd+

Converter Settings

  • How to use the Converter can be found here.
  • Converter settings cannot be reloaded.
converter:
  type: INTERNAL
  old-database:
    type: H2
    url: jdbc:mysql://127.0.0.1:3306/DATABASE_NAME
    user: root
    password: passw0rd+
  failure-delay: 60000
  request-delay: 300
  enabled: false

menu.yml

This configuration is responsible for editing the /credits menu GUI. The menu is composed of items. Each item and some basic properties can be configured as shown below.

  • All options can be reloaded via /credits reload. All item names and lores support full message parsing.
  • Placeholders within item names and lores will update every 20 ticks (1s). Inventory titles do not update, but will parse placeholders when first opened.
  • The "fill" item is used to populate the border around all other items. Slot option is ignored.
  • The "navigation" item is used to enable navigation. Can be used to link to another GUI command (for example, a /shop).
  • The items named after MCMMO skills can be clicked in order to redeem credits. A chat prompt will appear asking the user how many credits they'd like to redeem into a skill. They can enter an amount, or type "cancel" to cancel the transaction.
title: <dark_gray>Redeem Your Credits...
slots: 45
fill: false
navigation: false
items:
  repair:
    name: <yellow>Repair
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 20
    material: ANVIL
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  herbalism:
    name: <yellow>Herbalism
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 16
    material: SUGAR_CANE
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  fishing:
    name: <yellow>Fishing
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 15
    material: FISHING_ROD
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  axes:
    name: <yellow>Axes
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 13
    material: NETHERITE_AXE
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  swords:
    name: <yellow>Swords
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 21
    material: NETHERITE_SWORD
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  alchemy:
    name: <yellow>Alchemy
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 11
    material: BREWING_STAND
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  mining:
    name: <yellow>Mining
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 19
    material: NETHERITE_PICKAXE
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  fill:
    name: ''
    lore: []
    slot: 0
    material: BLACK_STAINED_GLASS_PANE
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  acrobatics:
    name: <yellow>Acrobatics
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 10
    material: NETHERITE_BOOTS
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  woodcutting:
    name: <yellow>Woodcutting
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 25
    material: OAK_LOG
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  navigation:
    name: <red>Previous Menu
    lore:
    - <gray>Left Click to go back!
    slot: 40
    material: COMPASS
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
    command: credits menu
  excavation:
    name: <yellow>Excavation
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 14
    material: NETHERITE_SHOVEL
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  unarmed:
    name: <yellow>Unarmed
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 24
    material: CARROT_ON_A_STICK
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  archery:
    name: <yellow>Archery
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 12
    material: BOW
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
  taming:
    name: <yellow>Taming
    lore:
    - <yellow><sender>, click here to redeem!
    slot: 23
    material: LEAD
    amount: 1
    texture: ''
    custom-model-data: 0
    glow: false
Clone this wiki locally