Permissions

Mods must declare required permissions in manifest.json. Each permission grants access to specific API namespaces. If a mod tries to use an API without the required permission, the call will be rejected.

Permission List

Permission	API Access	Description
filesystem	Files	Create, read, write, delete in-game files
network	Network	Create and manage networks, ports, domains
events	Events	Listen to game events, emit custom events
mail	Mail	Send in-game emails
bank	Bank	Manage bank accounts and transfers
shell	Shell	Execute terminal commands programmatically
ui	UI	Show notifications and indicators

APIs Without Permissions

The following APIs are always available and do not require permissions:

API	Description
Storage	Persistent key-value storage
Variables	Session-only variables
SharedStorage	Shared persistent storage
SharedVariables	Shared session variables
ModSettings	Mod settings (player config)
Random	Random generation utilities
Twotter	In-game social media
Kisscord	In-game messaging
WeeChat	In-game IRC chat

Usage

{
    "permissions": ["events", "network", "filesystem"]
}

TIP

Only request the permissions your mod actually needs. Players can see which permissions a mod requires in the Mods menu.