LuckPerms

https://luckperms.net/wiki/
Admin
LuckPerms is a permissions plugin for Minecraft servers that provides advanced permission...
Tokens:35,855
Snippets:622
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### View Essentials Version and Setup

Source: https://luckperms.net/wiki/FAQ

Run this command to check your Essentials version and confirm if Vault is installed and LuckPerms is recognized as the permission plugin. Essential for troubleshooting EssentialsX integration.

```command
/ess version
```

--------------------------------

### Example Meta Key-Value Pairs

Source: https://luckperms.net/wiki/Prefixes%2C-Suffixes-%26-Meta

Shows examples of meta data associated with a user, represented as key-value pairs.

```text
max-homes = 5
username-color: blue

```

--------------------------------

### Example YAML File

Source: https://luckperms.net/wiki/Storage-types

Demonstrates the structure of a user data file in YAML format.

```yaml
uuid: c1d60c50-70b5-4722-8057-87767557e50d
name: Luck
primary-group: default
permissions:
- test.permission:
    value: true
    context:
      server: factions
- negated.permission.example:
    value: false
- special.test.perm
- special.test.permission
parents:
- default
prefixes:
- '&c[Admin] ':
    priority: 10
meta:
- homes:
    value: '10'

```

--------------------------------

### Example JSON File

Source: https://luckperms.net/wiki/Storage-types

Illustrates the structure of a user data file in JSON format.

```json
{
  "uuid": "c1d60c50-70b5-4722-8057-87767557e50d",
  "name": "Luck",
  "primaryGroup": "default",
  "permissions": [
    {
      "permission": "test.permission",
      "value": true,
      "context": {
        "server": "factions"
      }
    },
    {
      "permission": "negated.permission.example",
      "value": false
    },
    {
      "permission": "special.test.perm",
      "value": true
    },
    {
      "permission": "special.test.permission",
      "value": true
    }
  ],
  "parents": [
    {
      "group": "default"
    }
  ],
  "prefixes": [
    {
      "prefix": "&c[Admin] ",
      "priority": 10
    }
  ],
  "meta": [
    {
      "key": "homes",
      "value": "10"
    }
  ]
}

```

--------------------------------

### Example Prefix Stacking with Custom Spacers

Source: https://luckperms.net/wiki/Prefix-%26-Suffix-Stacking

This configuration demonstrates prefix stacking with custom spacers for a more visually distinct output. It uses '★ ' as the start spacer, ' | ' as the middle spacer, and a space as the end spacer.

```yaml
prefix:
  format:
    - "highest_on_track_prison"
    - "highest_on_track_donor"
    - "highest_on_track_staff"
  duplicates: first-only
  start-spacer: "★ "
  middle-spacer: " | "
  end-spacer: " "
```

--------------------------------

### Example TOML File

Source: https://luckperms.net/wiki/Storage-types

Presents the structure of a user data file in TOML format.

```toml
uuid = "c1d60c50-70b5-4722-8057-87767557e50d"
name = "Luck"
primary-group = "default"

[[permissions]]
  permission = "test.permission"
  value = true

  [permissions.context]
    server = "factions"

[[permissions]]
  permission = "negated.permission.example"
  value = false

[[permissions]]
  permission = "special.test.perm"
  value = true

[[permissions]]
  permission = "special.test.permission"
  value = true

[[parents]]
  group = "default"

[[prefixes]]
  prefix = "&c[Admin] "
  priority = 10

[[meta]]
  key = "homes"
  value = "10"


```

--------------------------------

### Example MySQL User Grant

Source: https://luckperms.net/wiki/Storage-system-errors

An example of granting all privileges on the 'luckperms' database to a user named 'luck' from any host.

```sql
GRANT ALL PRIVILEGES ON luckperms.* TO 'luck'@'%';
```

--------------------------------

### Example Prefix Stacking Configuration

Source: https://luckperms.net/wiki/Prefix-%26-Suffix-Stacking

