Locki

Quick rating

Locki

No reviews yet

A library for controlling access to the player's inventory

No Theme
No Genre
Server Utility
API/Library
Mod Loaders
Fabric
Quilt
Minecraft
1.21
1.17

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Dev Environment
Client Required
Server Required

About

Project Details

Type
Mod
License
GNU Lesser General Public License v3.0 or later
Latest Version
locki-0.13.0.jar
Authors
CurseForge
Modrinth

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

CurseForge ID
Modrinth ID

Resources

External Links

Source Issues Wiki Discord

About

Description

A library handling player inventory locking. Can also be used as a standalone mod, through the /locki command.

This mod must be installed on both server and client to work properly.

Overview

Locki represents slots using inventory nodes. Inventory nodes are structured as a tree, allowing commands
or mods to quickly lock or unlock entire sections while retaining controls over finer units.
Inventory nodes are represented as a dot-separated path, from least specific ancestor to most specific child node.
For example inventory describes the entirety of the player's inventory, while inventory.armor.chest
describes the chestplate slot of the inventory.

When an inventory node gets locked, descendant nodes can still be unlocked, allowing you to exclude specific slots
from a broad access ban. For example, locking inventory then unlocking inventory.armor.chest will prevent the player
from touching any item in their inventory except their chestplate.

Commands
Locki adds the /locki command, allowing server operators and mapmakers to interact with the API through
commands.
- /locki lock <node> [<targets>] [<lock>] : locks the inventories of one or more players
     - <node> : a full path describing a known *inventory node*.
     - [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
     - [<lock>] (optional) : If specified, must be a valid identifier referencing a registered lock. If unspecified, defaults to the generic "command" lock.
- /locki unlock <node> [<targets>] [<lock>] : unlocks the inventories of one or more players
     - <node> : a full path describing a known *inventory node*.

     - [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
     - [<lock>] (optional) : If specified, must be a valid identifier that was previously used as a lock to affect the players' inventories. If left unspecified, defaults to the generic "command" lock.

Permissions
If you have LuckPerms installed, the above commands can be used by players with the locki.command.lock permission.
If you only grant locki.command.lock.self, players will only be able to use the commands on themselves.

  For more information on how to add it to your development environment and how to use it, see the project's readme.

Locki

Example

A Quilt library handling player inventory locking. Can also be used as a standalone mod, through the /locki command.

This mod must be installed on both server and client to work properly.

Overview

Locki represents slots using inventory nodes. Inventory nodes are structured as a tree, allowing commands or mods to quickly lock or unlock entire sections while retaining controls over finer units. Inventory nodes are represented as a dot-separated path, from least specific ancestor to most specific child node. For example inventory describes the entirety of the player's inventory, while inventory.armor.chest describes the chestplate slot of the inventory.

When an inventory node gets locked, descendant nodes can still be unlocked, allowing you to exclude specific slots from a broad access ban. For example, locking inventory then unlocking inventory.armor.chest will prevent the player from touching any item in their inventory except their chestplate.

Commands

Locki adds the /locki command, allowing server operators and mapmakers to interact with the API through commands.

  • /locki lock <node> [<targets>] [<lock>] : locks the inventories of one or more players
    • <node> : a full path describing a known inventory node.
    • [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
    • [<lock>] (optional) : If specified, must be a valid identifier referencing a registered lock. If unspecified, defaults to the generic "command" lock.
    • /locki unlock <node> [<targets>] [<lock>] : unlocks the inventories of one or more players
      • [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
      • [<lock>] (optional) : If specified, must be a valid identifier that was previously used as a lock to affect the players' inventories. If left unspecified, defaults to the generic "command" lock.

Permissions

If you have LuckPerms installed, the above commands can be used by players with the locki.command.lock permission. If you only grant locki.command.lock.self, players will only be able to use the commands on themselves.

Developer information

For more information on how to add it to your development environment and how to use it, see the project's readme.

Screenshots

Gallery

  • Another possible inventory configuration
    Another possible inventory configuration
  • One possible inventory configuration
    One possible inventory configuration

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

~88,000
Total Downloads
CurseForge
~87,000
Modrinth
~1,000
Last Updated
CurseForge
Created
CurseForge
Modrinth
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works