Briyah SDK - v2.0.18
    Preparing search index...

    Interface PackRoomTemplate

    A room a pack ships, ready to instantiate with its whole cast.

    interface PackRoomTemplate {
        agents: PackRoomAgentEntry[];
        beginInstruction?: string;
        goal: string;
        illustrationMode?: "off" | "on-request" | "auto";
        imageAspect?: ImageAspect;
        imageModel?: string;
        key: string;
        moderator?: string;
        name: string;
        roomLeader?: string;
        timeZone?: string;
        turnMode?: "broadcast" | "directed";
    }
    Index
    agents beginInstruction? goal illustrationMode? imageAspect? imageModel? key moderator? name roomLeader? timeZone? turnMode?
    agents: PackRoomAgentEntry[]

    The roster, as loaded.

    In the JSON a bare string is accepted as sugar for { key }; readPack normalizes it, so by the time anything else sees a template every entry is an object.

    beginInstruction?: string

    What Begin sends to this room's leader, shipped with the template.

    Here rather than in whatever service builds the room, so a pack's opening move is written beside the prompts it has to agree with.

    goal: string
    illustrationMode?: "off" | "on-request" | "auto"

    When the room illustrates itself. Absent means on-request.

    imageAspect?: ImageAspect

    The default shape of the room's pictures. Absent means square.

    imageModel?: string

    Which entry in image_models.json draws this room, when the pack wants a particular one. Absent leaves the room on the server default.

    key: string
    moderator?: string

    The moderator, also named by agent key.

    name: string
    roomLeader?: string

    The leader, named by agent key rather than by nickname.

    A template cannot carry a nickname: the nickname is derived at creation from the bare name's first word, the user may rename, and two agents in a room may not share one. Instantiation resolves the key to whatever nickname the created agent ended up with.

    timeZone?: string

    The IANA time zone the room's agents are told today's date in. Absent means they are not told — what a story or campaign wants. A name the runtime does not know is dropped when the pack is read.

    turnMode?: "broadcast" | "directed"

    Settings
    Member Visibility

    On This Page
    Properties