An example configuration for prefix stacking that includes prefixes from 'prison', 'donor', and 'staff' tracks. It allows only the first duplicate and uses a space as a middle spacer.

```yaml
prefix:
  format:
    - "highest_on_track_prison"
    - "highest_on_track_donor"
    - "highest_on_track_staff"
  duplicates: first-only
  start-spacer: ""
  middle-spacer: " "
  end-spacer: ""
```

--------------------------------

### Run LuckPerms Standalone with Docker

Source: https://luckperms.net/wiki/Standalone-and-REST-API

Use this command to quickly start a LuckPerms CLI for remote database interaction without a Minecraft server. Ensure Docker is installed.

```bash
docker run -it --rm ghcr.io/luckperms/luckperms

```

--------------------------------

### Example HOCON File

Source: https://luckperms.net/wiki/Storage-types

Shows the structure of a user data file using the HOCON format.

```hocon
uuid=c1d60c50-70b5-4722-8057-87767557e50d
name=Luck
primary-group=default
permissions=[
    {
        permission="test.permission"
        value=true
        context {
            server=factions
        }
    },
    {
        permission="negated.permission.example"
        value=false
    },
    {
        permission="special.test.perm"
        value=true
    },
    {
        permission="special.test.permission"
        value=true
    }
]
parents=[
    {
        group=default
    }
]
prefixes=[
    {
        prefix="&c[Admin] "
        priority=10
    }
]
meta=[
    {
        key=homes
        value="10"
    }
]


```

--------------------------------

### Example 1: Global Server with Global Inclusion

Source: https://luckperms.net/wiki/Advanced-Setup

Demonstrates a 'global' server where global permissions are included. Permissions set globally will apply, while server-specific permissions for 'factions' will not.

```yaml
server: global
include-global: true
```

--------------------------------

### Bukkit Bootstrap Implementation Example

Source: https://luckperms.net/wiki/Contributing

LPBukkitBootstrap implements the LuckPermsBootstrap interface, handling platform-specific integrations like logging, scheduling, and providing access to server objects.

```java
class LPBukkitBootstrap implements LuckPermsBootstrap
```

--------------------------------

### Example 2: Specific Server with Global Inclusion

Source: https://luckperms.net/wiki/Advanced-Setup

Shows a 'lobby' server where global permissions are included. Both global permissions and permissions specifically set for the 'lobby' server will apply.

```yaml
server: lobby
include-global: true
```

--------------------------------

### Example 3: BungeeCord Server without Global Inclusion

Source: https://luckperms.net/wiki/Advanced-Setup

Illustrates a 'bungeecord' server where global permissions are NOT included. Only permissions explicitly set for the 'bungeecord' server will apply.

```yaml
server: bungeecord
include-global: false
```

--------------------------------

### Bukkit Plugin Implementation Example

Source: https://luckperms.net/wiki/Contributing

LPBukkitPlugin extends AbstractLuckPermsPlugin, providing platform-specific implementations for LuckPerms' core functionality. It defines custom behavior and objects for the Bukkit platform.

```java
class LPBukkitPlugin extends AbstractLuckPermsPlugin implements LuckPermsPlugin
```

--------------------------------

### Interact with LuckPerms API using PlayerRef

Source: https://luckperms.net/wiki/Hytale

Use PlayerAdapter and PlayerRef when interacting with LuckPerms API methods that require player context. This example shows how to get a player's prefix.

```java
// PlayerAdapter is a convenience class for converting
// between Hytale's PlayerRef and LuckPerms' User objects
PlayerAdapter<PlayerRef> playerAdapter = LuckPermsProvider.get().getPlayerAdapter(PlayerRef.class);

User user = playerAdapter.getUser(playerRef);
CachedPermissionData permissionData = playerAdapter.getPermissionData(playerRef);
CachedMetaData metaData = playerAdapter.getMetaData(playerRef);

// Get the players prefix, for example :)
String prefix = metaData.getPrefix();

```

--------------------------------

### Bukkit Loader Plugin Example

Source: https://luckperms.net/wiki/Contributing

