App manifest reference

Description: Defines your App's metadata, deployment configuration, settings, and permissions.

Example:

{
    "id": "ACj4U-eThgmjXUOBAjk_jw",
    "version": "1.0.0",
    "package": {
        "client": {
            "deploy": "client/dist"
        },
        "server": {
            "launch": "server/dist/myServerMain.js",
            "deploy": [
                "server/dist",
                "networking/gen/server"
            ],
            "node_modules": [
                "server/node_modules"
            ]
        }
    }
}

[Required] Property id

Title: Id
Type string
Required Yes
Defined in id.schema.json
Description: Unique identifier obtained from the Root Developer Portal.
Example:
{
    "id": "ACj4U-eThgmjXUOBAjk_jw"
}


Type	`string`
Required	Yes
Defined in	id.schema.json

[Required] Property version

Title: Version
Type string
Required Yes
Defined in version.schema.json
Description: Semantic version string (e.g., MAJOR.MINOR.PATCH). Your version number must be unique for each release; that is, you cannot republish a new package with a previously-used version number.
Example:
{
    "version": "1.0.0"
}


Type	`string`
Required	Yes
Defined in	version.schema.json

[Required] Property package

Title: Package
Type object
Required Yes
Additional properties Not allowed
Defined in package.app.schema.json
Description: Deployment and startup configuration for your App's client and server code.
Example:
{
    "package": {
        "client": {
            "deploy": "client/dist"
        },
        "server": {
            "launch": "server/dist/myAppMain.js",
            "deploy": [
                "server/dist",
                "networking/gen/server"
            ],
            "node_modules": [
                "server/node_modules"
            ]
        }
    }
}
[Required] Property client
Type object
Required Yes
Additional properties Not allowed
Description: Client-side build output for deployment.
[Required] Property deploy
Type string
Required Yes
Description: Path to the client deployment directory containing the entire single-page application (relative to project root).
Example:
"client/dist"
[Required] Property server
Type object
Required Yes
Additional properties Not allowed
Description: Configuration for launching and packaging your server.
[Required] Property launch
Type string
Required Yes
Description: Entry point to launch the server process (must be a .js file).
Example:
"server/dist/myAppMain.js"
[Required] Property deploy
Type array of string
Required Yes
Description: List of server folders to include in deployment.
Each item of this array must be Description
deploy items -
deploy items
Type string
Required No
Example:
[
    "server/dist",
    "networking/gen/server"
]
[Required] Property node_modules
Type array of string
Required Yes
Description: List of server-side node_modules folders that must be deployed.
Each item of this array must be Description
node_modules items -
node_modules items
Type string
Required No
Example:
[
    "server/node_modules"
]


Type	`object`
Required	Yes
Additional properties	Not allowed
Defined in	package.app.schema.json


Type	`object`
Required	Yes
Additional properties	Not allowed


Type	`string`
Required	Yes


Type	`object`
Required	Yes
Additional properties	Not allowed


Type	`string`
Required	Yes


Type	`array of string`
Required	Yes

Each item of this array must be	Description
deploy items	-


Type	`string`
Required	No


Type	`array of string`
Required	Yes

Each item of this array must be	Description
node_modules items	-


Type	`string`
Required	No

[Optional] Property settings

