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, Wi-Fi access points, 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, toasts and input dialogs

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.

An empty array ("permissions": []) means exactly what it says: no gated API is available. It used to be treated the same as omitting the field, which quietly turned the most conservative manifest into the most permissive one.

If a mod omits the permissions field entirely, all APIs are accessible without restriction. This legacy default is deprecated, logs a warning on load, and is intended for local development only. Declare the permissions your mod needs before publishing.

WARNING

Permissions shape which SDK namespaces a mod asks for. They are not a security sandbox: mod code runs inside the game with the game's own access. Install mods only from authors you trust.

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.