Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.26 KB

README.md

File metadata and controls

87 lines (61 loc) · 3.26 KB
Raw

Plugin Permissions

A repository holding plugin permissions for Ultra Permissions.

Overview

Ultra Permissions simplifies searching for permissions by suggesting them based on installed plugins. The permission suggestions will be retrieved from this file.

After that, it will try to extract missing permission nodes from the plugin JARs.

That means that the database will always have priority.

If you can't find suggestions for your installed plugins, that means this specific plugin is not included in our database yet and Ultra Permissions was not able to extract the nodes automatically.

In that case, you can contribute new permissions here.

Contribute permissions

Contributing permissions is a tedious process but is highly appreciated to complete the database!

Instructions

  • pick a plugin that hasn't been added yet or one that needs updates
  • add all its permissions line by line
    • make sure to keep the format which is shown below
    • for easier editing use the tool shown below
  • create a pull request
    • provide a link to the plugin page
    • provide a link to the plugin permissions
    • only add one plugin per pull request
    • when adding permissions for a premium plugin, please provide the plugin.yml
      • the plugin.yml can be found inside the plugin JAR
      • use WinZip or other programs to open it
      • DON'T SHARE THE WHOLE JAR OF A PREMIUM PLUGIN

Formatting

Permissions:
Plugin + Permission + Description + / optional Command

Permission commands:
/ Command <required argument> [optional argument]

Examples

Permission without a command:
Essentials+essentials.fly+Allows the player to fly.

Permission with a command:
Essentials+essentials.fly+Allows the player to fly.+/fly

Permission with multiple commands:
Essentials+essentials.fly+Allows the player to fly.+/fly,/playerfly

Permission with a placeholder:
Essentials+essentials.fly.[world]+Allows the player to fly in a specific world.

Permission with command and required argument:
Essentials+essentials.fly+Give someone fly mode.+/fly <player>

Permission with command and required argument to choose:
Essentials+essentials.fly+Give someone fly mode.+/fly <player|mob>

Permission with command, required and optional argument:
Essentials+essentials.fly+Give someone fly mode.+/fly <player> [world]

Editing Tool

If you are using Visual Studio Code as your editor, you can now use an extension that provides syntax highlighting for the permission database.

You can get it here.