The BukkitLoaderPlugin is the entry point for LuckPerms on Bukkit platforms. It sets up a special classloader and delegates lifecycle methods to the bootstrap.

```java
class BukkitLoaderPlugin extends JavaPlugin
```

--------------------------------

### Obtain LuckPerms API instance

Source: https://luckperms.net/wiki/Hytale

Retrieve the LuckPerms API instance after the 'start' phase of the JavaPlugin lifecycle. The 'setup' phase is too early.

```java
@Override
protected void setup() {
  // doesn't work! ❌
  LuckPerms luckPerms = LuckPermsProvider.get();
}

@Override
protected void start() {
  // works! ✅
  LuckPerms luckPerms = LuckPermsProvider.get();
}
```

--------------------------------

### Example Chat Message with Prefix

Source: https://luckperms.net/wiki/Prefixes%2C-Suffixes-%26-Meta

Illustrates the visual representation of a prefix in a chat message.

```text
[Admin] Luck the great: Hello!

```

--------------------------------

### Custom Context Calculator Implementation

Source: https://luckperms.net/wiki/Developer-API-Usage

Provides an example of a custom ContextCalculator for the Bukkit platform, calculating context based on a player's gamemode.

```java
public class CustomCalculator implements ContextCalculator<Player> {

    @Override  
    public void calculate(Player target, ContextConsumer contextConsumer) {
        contextConsumer.accept("gamemode", target.getGameMode().name());
    }
    
    @Override
    public ContextSet estimatePotentialContexts() {
        ImmutableContextSet.Builder builder = ImmutableContextSet.builder();
        for (GameMode gameMode : GameMode.values()) {
            builder.add("gamemode", gameMode.name().toLowerCase());
        }
        return builder.build();
    }
    
}
```

--------------------------------

### Start Verbose Permission Recording

Source: https://luckperms.net/wiki/Usage

Initiates real-time monitoring of permission checks for a specified test user. This is useful for identifying permission nodes and troubleshooting.

```command
/lp verbose record <test user>
```

--------------------------------

### Regex Permission Node Example

Source: https://luckperms.net/wiki/Advanced-Setup

Use the 'R=' prefix to indicate a regex node. Remember to escape special characters like dots.

```text
luckperms\.create.*
```

--------------------------------

### Define Default Contexts in contexts.yml

Source: https://luckperms.net/wiki/Context

Configure default contexts in `contexts.yml` that are automatically applied to commands when no specific contexts are provided. This example sets default 'world' and 'server' contexts.

```yaml
{
 "default-contexts": {
    "world": "world_nether",
    "server": "survival"
  }
}
```

--------------------------------

### Example 4: Global Server without Global Inclusion

Source: https://luckperms.net/wiki/Advanced-Setup

Presents a 'global' server where global permissions are NOT included. In this configuration, no permissions will apply unless explicitly defined for the server.

```yaml
server: global
include-global: false
```

--------------------------------

### Configure H2 Storage

Source: https://luckperms.net/wiki/Storage-types

Set the storage method to H2 for local flatfile storage. This is the default option and requires no external setup.

```yaml
storage-method: h2
```

--------------------------------

### Checking LuckPerms Storage Method

Source: https://luckperms.net/wiki/FAQ

Verify that all LuckPerms installations are connected to the correct database by checking the storage method. Use `/lp info` on backend servers and `/lpb info` on Bungeecord.

```bash
/lp info
```

```bash
/lpb info
```

--------------------------------

### Registering a callback with CompletableFuture on server thread

Source: https://luckperms.net/wiki/Developer-API

This example shows how to register a callback to handle an ActionLog once it's available. It uses whenCompleteAsync with a specific executor to ensure the callback runs on the server thread, which is necessary for interacting with Bukkit/Sponge APIs.

```java
Executor executor = runnable -> Bukkit.getScheduler().runTask(plugin, runnable);

logFuture.whenCompleteAsync(new BiConsumer<ActionLog, Throwable>() {
    @Override
    public void accept(ActionLog log, Throwable exception) {
        if (exception != null) {
            // There was some error whilst getting the log.
            return;
        }

        // Use the log for something...
    }
}, executor);
```

