config.yml

Oct 3, 2017
config.yml
  • [​IMG]
    [​IMG]

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

    Lost? Go back to TextCosmetics' resource page.

    [​IMG]

    See an example of TextCosmetics' config.yml file


    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]

    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]

    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]

    Default(top)


    ColorCredits(top)

    • Acceptable value: Integer
    • Default value: 5

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

    [​IMG]

    Name(top)


    Economy(top)

    • Acceptable value: String
    • Default value: $

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

    [​IMG]

    PlayerPoints(top)

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

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

    [​IMG]

    Layout(top)

    These layouts are used for a Selector's lore, and the messages of Error.Amount and 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)


    ColorCredits(top)


    Use(top)
    • Acceptable value: true or false
    • Default value: true

    The Join.Notify.ColorCredits.Use option enables or disables the join notification of ColorCredits.

    [​IMG]

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

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

    [​IMG]

    Chat_Color(top)


    Use(top)
    • Acceptable value: true or false
    • Default value: true

    The Join.Notify.Chat_Color.Use option enables or disables the join notification of chat color.

    [​IMG]

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

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

    [​IMG]

    Name_Color(top)


    Use(top)
    • Acceptable value: true or false
    • Default value: true

    The Join.Notify.Name_Color.Use option enables or disables the join notification of name color.

    [​IMG]

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

    The Join.Notify.Name_Color.In_Seconds option sets the join notify name color in seconds delay.

    [​IMG]

    Item_Color(top)


    Use(top)
    • Acceptable value: true or false
    • Default value: true

    The Join.Notify.Item_Color.Use option enables or disables the join notification of item color.

    [​IMG]

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

    The Join.Notify.Item_Color.In_Seconds option sets the join notify item color in seconds delay.

    [​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. TextCosmetics uses its own cache system to reduce file and database I/O.

    [​IMG]

    Item_Name(top)


    ColorCredits(top)

    • Acceptable value: Integer
    • Default value: 1

    The Item_Name.ColorCredits option sets the ColorCredits cost for changing your item name.

    [​IMG]

    Economy(top)

    • Acceptable value: Integer
    • Default value: 100

    The Item_Name.Economy option sets the economy cost for changing your item name.

    [​IMG]

    PlayerPoints(top)

    • Acceptable value: Integer
    • Default value: 100

    The Item_Name.Economy option sets the PlayerPoints cost for changing your item name.

    [​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)


    (ColorType)_Color(top)

    • Acceptable value: Integer
    • Default value: 1
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each code ColorCredits (ColorType) color, such as Code_0.ColorCredits.Chat_Color, Code_1.ColorCredits.Name_Color, etc.

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

    [​IMG]

    Economy(top)


    (ColorType)_Color(top)

    • Acceptable value: Integer
    • Default value: 100
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each code economy (ColorType) color, such as Code_0.Economy.Chat_Color, Code_1.Economy.Name_Color, etc.

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

    [​IMG]

    PlayerPoints(top)


    (ColorType)_Color(top)

    • Acceptable value: Integer
    • Default value: 1
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each code PlayerPoints (ColorType) color, such as Code_0.PlayerPoints.Chat_Color, Code_1.PlayerPoints.Name_Color, etc.

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

    [​IMG]

    (ColorType)_Color_Selector(top)


    Name(top)

    • Acceptable value: String
    • Default value: &8&l(ColorType) {word_color_UCF} Selector
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: {word_color_UCF} is a placeholder for the Word_Color option - UCF stands for upper case first; upper case first letter, really. TextCosmetics will automatically format this placeholder when needed.

    The (ColorType)_Color_Selector.Name option sets the name of a Selector.

    [​IMG]

    Height(top)

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

    The (ColorType)_Color_Selector.Height option sets the height of a Selector.

    [​IMG]

    Item(top)


    Code_All(top)


    Name(top)
    • Acceptable value: String
    • Default value: {code_name} (ColorType) {word_color_UCF}
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: {code_name} is a placeholder for the code's name, and {word_color_UCF} is a placeholder for the Word_Color option - UCF stands for upper case first; upper case first letter, really. TextCosmetics will automatically format these placeholders when needed.
    • Note 3: (ColorType)_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, Name_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 (ColorType)_Color_Selector.Item.Code_All.Name option sets the global template of the code name options in a Selector.

    [​IMG]

    Material(top)
    • Acceptable value: String
    • Default value: LEATHER_CHESTPLATE
    • Note: (ColorType)_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, Name_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 (ColorType)_Color_Selector.Item.Code_All.Material option sets the global template of the code material options in a 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} (ColorType) {word_color}'
      - '{code_name_add}'
      - ''
      - ''
      - '&c&nRight click&f to &cremove &r{code_name}'
      - ''
      - '&cRemoving &fthis will make &c{player} (ColorType) {word_color}'
      - '{code_name_remove}'
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: All placeholders will be automatically formatted by TextCosmetics when needed.
    • Note 3: (ColorType)_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, Name_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 (ColorType)_Color_Selector.Item.Code_All.Lore option sets the global template of the code lore options in a Selector.

    [​IMG]

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


    Use(top)
    • Acceptable value: true or false
    • Default value: true

    The (ColorType)_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Use option enables or disables the item from its Selector.

    [​IMG]

    Name(top)
    • Acceptable value: String
    • Default value: {(ColorType)_color_selector_item_code_all_name}
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code name, such as Chat_Color_Selector.Item.Code_0.Name, Name_Color_Selector.Item.Code_1.Name, etc.
    • Note 3: {(ColorType)_color_selector_item_code_all_name} is placeholder which gets its value from the (ColorType)_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 (ColorType)_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Name option sets name of the code in a Selector.

    [​IMG]

    Material(top)
    • Acceptable value: String
    • Default value: {(ColorType)_color_selector_item_code_all_material}
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code material, such as Chat_Color_Selector.Item.Code_0.Material, Name_Color_Selector.Item.Code_1.Material, etc.
    • Note 3: {(ColorType)_color_selector_item_code_all_material} is placeholder which gets its value from the (ColorType)_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 (ColorType)_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Material option sets material of the code in a Selector.

    [​IMG]

    Slot(top)
    • Acceptable value: Integer
    • Default value: (0-53)
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code slot, such as Chat_Color_Selector.Item.Code_0.Slot, Name_Color_Selector.Item_Code_1.Slot, etc.

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

    [​IMG]

    Color(top)

    Red(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code color red, such as Chat_Color_Selector.Item.Code_0.Color.Red, Name_Color_Selector.Item.Code_1.Color.Red, etc.
    • Note 3: The material for the item, which has a color of red, must be a leather type.

    The (ColorType)_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 a Selector.

    [​IMG]

    Green(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code color green, such as Chat_Color_Selector.Item.Code_0.Color.Green, Name_Color_Selector.Item.Code_1.Color.Green, etc.
    • Note 3: The material for the item, which has a color of green, must be a leather type.

    The (ColorType)_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 a Selector.

    [​IMG]

    Blue(top)
    • Acceptable value: Integer
    • Default value: (0-255)
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code color blue, such as Chat_Color_Selector.Item.Code_0.Color.Blue, Name_Color_Selector.Item.Code_1.Color.Blue, etc.
    • Note 3: The material for the item, which has a color of blue, must be a leather type.

    The (ColorType)_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 a Selector.

    [​IMG]

    Lore(top)
    • Acceptable value: String
    • Default value: {(ColorType)_color_selector_item_code_all_lore}
    • Note: (ColorType) is used to stand for either Chat or Name for this config.yml explanation only.
    • Note 2: There is an option for each (ColorType) color selector item code lore, such as Chat_Color_Selector.Item.Code_0.Lore, Name_Color_Selector.Item.Code_1.Lore, etc.
    • Note 3: {(ColorType)_color_selector_item_code_all_lore} is placeholder which gets its value from the (ColorType)_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 (ColorType)_Color_Selector.Item.Code_(0-9, A-F, K-O, R).Lore option sets lore of the code in a Selector.

    [​IMG]

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