Title: Settings
Type object
Required No
Additional properties Not allowed
Defined in settings.schema.json
Description: Configurable global settings available to community administrators during and after installation.
Example:
{
    "groups": [
        {
            "key": "general",
            "title": "General",
            "items": [
                {
                    "key": "notifyOnJoin",
                    "title": "Notify on new join",
                    "description": "Send a message when someone joins the raid.",
                    "required": false,
                    "confirmation": "Update",
                    "checkbox": {
                        "defaultValue": true
                    }
                }
            ]
        }
    ]
}
[Required] Property groups
Type array of object
Required Yes
Description: Logical grouping of settings fields.
Each item of this array must be Description
groups items -
groups items
Type object
Required No
Additional properties Any type allowed
[Required] Property key
Type string
Required Yes
Description: Machine-friendly identifier for this group.
Examples:
"general"
"notifications"
[Required] Property title
Type string
Required Yes
Description: Human-readable title shown above this group.
Examples:
"General Settings"
"Notification Preferences"
[Required] Property items
Type array of object
Required Yes
Description: List of individual setting definitions in this group.
Each item of this array must be Description
items items -
items items
Type object
Required No
Additional properties Not allowed
[Required] Property key
Type string
Required Yes
Description: Machine-friendly setting identifier.
Examples:
"maxRaidSize"
"notifyOnJoin"
[Required] Property title
Type string
Required Yes
Description: Label shown to the user for this setting.
Examples:
"Maximum raid size"
"Notify on new join"
[Optional] Property description
Type string or null
Required No
Description: Optional explanatory text for this setting.
Examples:
"Set the upper limit for raid participants."
null
[Required] Property required
Type boolean
Required Yes
Description: Whether the user must provide a value.
Examples:
true
false
[Required] Property confirmation
Type string
Required Yes
Description: Text for the button users click to save this setting.
Examples:
"Save"
"Update"
[Optional] Property text
Type object or null
Required No
Description: Configuration for a free-form text input.
[Optional] Property defaultValue
Type string or null
Required No
Description: Default text pre-filled in the input.
Examples:
"Enter a title..."
null
[Optional] Property regex
Type string or null
Required No
Description: Regular expression the input must match.
Examples:
"^[a-z0-9\\-]+$"
null
[Optional] Property number
Type object or null
Required No
Description: Configuration for a numeric input.
[Optional] Property minValue
Type number or null
Required No
Description: Minimum allowed value.
Examples:
1
null
[Optional] Property maxValue
Type number or null
Required No
Description: Maximum allowed value.
Examples:
100
null
[Optional] Property step
Type number or null
Required No
Description: Increment step.
Examples:
1
null
[Optional] Property defaultValue
Type number or null
Required No
Description: Default numeric value.
Examples:
10
null
[Optional] Property checkbox
Type object or null
Required No
Description: Configuration for a boolean checkbox.
[Optional] Property defaultValue
Type boolean or null
Required No
Description: Initial state of the checkbox.
Examples:
true
false
[Optional] Property member
Type object or null
Required No
Description: Select one or more community members.
[Optional] Property multiSelect
Type boolean
Required No
Description: Allow multiple selections.
Examples:
false
true
[Optional] Property userIds
Type array of string
Required No
Description: Pre-selected user IDs.
Each item of this array must be Description
userIds items -
userIds items
Type string
Required No
Example:
[
    "user-123",
    "user-456"
]
[Optional] Property role
Type object or null
Required No
Description: Select one or more community roles.
[Optional] Property multiSelect
Type boolean
Required No
Description: Allow multiple role selections.
Examples:
false
true
[Optional] Property communityRoleIds
Type array of string
Required No
Description: Pre-selected role IDs.
Each item of this array must be Description
communityRoleIds items -
communityRoleIds items
Type string
Required No
Example:
[
    "role-abc",
    "role-def"
]
[Optional] Property roleAndMember
Type object or null
Required No
Description: Combined selector for users and roles.
[Optional] Property userIds
Type array of string
Required No
Each item of this array must be Description
userIds items -
userIds items
Type string
Required No
Example:
[
    "user-1"
]
[Optional] Property communityRoleIds
Type array of string
Required No
Each item of this array must be Description
communityRoleIds items -
communityRoleIds items
Type string
Required No
Example:
[
    "role-x"
]
[Optional] Property channel
Type object or null
Required No
Description: Select one or more channels.
[Optional] Property multiSelect
Type boolean
Required No
Description: Allow multiple channels.
Example:
true
[Optional] Property channelIds
Type array of string
Required No
Each item of this array must be Description
channelIds items -
channelIds items
Type string
Required No
Example:
[
    "chan-1",
    "chan-2"
]
[Optional] Property channelGroup
Type object or null
Required No
Description: Select one or more channel groups.
[Optional] Property multiSelect
Type boolean
Required No
Description: Allow multiple groups.
Example:
false
[Optional] Property channelGroupIds
Type array of string
Required No
Each item of this array must be Description
channelGroupIds items -
channelGroupIds items
Type string
Required No
Example:
[
    "grp-1"
]
[Optional] Property select
Type object or null
Required No
Description: Select from a custom list of options.
[Optional] Property multiSelect
Type boolean
Required No
Description: Allow multiple options.
Example:
false
[Optional] Property options
Type array of object
Required No
Description: List of label/value pairs.
Each item of this array must be Description
options items -
options items
Type object
Required No
Additional properties Not allowed
[Required] Property label
Type string
Required Yes
Description: User-facing option text.
Examples:
"Low"
"Medium"
"High"
[Required] Property value
Type string
Required Yes
Description: Machine value for the option.
Examples:
"low"
"medium"
"high"
[Optional] Property timestamp
Type object or null
Required No
Description: Raw timestamp object (ISO 8601).
Example:
{
    "$date": "2025-08-05T00:00:00Z"
}
[Optional] Property time
Type object or null
Required No
Description: Time-of-day field (HH:MM:SS).
[Optional] Property defaultValue
Type string or null
Required No
Description: Default time value.
Examples:
"09:30:00"
null
[Optional] Property date
Type object or null
Required No
Description: Date field object (YYYY-MM-DD).
[Optional] Property date
Type object or null
Required No
Description: Raw date object.
Example:
{
    "$date": "2025-08-05"
}
[Optional] Property color
Type object or null
Required No
Description: Color picker field (hex code).
[Optional] Property defaultValue
Type string or null
Required No
Description: Default color value.
Examples:
"#ff0000"
null
[Optional] Property button
Type object or null
Required No
Description: Action button displayed in settings.
[Optional] Property title
Type string
Required No
Description: Text shown on the button.
Example:
"Reset settings"


