Skip to content

Plugin permissions, hooks and limits ​

Plugin API version: 1. See Manifest and permissions for how to use them.

Permissions ​

PermissionWhat the administrator is told
network:<host>Connect to the named host. <host> is a full domain or *.domain; wildcards over shared hosting platforms are refused
servers:readRead the game, version and add-on folder of servers you open its tools on
servers:files.writeAdd and remove files in server folders on your behalf (only after you confirm an install)
storageKeep a small private data store
hooksBe notified when servers or add-ons change
paymentsTake payments and manage subscriptions through this provider. It sees order details and customers’ email addresses, and holds your API keys
notificationsRead the text of notifications to lay them out as rich messages. It cannot send anything anywhere and never sees the webhook address

Hooks ​

A plugin needs the hooks permission to receive them.

Event
server.created
server.deleted
server.updated
addon.installed
addon.removed

Setting field types ​

string (pattern, placeholder), number (min, max), boolean, select (options), secret (encrypted at rest, write-only).

Sandbox limits per call ​

LimitValue
Memory64 MB
Stack1 MB
Run time25 s
Requests40
Bytes per response8 MB
Bytes per call (all responses)24 MB
Result size2 MB
Log lines100
Storage256 KB

Released under the AGPL-3.0-only license.