ChatCosmetics config.yml

Aug 10, 2017
ChatCosmetics config.yml
  • [​IMG]
    [​IMG]

    Welcome to ChatCosmetics' config.yml Wiki
    This is the config.yml page for the Wiki of ChatCosmetics.

    Lost? Go back to ChatCosmetics' resource page.

    [​IMG]

    Code (Text):
    MySQL:
      Use: false
      Host: localhost
      Port: 3306
      Database: minecraft
      Username: user
      Password: pass
    Currency:
      Use:
        ColorCredits: true
        Economy: false
        PlayerPoints: false
      Default:
        ColorCredits: 5
      Name:
        Economy: $
        PlayerPoints: Point(s)
      Layout:
        ColorCredits: '{amount} {name}'
        Economy: '{name}{amount}'
        PlayerPoints: '{amount} {name}'
    Join:
      Notify:
        In_Seconds:
          ColorCredits: 3
          Chat_Color: 3
    Save:
      In_Minutes:
        Cache_To_Storage: 5
    Code_0:
      Name: Black
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_1:
      Name: Dark Blue
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_2:
      Name: Dark Green
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_3:
      Name: Dark Aqua
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_4:
      Name: Dark Red
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_5:
      Name: Dark Purple
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_6:
      Name: Gold
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_7:
      Name: Gray
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_8:
      Name: Dark Gray
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_9:
      Name: Blue
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_A:
      Name: Green
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_B:
      Name: Aqua
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_C:
      Name: Red
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_D:
      Name: Light Purple
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_E:
      Name: Yellow
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_F:
      Name: White
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_K:
      Name: Magic
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_L:
      Name: Bold
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_M:
      Name: Strike
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_N:
      Name: Underline
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_O:
      Name: Italic
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Code_R:
      Name: Reset
      ColorCredits: 1
      Economy: 100
      PlayerPoints: 1
    Chat_Color_Selector:
      Name: '&8&lChat Color Selector'
      Height: 6
      Item:
        Code_All:
          Name: '{code_name} Chat {word_color_UCF}'
          Material: LEATHER_CHESTPLATE
          Lore:
          - ''
          - '&a&nLeft click&f to &aadd &r{code_name}&r &7({currency_layout})'
          - ''
          - '&aAdding &fthis will make &a{player} chat {word_color}'
          - '{code_name_add}'
          - ''
          - ''
          - '&c&nRight click&f to &cremove &r{code_name}'
          - ''
          - '&cRemoving &fthis will make &c{player} chat {word_color}'
          - '{code_name_remove}'
        Code_0:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 15
          Color:
            Red: 0
            Green: 0
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_1:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 8
          Color:
            Red: 0
            Green: 0
            Blue: 128
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_2:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 4
          Color:
            Red: 0
            Green: 128
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_3:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 7
          Color:
            Red: 0
            Green: 128
            Blue: 128
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_4:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 0
          Color:
            Red: 128
            Green: 0
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_5:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 11
          Color:
            Red: 128
            Green: 0
            Blue: 128
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_6:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 2
          Color:
            Red: 255
            Green: 165
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_7:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 13
          Color:
            Red: 192
            Green: 192
            Blue: 192
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_8:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 14
          Color:
            Red: 128
            Green: 128
            Blue: 128
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_9:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 9
          Color:
            Red: 9
            Green: 0
            Blue: 255
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_A:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 5
          Color:
            Red: 0
            Green: 255
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_B:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 6
          Color:
            Red: 0
            Green: 255
            Blue: 255
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_C:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 1
          Color:
            Red: 255
            Green: 0
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_D:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 10
          Color:
            Red: 255
            Green: 0
            Blue: 255
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_E:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 3
          Color:
            Red: 255
            Green: 255
            Blue: 0
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_F:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: '{chat_color_selector_item_code_all_material}'
          Slot: 12
          Color:
            Red: 255
            Green: 255
            Blue: 255
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_K:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: DRAGON_EGG
          Slot: 29
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_L:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: DOUBLE_PLANT
          Slot: 27
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_M:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: FIREWORK
          Slot: 30
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_N:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: STRING
          Slot: 31
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_O:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: STICK
          Slot: 28
          Lore:
          - '{chat_color_selector_item_code_all_lore}'
        Code_R:
          Name: '{chat_color_selector_item_code_all_name}'
          Material: CAULDRON_ITEM
          Slot: 45
          Lore:
          - ''
          - '&a&nLeft click&f to {code_name} &7({currency_layout})'
          - ''
          - ''
          - '&a{code_name}ting &fwill make {player} chat {word_color}'
          - '{word_plain}'

    MySQL(top)


    Use(top)

    • Acceptable value: true or false
    • Default value: false

    The MySQL.Use option enables or disables MySQL support.

    If true, players' chat and name color and ColorCredits will be stored into the defined MySQL database.

    [​IMG]

    Host(top)

    • Acceptable value: String
    • Default value: localhost

    The MySQL.Host option sets the MySQL host.

    [​IMG]

    Port(top)

    • Acceptable value: Integer
    • Default value: 3306

    The MySQL.Port option sets the MySQL port.

    [​IMG]

    Database(top)

    • Acceptable value: String
    • Default value: minecraft
    • Note: The database must already exist.

    The MySQL.Database option sets the MySQL database.

    [​IMG]

    Username(top)

    • Acceptable value: String
    • Default value: user

    The MySQL.Username option sets the MySQL username.

    [​IMG]

    Password(top)

    • Acceptable value: String
    • Default value: pass

    The MySQL.Password option sets the MySQL password.

    [​IMG]

    Currency(top)


    Use(top)


    ColorCredits(top)

    • Acceptable value: true or false
    • Default value: true

    The Currency.Use.ColorCredits option enables or disables the ColorCredits.

    If true, players will be charged ColorCredits when changing their chat and name color.

    [​IMG]

    [​IMG]

    Economy(top)

    • Acceptable value: true or false
    • Default value: false
    • Note: This option requires Vault.

    The Currency.Use.Economy option enables or disables the economy.

    If true, players will be charged currency from your server's economy when changing their chat and name color.

    [​IMG]

    [​IMG]

    PlayerPoints(top)

    • Acceptable value: true or false
    • Default value: false
    • Note: This option requires PlayerPoints.

    The Currency.Use.PlayerPoints option enables or disables the PlayerPoints.

    If true, players will be charged currency from your server's PlayerPoints when changing their chat and name color.

    [​IMG]

    [​IMG]

    Default(top)


    ColorCredits(top)

    • Acceptable value: Integer
    • Default value: 5

    The Currency.Default.ColorCredits option sets the default ColorCredits amount.

    [​IMG]

    [​IMG]

    Name(top)


    Economy(top)

    • Acceptable value: String
    • Default value: $

    The Currency.Name.Economy option sets the name for economy.

    [​IMG]

    [​IMG]

    PlayerPoints(top)

    • Acceptable value: String
    • Default value: Point(s)

    The Currency.Name.PlayerPoints option sets the name for PlayerPoints.

    [​IMG]

    [​IMG]

    Layout(top)

    These layouts are used for a Selector's lore, and the messages of Error.Amount and Chat_Color.Charge.

    ColorCredits(top)

    • Acceptable value: String
    • Default value: {amount} {name}

    The Currency.Layout.ColorCredits option sets the currency layout for ColorCredits.

    [​IMG]

    Economy(top)

    • Acceptable value: String
    • Default value: {name}{amount}

    The Currency.Layout.Economy option sets the currency layout for economy.

    [​IMG]

    PlayerPoints(top)

    • Acceptable value: String
    • Default value: {amount} {name}

    The Currency.Layout.PlayerPoints option sets the currency layout for PlayerPoints.

    [​IMG]

    Join(top)


    Notify(top)


    In_Seconds(top)


    ColorCredits(top)
    • Acceptable value: Integer
    • Default value: 3

    The Join.Notify.In_Seconds.ColorCredits option sets the join notify, in seconds, ColorCredits delay.

    [​IMG]

    [​IMG]

    Chat_Color(top)
    • Acceptable value: Integer
    • Default value: 3

    The Join.Notify.In_Seconds.Chat_Color option sets the join notify, in seconds, chat color delay.

    [​IMG]

    [​IMG]

    Save(top)


    In_Minutes(top)


    Cache_To_Storage(top)

    • Acceptable value: Integer
    • Default value: 5

    The Save.In_Minutes.Cache_To_Storage option sets the save, in minutes, cache to storage repeat time. ChatCosmetics uses its own cache system to reduce file and database I/O.

    [​IMG]

    Code_(0-9, A-F, K-O, R)(top)


    Name(top)

    • Acceptable value: String
    • Default value: See default code names in Colors and Formats Wiki.
    • Note: There is an option for each code name, such as Code_0.Name, Code_1.Name, etc.

    The Code_(0-9, A-F, K-O, R).Name option sets the name for code (0-9, A-F, K-O, R)

    [​IMG]

    ColorCredits(top)

    • Acceptable value: Integer
    • Default value: 1
    • Note: There is an option for each code ColorCredits, such as Code_0.ColorCredits, Code_1.ColorCredits, etc.

    The Code_(0-9, A-F, K-O, R).ColorCredits option sets the ColorCredits cost for changing your chat color to code (0-9, A-F, K-O, R)

    [​IMG]

    Economy(top)

    • Acceptable value: Integer
    • Default value: 100
    • Note: There is an option for each code economy, such as Code_0.Economy, Code_1.Economy, etc.

    The Code_(0-9, A-F, K-O, R).Economy.Chat_Color option sets the economy cost for changing your chat color to code (0-9, A-F, K-O, R)

    [​IMG]

    PlayerPoints(top)

    • Acceptable value: Integer
    • Default value: 1
    • Note: There is an option for each code PlayerPoints, such as Code_0.PlayerPoints, Code_1.PlayerPoints, etc.

    The Code_(0-9, A-F, K-O, R).PlayerPoints option sets the PlayerPoints cost for changing your chat color to code (0-9, A-F, K-O, R)

    [​IMG]

    Chat_Color_Selector(top)


    Name(top)

    • Acceptable value: String
    • Default value: &8&lChat {word_color_UCF} Selector
    • Note: {word_color_UCF} is a placeholder for the Word_Color word in ChatCosmetics' words.yml file. UCF stands for upper case first; upper case first letter, really. ChatCosmetics will automatically format this placeholder when needed.

    The Chat_Color_Selector.Name option sets the name of the Chat Color Selector.

    [​IMG]

    [​IMG]

    Height(top)

    • Acceptable value: Integer, 1-6
    • Default value: 6

    The Chat_Color_Selector.Height option sets the height of the Chat Color Selector.

    [​IMG]

    [​IMG]

    Item(top)


    Code_All(top)


    Name(top)
    • Acceptable value: String
    • Default value: {code_name} Chat {word_color_UCF}
    • Note: {code_name} is a placeholder for the code's name, and {word_color_UCF} is a placeholder for the Word_Color word in ChatCosmetics' words.yml file. UCF stands for upper case first; upper case first letter, really. ChatCosmetics will automatically format these placeholders when needed.
    • Note 2: Chat_Color_Selector.Item.Code_All.Name is used as a global template for the following code options - such as Chat_Color_Selector.Item.Code_0.Name, Chat_Color_Selector.Item.Code_1.Name, etc. You can make use this global template to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_All.Name option sets the global template of the code name options in the Chat Color Selector.

    [​IMG]

    Material(top)
    • Acceptable value: String
    • Default value: LEATHER_CHESTPLATE
    • Note: Chat_Color_Selector.Item.Code_All.Material is used as a global template for the following code options - such as Chat_Color_Selector.Item.Code_0.Material, Chat_Color_Selector.Item.Code_1.Material, etc. You can make use this global template to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_All.Material option sets the global template of the code material options in the Chat Color Selector.

    [​IMG]

    Lore(top)
    • Acceptable value: String
    • Default value:
      Code (Text):
      - ''
      - '&a&nLeft click&f to &aadd &r{code_name}&r &7({currency_layout})'
      - ''
      - '&aAdding &fthis will make &a{player} chat {word_color}'
      - '{code_name_add}'
      - ''
      - ''
      - '&c&nRight click&f to &cremove &r{code_name}'
      - ''
      - '&cRemoving &fthis will make &c{player} chat {word_color}'
      - '{code_name_remove}'
    • Note: All placeholders will be automatically formatted by ChatCosmetics when needed.
    • Note 2: Chat_Color_Selector.Item.Code_All.Lore is used as a global template for the following code options - such as Chat_Color_Selector.Item.Code_0.Lore, Chat_Color_Selector.Item.Code_1.Lore, etc. You can make use this global template to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_All.Lore option sets the global template of the code lore options in the Chat Color Selector.

    [​IMG]

    Code_(0-9, A-F, K-O, R)(top)


    Name(top)
    • Acceptable value: String
    • Default value: {chat_color_selector_item_code_all_name}
    • Note: There is an option for each chat color selector item code name, such as Chat_Color_Selector.Item.Code_0.Name, Chat_Color_Selector.Item.Code_1.Name, etc.
    • Note 2: {chat_color_selector_item_code_all_name} is placeholder which gets its value from the Chat_Color_Selector.Item.Code_All.Name option. You can make use this placeholder to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Name option sets name of the code in the Chat Color Selector.

    [​IMG]

    Material(top)
    • Acceptable value: String
    • Default value: {chat_color_selector_item_code_all_material}
    • Note: There is an option for each chat color selector item code material, such as Chat_Color_Selector.Item.Code_0.Material, Chat_Color_Selector.Item.Code_1.Material, etc.
    • Note 2: {chat_color_selector_item_code_all_material} is placeholder which gets its value from the Chat_Color_Selector_Item_Code_All.Material option. You can make use this placeholder to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Material option sets material of the code in the Chat Color Selector.

    [​IMG]

    Slot(top)
    • Acceptable value: Integer
    • Default value: (0-53)
    • Note: There is an option for each chat color selector item code slot, such as Chat_Color_Selector.Item.Code_0.Slot, Chat_Color_Selector.Item_Code_1.Slot, etc.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Slot option sets slot of the code in the Chat Color Selector.

    [​IMG]

    Color(top)

    Red(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: There is an option for each chat color selector item code color red, such as Chat_Color_Selector.Item.Code_0.Color.Red, Chat_Color_Selector.Item.Code_1.Color.Red, etc.
    • Note 2: The material for the item, which has a color of red, must be a leather type.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Color.Red option sets color red of the code item's leather type in the Chat Color Selector.

    [​IMG]

    Green(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: There is an option for each chat color selector item code color green, such as Chat_Color_Selector.Item.Code_0.Color.Green, Chat_Color_Selector.Item.Code_1.Color.Green, etc.
    • Note 2: The material for the item, which has a color of green, must be a leather type.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Color.Green option sets color green of the code item's leather type in the Chat Color Selector.

    [​IMG]

    Blue(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: There is an option for each chat color selector item code color blue, such as Chat_Color_Selector.Item.Code_0.Color.Blue, Chat_Color_Selector.Item.Code_1.Color.Blue, etc.
    • Note 2: The material for the item, which has a color of blue, must be a leather type.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Color.Blue option sets color blue of the code item's leather type in the Chat Color Selector.

    [​IMG]

    Lore(top)
    • Acceptable value: String
    • Default value: {chat_color_selector_item_code_all_lore}
    • Note: There is an option for each Chat color selector item code lore, such as Chat_Color_Selector.Item.Code_0.Lore, Chat_Color_Selector.Item.Code_1.Lore, etc.
    • Note 2: {chat_color_selector_item_code_all_lore} is placeholder which gets its value from the Chat_Color_Selector.Item.Code_All.Lore option. You can make use this placeholder to save time, or you can edit each code option individually.

    The Chat_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Lore option sets lore of the code in the Chat Color Selector.

    [​IMG]

    Go back to ChatCosmetics' resource page.
  • Loading...
  • Loading...