--------------------------------

### Define Custom Static Context in contexts.json

Source: https://luckperms.net/wiki/Context

Add custom static contexts to the `contexts.json` file to provide fixed context values to all players. This example adds a 'server-type' context with the value 'skyblock'.

```json
{
  "static-contexts": {
    "server-type": "skyblock"
  }
}
```

--------------------------------

### Setting LuckPerms Configuration via Environment Variables

Source: https://luckperms.net/wiki/Configuration

Configure LuckPerms using environment variables, which is a common method for application configuration across different platforms. The example shows unix-like shell commands.

```bash
export LUCKPERMS_SERVER="example"
export LUCKPERMS_STORAGE_METHOD="mysql"
export LUCKPERMS_DATA_ADDRESS="192.168.0.100"

java -jar server.jar

```

--------------------------------

### Get un-flattened user/group nodes

Source: https://luckperms.net/wiki/Developer-API-Usage

Retrieves an un-flattened collection of nodes for a user or group. Entries at the start have higher priority. This view does not consider inherited data.

```java
Collection<Node> getNodes()
```

--------------------------------

### Create ImmutableContextSet Instances

Source: https://luckperms.net/wiki/Developer-API-Usage

Demonstrates various ways to create immutable context sets, including empty sets, sets with predefined values, and building sets from maps.

```java
ImmutableContextSet set1 = ImmutableContextSet.empty();  

ImmutableContextSet set2 = ImmutableContextSet.of("world", "world_nether");

ImmutableContextSet set3 = ImmutableContextSet.builder()  
    .add("world", "world_nether")
    .add("server", "survival")
    .build();

Map<String, String> map = new HashMap<>();
map.put("region", "something");

ImmutableContextSet.Builder builder = ImmutableContextSet.builder();
map.forEach(builder::add);

ImmutableContextSet set4 = builder.build();
```

--------------------------------

### Retrieve Prefix and Suffix

Source: https://luckperms.net/wiki/Developer-API-Usage

Get the prefix and suffix associated with a user's metadata using CachedMetaData.

```java
String prefix = user.getCachedData().getMetaData().getPrefix();
String suffix = user.getCachedData().getMetaData().getSuffix();
```

--------------------------------

### Grant Full Access to LuckPerms

Source: https://luckperms.net/wiki/Usage

Use this command in the server console to grant a user all LuckPerms permissions. This is useful for initial setup.

```bash
lp user <your username> permission set luckperms.* true
```

--------------------------------

### Create Groups and Assign Prefixes

Source: https://luckperms.net/wiki/Prefixes%2C-Suffixes-%26-Meta

Use these commands to create new groups, assign parent relationships, and set prefixes for groups. Prefixes are added with a specific weight to control their order.

```bash
/lp creategroup admin
/lp creategroup mod
/lp group admin parent add mod
/lp group admin meta addprefix 100 "&c[Admin] "
/lp group mod meta addprefix 90 "&d[Mod] "
```

--------------------------------

### Query Contexts for a User (Online Subject)

Source: https://luckperms.net/wiki/Developer-API-Usage

Explains how to query context and query options for a User object, with a note that a result is only returned if the player is online.

```java
Optional<ImmutableContextSet> contextSet = luckPerms.getContextManager().getContext(user);
Optional<QueryOptions> queryOptions = luckPerms.getContextManager().getQueryOptions(user);
```

--------------------------------

### Enable Regex Permissions

Source: https://luckperms.net/wiki/Configuration

Enable this option to allow LuckPerms to detect and process regex permissions, marked with 'r=' at the start of the node.

```yaml
apply-regex: true

```

--------------------------------

### Fallback to Static Contexts

Source: https://luckperms.net/wiki/Developer-API-Usage

Illustrates how to obtain the server's static context and query options when a specific subject's context is not directly available.

