Skip to content

Permissions

Mods declare their required permissions in manifest.json. Each permission grants access to specific API namespaces.

Permission List

PermissionAPI AccessDescription
filesystemFilesCreate, read, write, delete in-game files
networkNetwork, DatabaseCreate and manage networks, ports, domains, and databases
eventsEventsListen to game events, emit custom events
mailMailSend in-game emails
bankBankManage bank accounts and transfers
shellShellExecute terminal commands programmatically
uiUIShow notifications and toasts

APIs Without Permissions

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

APIDescription
StoragePersistent key-value storage
VariablesSession-only variables
SharedStorageShared persistent storage
SharedVariablesShared session variables
ModSettingsMod settings (player config)
RandomRandom generation utilities
TwotterIn-game social media
KisscordIn-game messaging
WeeChatIn-game IRC chat

Enforcement

When a mod declares a permissions array in its manifest, only the listed permissions are allowed. API calls requiring a non-declared permission will throw an error.

If a mod does not declare a permissions array (or the field is omitted entirely), all APIs are accessible without restriction. This is intended for development convenience but not recommended for published mods.

Usage

json
{
    "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.

HotBunny Interactive Entertainment Inc.