🧰Setting up

Here are the most important settings for the plugin, which are best set from the very beginning of working with it.

Basic settings

Language

You can install one of the available languages. Then just restart the server or the plugin. If your language is not on the list, then just open the plugin folder -> Messages -> en.yml and translate it for yourself!

# ╔═════════════════════════════════════════╗
# β•‘         BASIC GENERAL SETTINGS          β•‘
# β•‘  Languages: en,de,fr,ru,pl,it,es,cz,ch  β•‘
# β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

Language: 'en'

If you have groups with different permissions on your server, for example LuckPerms, then you need to specify their seniority. The standard group comes first. At the end with the highest number is the best one.

Format: group: [lvl of the role, 'Name to display in the plugin']

# βž₯ You need to specify here ALL privileges on your server, their priority and how it will be displayed in the plugin.
#    "default" group is the lowest (ALL PLAYERS HAVE IT AND IT SHOULD STAY THERE!!!)
All groups:
  default: [1, "&7[Default]"]
  vip: [2, "&d[VIP]"]
  premium: [3, "&b[PREMIUM]"]
  elite: [4, "&6[ELITE]"]
  

If you want temporary roles not to be removed when a role is set in LuckPerms via "set", then enable this option.

# βž₯ When this function is active, when adding a non-temporal group via set or when deleting, temporary groups will not be deleted.
Use LuckPerms listeners: false

If you have several servers that you want to connect with each other so that the player receives a grant on several servers at once, then activate this option. If players will only receive grants on the server they were given, then you do not need to activate this!

# ╔═════════════════════════════════════════╗
# β•‘             MYSQL SETTINGS              β•‘
# β•‘  By default, saving is done in SQLite.  β•‘
# β•‘  If you want to, for example, connect   β•‘
# β•‘  several servers at once, use MySQL.    β•‘
# β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

MySQL enable: false
MySQL database:
  host: localhost
  port: 3306
  database: db
  user: username
  password: password

# βž₯ List of servers that is needed to be displayed in history so that players do not see the real IP of the server.
Servers list: []
#  - ['53.106.75.23', '&5&lHUB']

In the Servers list option you can specify a list of servers. It is needed only for a beautiful display, for example in the history placeholder, to understand on which server the grant was issued! And so that the player does not see the IP!

IP of the server you can find in the console, when server starts. How to get this IP

Format: - ['IP', 'Custom name']

Grant settings

I will give an example based on the privilege grant, since it has more options. In general, all the information is already written in the config. There will only be a little more here.

Privilege grants:
  privilege_grant_1:
    privilege: 'premium'
    commands:
      - 'lp user %player% parent addtemp %privilege% %duration%s'
    commands-to-cancel:
      - 'lp user %player% parent removetemp %privilege%'
    command-has-timer: true
    command-uses-database: true
    servers: []
    page: 1
    slot: 11
    material: 'EMERALD_BLOCK'
    custom-model-data: 0
    glowing: false
    title: '&b[PREMIUM]'
    lore: []
    list-of-groups:
      elite:
        cooldown: 300
        how-much-can-it-give-out: 1
        can-it-give-other-items-during-cooldown: false
        can-it-give-out-other-grant-types-during-cooldown: false
        can-player-who-has-received-group-give-groups-to-others: false
        can-give-to-all-players: false
        can-it-be-canceled: false
        can-replace-higher-one: false
        durations:
          10:
            duration: 86400
            material: 'f081f9274e4ef802453ac95381c00426e462440d3bb085fb3afefa6ded6a8d01'
            custom-model-data: 0
            glowing: false
            title: '#ff702924 Hours'
            lore: []

privilege_grant_1 - Grant name. It can be anything, but it must consist of numbers and letters, without spaces. It will be used further for issuing and for saving in the config. It must not be repeated!

privilege - The name of the privilege that will be issued. If you are issuing a group (for example, vip with LuckPerms), then you must specify it! If this is, for example, the /fly command, then simply specify any name that will be displayed! For example: &b&lFLY

commands - Commands to be executed. There may be several. Placeholders you may need: %player%, %player_who_gave%, %privilege%, %duration%. For example, I grant the LuckPerms privilege with this command:

lp user %player% parent addtemp %privilege% %duration%s

When they are replaced, the command will look something like this:

lp user MineShimado parent addtemp vip 86400s

As you noticed, there is an "s" at the end. The command will output exactly 86400 seconds. Since the duration in the plugin is specified only in seconds.

commands-to-cancel - These are commands that will be executed upon expiration. Or upon cancellation. Everything is the same as for the command.

command-has-timer - If the command have a built-in timer. In the example with the command above, it does. But if you issue a creative mode for an hour, then the command does not have a time limit, so it will be false.

command-uses-database - If you use a plugin with MySQL and you use a command from another plugin that supports MySQL and processes the command itself on several servers. An example would also be issuing a role in LuckPerms. A player who receives a role on one server receives it on another. But if LuckPerms does not have MySQL enabled, then leave this option disabled.

servers - List of servers on which the grant will be issued. If the list is empty, then only on your current server. The IP should be the one shown when the Grant plugin is loaded. The IP of the server on which the grant is issued is mandatory! If you play without MySQL, you dont need it! How to get current IP

page - The page where this grant will be in the GUI.

slot - The slot where this grant will be in the GUI.

material - Material of the grant icon in the GUI.

custom-model-data - Custom model data for the grant icon in the GUI. If you want to apply a texture.

glowing - Will the icon shimmer?

title - Title of the grant icon in the GUI.

lore - Description of the grant icon in the GUI.

list-of-groups - This specifies the groups that can issue this grant. The most standard role is default.

cooldown - This is how long the reload time for issuing will be in seconds.

how-much-can-it-give-out - This is how many grants a player can issue of this type. The cooldown starts immediately after issuing 1, but you can still issue!

can-it-give-other-items-during-cooldown - Will he be able to issue other grants of the same type after issuing this grant? In this case, privileges.

can-it-give-out-other-grant-types-during-cooldown - Will he be able to issue other types of grants after issuing this grant. In this case, items and commands. But issuing privileges depends on the option above.

can-player-who-has-received-group-give-groups-to-others - If the user has a role issued by the plugin, it will prohibit issuing.

can-give-to-all-players - Allows, or vice versa, mass issuance, and not just to 1 player.

can-it-be-canceled - Can a granted privilege be manually revoked?

can-replace-higher-one - If you issue a group, it either prohibits or allows issuing a lower group.

durations - List of terms for which you can issue a privilege.

10 - Slots of the duration icon in the GUI. Can be from 0 to 53.

duration - Duration in seconds. ONLY SECONDS. You can set to -1 and duration will be infinite. But it will be 99999999 seconds in fact.

material - Material of the duration icon in the GUI.

custom-model-data - Custom model data of the duration icon in the GUI. If you want to apply a texture.

glowing - Will the icon shimmer?

title - Title of the duration icon in the GUI.

lore - Duration of the duration icon in the GUI.

Last updated