diff --git a/README.md b/README.md index 9cc652b..d2faef2 100644 --- a/README.md +++ b/README.md @@ -26,19 +26,29 @@ If you are looking for a testing or developing environment, see - [To configure tildemush](#to-configure-tildemush) - [Exiting from the start menu](#exiting-from-the-start-menu) - [To exit from the start menu](#to-exit-from-the-start-menu) -- [MAIN tab](#main-tab) +- [Understanding the interface](#understanding-the-interface) + - [MAIN tab](#main-tab) + - [The chatbox](#the-chatbox) + - [The location box](#the-location-box) + - [The map box](#the-map-box) + - [The inventory box](#the-inventory-box) + - [WITCH tab](#witch-tab) + - [The object pane](#the-object-pane) + - [The object-scripting pane](#the-object-scripting-pane) + - [WORLDMAP tab](#worldmap-tab) + - [Area blocks](#area-blocks) + - [Direction names](#direction-names) + - [SETTINGS tab](#settings-tab) + - [QUIT tab](#quit-tab) +- [Accessing tabs](#accessing-tabs) - [Accessing the MAIN tab](#accessing-the-main-tab) - [To access the MAIN tab](#to-access-the-main-tab) -- [WITCH tab](#witch-tab) - [Accessing the WITCH tab](#accessing-the-witch-tab) - [To access the WITCH tab](#to-access-the-witch-tab) - - [WORLDMAP tab](#worldmap-tab) - [Accessing the WORLDMAP tab](#accessing-the-worldmap-tab) - [To access the WORLDMAP tab](#to-access-the-worldmap-tab) - - [SETTINGS tab](#settings-tab) - [Accessing the SETTINGS tab](#accessing-the-settings-tab) - [To access the SETTINGS tab](#to-access-the-settings-tab) -- [QUIT tab](#quit-tab) - [Using tildemush](#using-tildemush) - [Sending a message to all users in your current location](#sending-a-message-to-all-users-in-your-current-location) - [To send a message to all users in your current location](#to-send-a-message-to-all-users-in-your-current-location) @@ -99,16 +109,18 @@ misc references: # What is tildemush? -tildemush is a command line-, text-based virtual community used for -chatting, creating, roleplaying, games, or anything a user can think -of. Currently, tildemush hosted on [tilde.town](https://tilde.town). +tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to +provide an environment for creativity, imagination, and art. Currently, tildemush hosted on +[tilde.town](https://tilde.town). -tildemush looks like a chat room with elements such as: +tildemush may look like a chat room, but it is completely programmable, and includes other elements +such as: -* Your location name -* A list user-created objects that exist in your location -* Your inventory +* Locations that can be traversed by users +* User-scripted objects that users can interact with +* User inventory and apparel * A scripting tab for creating objects +* and many more # Purpose and goals @@ -200,28 +212,107 @@ TODO: Significance to user TODO: procedures -# MAIN tab +# Understanding the interface + +This section will introduce you to each interface tab, and each element inside of each tab. + +This section consists of the following subsections: + +- [MAIN tab](#main-tab) +- [WITCH tab](#witch-tab) +- [WORLDMAP tab](#worldmap-tab) +- [SETTINGS tab](#settings-tab) +- [QUIT tab](#quit-tab) + +## MAIN tab The main tab consists of: -* The chat box, which contains: - * User messages - * Events - * Actions from users - * Actions from objects - * Responses from objects +* The chat box +* The location box +* The map box +* The inventory box -* The location box, which contains: - * Your current location's name - * Your current location's description - * Your current location's user-created objects +### The chatbox -* The map box, which contains: - * TODO: Verify if these are the places you have visited or all places that connect to the current location +The chat box will display the following: -* The inventory box, which contains: - * Number of objects you have - * Names of objects you have +* User messages +* Events +* Actions from users +* Actions from objects +* Responses from objects + +### The location box + +The location box will display the following: + +* Your current location's name +* Your current location's description +* Your current location's user-created objects + +### The map box + +The map box will display the following: + +TODO: Verify if these are the places you have visited or all places that connect to the current location + +### The inventory box + +The inventory box will display the following: + +* Number of objects you have +* Name(s) of objects you have + +## WITCH tab + +The WITCH tab consists of: + +* The object pane +* The object-scripting pane + +### The object pane + +The object pane displays the name and permissions of the object that is being edited. + +### The object-scripting pane + +The object-scripting pane displays the scripts of the object that is being edited. This is the area you will edit the functionality of an object. + +## WORLDMAP tab + +The WORLDMAP tab consists of: + +* Area blocks +* Direction names + +### Area blocks + +Area blocks are user-created locations you can travel to in the tildemush world. + +### Direction names + +Direction names are user-created names that a user can type to travel to different area blocks. + +## SETTINGS tab + +The SETTINGS tab is under development. + +## QUIT tab + +The QUIT tab does not contain elements. It serves as a reminder of how +to quit tildemush. See the [Quitting tildemush](#quitting-tildemush) subsection. + +# Accessing tabs + +This section will provide information on each tildemush tab and teach you how to access each tildemush tab. + +This section consists of the following subsections: + +* [Accessing the MAIN tab](#accessing-the-main-tab) +* [Accessing the WITCH tab](#accessing-the-witch-tab) +* [Accessing the WORLDMAP tab](#accessing-the-worldmap-tab) +* [Accessing the SETTINGS tab](#accessing-the-settings-tab) ## Accessing the MAIN tab @@ -231,13 +322,6 @@ The MAIN tab can be accessed from any of the tabs. 1. Press `F1` -# WITCH tab - -The WITCH tab consists of: - -* The object pane, which displays the name and permissions of the object that is being edited. -* The object-scripting pane, which displays the scripts of the object that is being edited. This is the area you will edit the functionality of an object. - ## Accessing the WITCH tab The WITCH tab provides an interface for creating objects. @@ -246,14 +330,6 @@ The WITCH tab provides an interface for creating objects. 1. Press `F2` -## WORLDMAP tab - -The WORLDMAP tab consists of: - -* Area blocks, which are user-created locations you can travel to in the MAIN tab. -* Direction names, which are user-created names that a user can type to travel to different area - blocks in the MAIN tab - ## Accessing the WORLDMAP tab The WORLDMAP tab provides visuals on how all locations are connected. @@ -262,10 +338,6 @@ The WORLDMAP tab provides visuals on how all locations are connected. 1. Press `F3` -## SETTINGS tab - -The SETTINGS tab is under development. - ## Accessing the SETTINGS tab The SETTINGS tab is under development. @@ -274,11 +346,6 @@ The SETTINGS tab is under development. 1. Press `F4` -# QUIT tab - -The QUIT tab does not contain elements. It serves as a reminder of how -to quit tildemush. See the [Quitting tildemush](#quitting-tildemush) subsection. - # Using tildemush This section will teach you how to use tildemush and assumes you are familiar with