Rooms

In Ranvier all rooms for an area are defined in a single file within the area folder: rooms.yml

Example File

bundles/core-areas/areas/limbo/rooms.yml

- id: 1
  title: "Test Room 1"
  description: "A featureless white room. A pitch black void in the shape of archway can be seen on the east side of the room."
  npcs: ["limbo:1"]
  items: ["limbo:3"]
  script: "1-test"
  exits:
    - roomId: "limbo:2"
      direction: "east"
      leaveMessage: " steps into the void and disappears."
- id: 2
  title: "Test Room 2"
  description: "A completely black room. Somehow all of the light that should be coming from the room to the west does not pass through the archway. A single lightbulb hangs from the ceiling illuminating a small area."
  behaviors: [ "test" ]
  items: ["limbo:2"]
  npcs: ["limbo:2"]
  exits:
    - roomId: "limbo:1"
      direction: "west"
      leaveMessage: " steps into the light and disappears."

Definition Fields

field type (default)


id number
required Room id unique among the rooms of the current area
title string
required Title of the room shown on look
description string
required Long description of the room shown under the title on look
npcs Array<EntityReference>
List of NPCs to place in this room on initial load
items Array<EntityReference>
List of items to place in this room on initial load
script string
Name of custom script to attach to this room (See Scripting)
behaviors array<string>
List of behaviors to attach to this room (See Scripting)
exits Array
Rooms the player can get to from here, each exits entry has the following fields:
direction string
required Movement command the player will use to leave the room (Standard compass directions are suggested)
roomId EntityReference
required Room the player will end up in when they go this direction
leaveMessage string
Message shown to the room when the player leaves the room in this direction. in the Room 1 example above players in the same room will see "Shawn steps into the void and disappears." when Shawn leaves to the east.