```java
User user = ...;

// This is the easy way...
ImmutableContextSet contextSet = user.getQueryOptions().context();
QueryOptions queryOptions = user.getQueryOptions();

// But is equivalent to this...
ContextManager cm = luckPerms.getContextManager();
ImmutableContextSet contextSet = cm.getContext(user).orElse(cm.getStaticContext());
QueryOptions queryOptions = cm.getQueryOptions(user).orElse(cm.getStaticQueryOptions());
```

--------------------------------

### Query Contexts for a Player

Source: https://luckperms.net/wiki/Developer-API-Usage

Demonstrates how to retrieve the active context set and query options for a given player object.

```java
Player player = ...;

ImmutableContextSet contextSet = luckPerms.getContextManager().getContext(player);
QueryOptions queryOptions = luckPerms.getContextManager().getQueryOptions(player);
```

--------------------------------

### Delete User Permissions by Server and World

Source: https://luckperms.net/wiki/Bulk-Editing

Deletes user permissions where the server name starts with 'hub' and the world is exactly 'nether'.

```bash
/lp bulkupdate users delete "server ~~ hub%" "world == nether"
```

--------------------------------

### Configure LuckPerms Standalone with Docker Compose

Source: https://luckperms.net/wiki/Standalone-and-REST-API

Set up LuckPerms to run as a service using Docker Compose. Configure database connection details via environment variables.

```yaml
version: "3.8"
services:
  luckperms:
    image: ghcr.io/luckperms/luckperms
    # Uncomment if your database is running on the same host
    #extra_hosts:
    #  - "database:host-gateway"
    environment:
      LUCKPERMS_STORAGE_METHOD: mysql
      LUCKPERMS_DATA_ADDRESS: database:3306
      LUCKPERMS_DATA_DATABASE: minecraft
      LUCKPERMS_DATA_USERNAME: root
      LUCKPERMS_DATA_PASSWORD: passw0rd

```

--------------------------------

### Create Specific Node Types

Source: https://luckperms.net/wiki/Developer-API-Usage

Demonstrates building specific types of nodes like PermissionNode, RegexPermissionNode, InheritanceNode, PrefixNode, SuffixNode, MetaNode, WeightNode, and DisplayNameNode.

```java
// note: all of the following classes extend from Node

// build a permission node
PermissionNode node = PermissionNode.builder("my.permission").build();

// build a regex permission node
RegexPermissionNode node = RegexPermissionNode.builder(pattern).build();

// build an inheritance node
InheritanceNode node = InheritanceNode.builder(group).build();

// build a prefix node
PrefixNode node = PrefixNode.builder("[Some Prefix]", 100).build();

// build a suffix node
SuffixNode node = SuffixNode.builder("[Some Suffix]", 150).build();

// build a metadata node
MetaNode node = MetaNode.builder("some-key", "some-value").build();

// build a weight node
WeightNode node = WeightNode.builder(25).build();

// build a display name node
DisplayNameNode node = DisplayNameNode.builder("SeniorModerator").build();

```

--------------------------------

### Obtain Cached Data via PlayerAdapter

Source: https://luckperms.net/wiki/Developer-API-Usage

Use PlayerAdapter to get CachedPermissionData and CachedMetaData from a platform Player instance. Requires the Player class.

```java
Player player = ...;
PlayerAdapter<Player> adapter = luckperms.getPlayerAdapter(Player.class);

CachedPermissionData permissionData = adapter.getPermissionData(player);
CachedMetaData metaData = adapter.getMetaData(player);
```

--------------------------------

### View User Meta Information

Source: https://luckperms.net/wiki/Prefixes%2C-Suffixes-%26-Meta

Use the 'meta info' command to list all prefixes, suffixes, and meta data for a user, ordered by weight. This is useful for debugging.

```bash
/lp user Luck meta info
```

--------------------------------

### Subscribe to LuckPerms Events

Source: https://luckperms.net/wiki/Developer-API-Usage

Demonstrates subscribing to various LuckPerms events using expression lambdas, statement lambdas, and method references. Requires importing necessary event classes and obtaining the EventBus instance.

