From fdab46bef11abea22a14240cb38372f071fcb890 Mon Sep 17 00:00:00 2001 From: rasul Date: Sun, 5 Apr 2020 16:37:03 -0500 Subject: [PATCH] document the world module --- src/world/mod.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/world/mod.rs b/src/world/mod.rs index 682b9a9..ebc2d30 100644 --- a/src/world/mod.rs +++ b/src/world/mod.rs @@ -1,4 +1,14 @@ -//! The game world. Regions, zones, and rooms. +//! The game world. +//! +//! The world is divided up into zones and rooms. A zone can contain a +//! collection of both rooms and zones. Each zone and room can specify if the +//! players inside it are visible to the sibling rooms and zones. +//! +//! This allows for some granularity in the zone design. An example, there may +//! be a zone for a city, containing a few rooms for gates and a few zones for +//! different regions of the city. One might be the trade district, and each +//! shop might be a single room, or zone with a few rooms depicting the layout +//! of a large store. mod area; mod direction;