Type	`object`
Required	No
Additional properties	Not allowed
Defined in	settings.schema.json


Type	`array of object`
Required	Yes

Each item of this array must be	Description
groups items	-


Type	`object`
Required	No
Additional properties	Any type allowed


Type	`string`
Required	Yes


Type	`string`
Required	Yes


Type	`array of object`
Required	Yes

Each item of this array must be	Description
items items	-


Type	`object`
Required	No
Additional properties	Not allowed


Type	`string`
Required	Yes


Type	`string`
Required	Yes


Type	`string or null`
Required	No


Type	`boolean`
Required	Yes


Type	`string`
Required	Yes


Type	`object or null`
Required	No


Type	`string or null`
Required	No


Type	`string or null`
Required	No


Type	`object or null`
Required	No


Type	`number or null`
Required	No


Type	`number or null`
Required	No


Type	`number or null`
Required	No


Type	`number or null`
Required	No


Type	`object or null`
Required	No


Type	`boolean or null`
Required	No


Type	`object or null`
Required	No


Type	`boolean`
Required	No


Type	`array of string`
Required	No

Each item of this array must be	Description
userIds items	-


Type	`string`
Required	No


Type	`object or null`
Required	No


Type	`boolean`
Required	No


Type	`array of string`
Required	No

Each item of this array must be	Description
communityRoleIds items	-


Type	`string`
Required	No


Type	`object or null`
Required	No


Type	`array of string`
Required	No

Each item of this array must be	Description
userIds items	-

[Optional] Property permissions