```java
import net.luckperms.api.event.EventBus;
import net.luckperms.api.event.log.LogPublishEvent;
import net.luckperms.api.event.user.UserLoadEvent;
import net.luckperms.api.event.user.track.UserPromoteEvent;

public class MyListener {
    private final MyPlugin plugin;

    public MyListener(MyPlugin plugin, LuckPerms luckPerms) {
        this.plugin = plugin;

        EventBus eventBus = luckPerms.getEventBus();

        // 1. Subscribe to an event using an expression lambda
        eventBus.subscribe(this.plugin, LogPublishEvent.class, e -> /* ... */);

      	// 2. Subscribe to an event using a statement lambda
        eventBus.subscribe(this.plugin, UserLoadEvent.class, e -> {
            // ...
        });

        // 3. Subscribe to an event using a method reference
        eventBus.subscribe(this.plugin, UserPromoteEvent.class, this::onUserPromote);
    }

    private void onUserPromote(UserPromoteEvent event) {
        // ...
    }
}
```

--------------------------------

### Get distinct user/group nodes

Source: https://luckperms.net/wiki/Developer-API-Usage

Returns a sorted set of distinct nodes for a user or group. This is faster than `#getNodes()` if ordering is not a concern, but may omit duplicates.

```java
SortedSet<Node> getDistinctNodes();
```

--------------------------------

### Enable Shorthand Permissions

Source: https://luckperms.net/wiki/Configuration

Set to true to enable the resolution and application of shorthand (GLOB style) permissions.

```yaml
apply-shorthand: true

```

--------------------------------

### Get inheritance nodes by type

Source: https://luckperms.net/wiki/Developer-API-Usage

Retrieves inheritance nodes directly by specifying the NodeType. This simplifies the filtering process compared to manually filtering the entire node collection.

```java
Set<String> groups = user.getNodes(NodeType.INHERITANCE).stream()
    .map(InheritanceNode::getGroupName)
    .collect(Collectors.toSet());
```

--------------------------------

### Create and Modify MutableContextSet Instances

Source: https://luckperms.net/wiki/Developer-API-Usage

Illustrates how to create mutable context sets, add values, and remove values.

```java
MutableContextSet set1 = MutableContextSet.create();
set1.add("world", "text");

MutableContextSet set2 = MutableContextSet.of("world", "world_nether");

Map<String, String> map = new HashMap<>();
map.put("region", "something");

MutableContextSet set3 = MutableContextSet.create();
map.forEach(set3::add);

set3.removeAll("region");
```

--------------------------------

### Get User Instance for Online Player

Source: https://luckperms.net/wiki/Developer-API-Usage

Retrieve a User instance for a known online player using their Player object. This method is safe to call on the main thread.

```java
Player player = ...;
User user = luckPerms.getPlayerAdapter(Player.class).getUser(player);
```

--------------------------------

### Resolve inherited nodes for user/group

Source: https://luckperms.net/wiki/Developer-API-Usage

Retrieves all nodes for a user or group, including those inherited from parents. Entries at the start have higher priority. This view considers inherited data.

```java
Collection<Node> resolveInheritedNodes(QueryOptions queryOptions)
```

--------------------------------

### Create LuckPerms Extension Configuration

Source: https://luckperms.net/wiki/Standalone-and-REST-API

Define the main class for a custom LuckPerms extension by creating an 'extension.json' file. This file specifies the entry point for your extension.

```json
{"class": "com.example.extension.MainClass"}

```

--------------------------------

### Obtain LuckPerms API via Static Access

Source: https://luckperms.net/wiki/Developer-API

Get a statically accessible instance of the LuckPerms API. This method works across all platforms but will throw an IllegalStateException if the API is not loaded.

```java
LuckPerms api = LuckPermsProvider.get();

```

--------------------------------

### Create a New Group

Source: https://luckperms.net/wiki/Usage

Creates a new, empty group with the specified name. This is the first step in defining a new role.

```bash
lp creategroup admin
```

--------------------------------

### Configure RabbitMQ

