Creating an Area
Areas contain all the "content" of the MUD: items, npcs, rooms, and quests.
A single bundle can contain multiple areas and like bundles an area need only have the files necessary for the content (i.e., you don't need to include a quests file if you have no quests.) For pedagogical completeness this example bundle with a single area has all of the possible entities: items, npcs, scripts, and quests.
Click on any of the items to see more in-depth tutorials on their contents.
ranvier-areas/ areas/ limbo/ - Actual area folder, name will be used as key for `area:id` pairs which you'll see for items/npcs scripts/ - Scripts for individual entities manifest.yml - Required - Metadata about the area itself items.yml - Item definitions npcs.yml - NPC definitions rooms.yml - Room definitions quests.js - Quest implementations
The manifest right now is incredibly simple and only requires one setting:
--- title: "My Area Title" info: respawnInterval: 60
- Number of seconds between respawn ticks. See the Room section for respawn details
Very often you'll see strings like
limbo:1. These are entity references and can refer to Items, NPCs, Rooms, and Quests. The type of entity the reference points to is inferred from its usage (e.g.,
foobar:1 in an
items list would point to an Item.) Let's take a look at an example NPC definition
Assuming both of these definitions live in
- id: 1 name: "Joe Schmoe" items: [ "foobar:1" ]
and an accompanying item definition
- id: 1 name: "Sword of Awesomeness"
In the definition of Joe Schmoe
foobar:1 in the
items property says "Find item with the ID
1 in the area
foobar". Entity ids are only unique within the same entity type of the same area. So Joe Schmoe's entity reference would also be
This type will be described in the subsequent docs as