Title: Permission
Type object
Required No
Additional properties Not allowed
Defined in permissions.schema.json
Description: The permissions your code requires in order to function correctly.
Example:
{
    "permissions": {
        "channel": {
            "channelFullControl": true,
            "channelView": true
        },
        "community": {
            "communityFullControl": false
        }
    }
}
[Optional] Property community
Type object
Required No
Additional properties Not allowed
Description: Permissions scoped to the community level.
[Optional] Property communityChangeMyNickname
Type boolean
Required No
Default false
Description: Change your own nickname.
[Optional] Property communityChangeOtherNickname
Type boolean
Required No
Default false
Description: Change nicknames of other members.
[Optional] Property communityCreateBan
Type boolean
Required No
Default false
Description: Ban members from the community.
[Optional] Property communityCreateChannelGroup
Type boolean
Required No
Default false
Description: Create new channel groups.
[Optional] Property communityCreateInvite
Type boolean
Required No
Default false
Description: Generate new community invites.
[Optional] Property communityFullControl
Type boolean
Required No
Default false
Description: All community-level permissions.
[Optional] Property communityKick
Type boolean
Required No
Default false
Description: Remove members from the community.
[Optional] Property communityManageApps
Type boolean
Required No
Default false
Description: Install or remove apps in the community.
[Optional] Property communityManageAuditLog
Type boolean
Required No
Default false
Description: View or clear the audit log.
[Optional] Property communityManageBans
Type boolean
Required No
Default false
Description: Unban or list banned members.
[Optional] Property communityManageCommunity
Type boolean
Required No
Default false
Description: Manage overall community settings.
[Optional] Property communityManageEmojis
Type boolean
Required No
Default false
Description: Upload or remove custom emojis.
[Optional] Property communityManageInvites
Type boolean
Required No
Default false
Description: Revoke or list existing invites.
[Optional] Property communityManageRoles
Type boolean
Required No
Default false
Description: Create or update community roles.
[Optional] Property channel
Type object
Required No
Additional properties Not allowed
Description: Permissions scoped to individual channels.
[Optional] Property channelAppKick
Type boolean
Required No
Default false
Description: Remove apps from the channel.
[Optional] Property channelCreateFile
Type boolean
Required No
Default false
Description: Create new files in channels.
[Optional] Property channelCreateMessage
Type boolean
Required No
Default false
Description: Send new messages.
[Optional] Property channelCreateMessageAttachment
Type boolean
Required No
Default false
Description: Attach files to messages.
[Optional] Property channelCreateMessageMention
Type boolean
Required No
Default false
Description: Mention users in messages.
[Optional] Property channelCreateMessageReaction
Type boolean
Required No
Default false
Description: React to messages.
[Optional] Property channelDeleteMessageOther
Type boolean
Required No
Default false
Description: Delete messages sent by others.
[Optional] Property channelFullControl
Type boolean
Required No
Default false
Description: All channel permissions.
[Optional] Property channelMakeMessagePublic
Type boolean
Required No
Default false
Description: Convert private messages to public.
[Optional] Property channelManageFiles
Type boolean
Required No
Default false
Description: Upload or download files in channels.
[Optional] Property channelManagePinnedMessages
Type boolean
Required No
Default false
Description: Pin or unpin messages.
[Optional] Property channelMoveUserOther
Type boolean
Required No
Default false
Description: Move other users between voice channels.
[Optional] Property channelUseExternalEmoji
Type boolean
Required No
Default false
Description: Use emojis from other servers.
[Optional] Property channelVideoStreamMedia
Type boolean
Required No
Default false
Description: Stream video in channels.
[Optional] Property channelView
Type boolean
Required No
Default false
Description: Ability to view channel content.
[Optional] Property channelViewFile
Type boolean
Required No
Default false
Description: View files shared in channels.
[Optional] Property channelViewMessageHistory
Type boolean
Required No
Default false
Description: Read past messages.
[Optional] Property channelVoiceDeafenOther
Type boolean
Required No
Default false
Description: Deafen other users in voice channels.
[Optional] Property channelVoiceKick
Type boolean
Required No
Default false
Description: Kick users from voice channels.
[Optional] Property channelVoiceMuteOther
Type boolean
Required No
Default false
Description: Mute other users in voice channels.
[Optional] Property channelVoiceTalk
Type boolean
Required No
Default false
Description: Speak in voice channels.

deploy items​

node_modules items​

groups items​

items items​

userIds items​

communityRoleIds items​

userIds items​

communityRoleIds items​

channelIds items​

channelGroupIds items​

options items​

deploy items

node_modules items

groups items

items items

userIds items

communityRoleIds items

userIds items

communityRoleIds items

channelIds items

channelGroupIds items

options items