Source: https://luckperms.net/wiki/Configuration

Settings for connecting to RabbitMQ. Specify the address, virtual host, username, and password.

```yaml
rabbitmq:
  enabled: true
  address: localhost
  vhost: '/'
  username: 'guest'
  password: 'guest'

```

--------------------------------

### Check User Meta Details

Source: https://luckperms.net/wiki/FAQ

This command provides a more detailed view of a user's meta information, including priorities. It's useful for debugging prefix/suffix display problems.

```command
/lp user <user> meta info
```

--------------------------------

### Get User Instance by UUID

Source: https://luckperms.net/wiki/Developer-API-Usage

Retrieve a User instance using a player's UUID. This is suitable for both online and offline players, but may not always return the most up-to-date state for online players.

```java
User user = luckPerms.getUserManager().getUser(uuid);
```

--------------------------------

### Set Meta Weight (Prefix/Suffix) via Command

Source: https://luckperms.net/wiki/Weight

Use this command to set a weight for a prefix or suffix when adding or setting it for a user or group. This determines which meta-text is displayed.

```bash
/lp user/group <user|group> meta setprefix/addprefix <weight> <prefix>
```

--------------------------------

### Blocking operation example with CompletableFuture

Source: https://luckperms.net/wiki/Developer-API

This snippet demonstrates how to obtain an ActionLog from a CompletableFuture. It uses the join() method, which blocks until the result is available. Be aware that join() will rethrow any exceptions encountered during the future's computation.

```java
CompletableFuture<ActionLog> logFuture = actionLogger.getLog();
ActionLog log = logFuture.join();
```

--------------------------------

### Create Generic Node

Source: https://luckperms.net/wiki/Developer-API-Usage

Builds a generic Node instance using its key. Can be further configured with value, expiry, and contexts.

```java
// build any type of node
Node node = Node.builder("some.node.key").build();

// and with extra properties!
Node node = Node.builder("some.node.key")
        .value(false)
        .expiry(Duration.ofHours(1))
        .withContext(DefaultContextKeys.SERVER_KEY, "survival")
        .build();

```

--------------------------------

### Enable Wildcard Permissions

Source: https://luckperms.net/wiki/Configuration

Set to true to allow LuckPerms to parse and apply wildcard permissions (e.g., node.part.*).

```yaml
apply-wildcards: true

```

--------------------------------

### Define Static Context in contexts.json

Source: https://luckperms.net/wiki/Configuration

Use this to define static contexts that apply to all players on servers with a matching configuration. This is useful for grouping servers with similar characteristics.

```json
{
  "static-contexts": {
  	"servertype": "factions"
  },
}

```

--------------------------------

### Create a New Group

Source: https://luckperms.net/wiki/Default-Groups

Use this command to create a new group that can be used for inheritance.

```bash
/lp creategroup member
```

--------------------------------

### Enable Pushing Log Entries

Source: https://luckperms.net/wiki/Configuration

Configure LuckPerms to push logging entries to connected servers via the messaging service.

```yaml
push-log-entries: true

```

--------------------------------

### Configure Server Name

Source: https://luckperms.net/wiki/Advanced-Setup

Set the 'server' option to define the name of the current server for server-specific permissions. Set to 'global' to disable server-specific permissions.

```yaml
server: global
```

--------------------------------

### Check User Meta Information

Source: https://luckperms.net/wiki/FAQ

Use this command to view a user's prefixes, suffixes, and their priorities. This helps diagnose issues with meta data display.

```command
/lp user <user> info
```

--------------------------------

### View User General Information

Source: https://luckperms.net/wiki/Prefixes%2C-Suffixes-%26-Meta

The general user info command displays which of a user's prefixes are currently being provided to plugins. This is helpful for verifying active prefixes.

```bash
/lp user Luck info
```

--------------------------------

### Set Permission with Server and World Context

Source: https://luckperms.net/wiki/Context

This command sets a permission that applies only on a specific server and in a specific world. Multiple contexts can be combined.

```bash
lp user Luck permission set minecraft.command.gamemode true server=lobby world=nether
```

--------------------------------

### Deploy LuckPermsWeb Stack with Docker

Source: https://luckperms.net/wiki/Self-hosting-the-web-interfaces

Clone the LuckPermsWeb repository and deploy the stack using Docker Compose. This will expose the interface on port 8080.

```bash
git clone git@github.com:LuckPerms/LuckPermsWeb.git
cd LuckPermsWeb
docker compose up -d
```

--------------------------------

### Register Custom Context Calculator

Source: https://luckperms.net/wiki/Developer-API-Usage

Shows how to register a custom ContextCalculator with the LuckPerms ContextManager.

```java
luckPerms.getContextManager().registerCalculator(new CustomCalculator());
```

--------------------------------

### Convert MutableContextSet to ImmutableContextSet

Source: https://luckperms.net/wiki/Developer-API-Usage

Shows how to create a mutable context set and then obtain an immutable copy of it.

```java
MutableContextSet set = MutableContextSet.create();
set.add("something", "something");

ImmutableContextSet immutableSet = set.immutableCopy();
```

--------------------------------

### Configure mini-chat-formatter

Source: https://luckperms.net/wiki/Hytale

Set the chat format string in the mini-chat-formatter config file. The format supports MiniMessage for rich text.

```json
{
  "Format": "<prefix><username><suffix>: <message>"
}
```

--------------------------------

### Define Default Context in contexts.json

Source: https://luckperms.net/wiki/Configuration

Configure default contexts that are applied to commands when no specific context is provided. This ensures consistent permission application across commands.

```json
{
  "default-contexts": {
  	"server": "survival"
  },
}

```

--------------------------------

### Configure World Rewrites

Source: https://luckperms.net/wiki/Configuration

Sets up aliases for world names used in context calculation. This allows for recursive application of world-specific permissions.

```yaml
world-rewrite:
  world_nether: world
  world_the_end: world

```

--------------------------------

### Update Server Context to Global

Source: https://luckperms.net/wiki/Bulk-Editing

Changes all entries associated with the 'factions' server to the 'global' context.

```bash
/lp bulkupdate all update server global "server == factions"
```

--------------------------------

### Configure MySQL Storage

Source: https://luckperms.net/wiki/Storage-types

Set the storage method to MySQL for remote database storage. Requires connection details for the MySQL server.

```yaml
storage-method: mysql
```

--------------------------------

### Database Credentials Configuration

Source: https://luckperms.net/wiki/Configuration

Defines credentials for storage methods, including address (host:port), database name, username, and password. Leave the password empty for no authentication.

```yaml
data:
  address: localhost
  database: minecraft
  username: root
  password: ''

```

--------------------------------

### Configure PostgreSQL Storage

Source: https://luckperms.net/wiki/Storage-types

Set the storage method to PostgreSQL for remote database storage. Requires connection details for the PostgreSQL server.

```yaml
storage-method: postgresql
```

--------------------------------

### Create Mutable Copy of ImmutableContextSet

Source: https://luckperms.net/wiki/Developer-API-Usage

Demonstrates how to obtain a mutable copy of an immutable context set and then modify it.

```java
ImmutableContextSet set = ImmutableContextSet.of("something", "something");

MutableContextSet mutableCopy = set.mutableCopy();
mutableCopy.add("something", "something-else");
```

--------------------------------

### Find max priority of temporary prefix on a specific server

Source: https://luckperms.net/wiki/Developer-API-Usage

Queries for the maximum priority of a temporary prefix node on a specific server ('factions'). It filters by expiry and server context, then maps to priority.

```java
int maxWeight = user.getNodes(NodeType.PREFIX).stream()
    .filter(Node::hasExpiry)
    .filter(n -> n.getContexts().getAnyValue(DefaultContextKeys.SERVER_KEY)
        .map(v -> v.equals("factions")).orElse(false))
    .mapToInt(ChatMetaNode::getPriority)
    .max()
    .orElse(0);
```
Tokens:
Raw