From 4761e795c5afff2800099e025a26c99fc72e1569 Mon Sep 17 00:00:00 2001 From: m455 Date: Tue, 7 Jan 2020 20:17:27 -0500 Subject: [PATCH] populated most of the getting started section --- tildemush-handbook.md | 108 ++++++++++++++++++++++++++++++++---------- 1 file changed, 82 insertions(+), 26 deletions(-) diff --git a/tildemush-handbook.md b/tildemush-handbook.md index 9e4c0ca..be0a5c7 100644 --- a/tildemush-handbook.md +++ b/tildemush-handbook.md @@ -8,22 +8,20 @@ and experienced users who have an account on introduction to tildemush, understanding the interface, using tildemush, and the WITCH scripting language. - - -# Table of Contents +**Table of Contents** -- [Quick start](#quick-start) +- [tildemush handbook](#tildemush-handbook) - [What is tildemush?](#what-is-tildemush) - - [Description](#description) - - [Background](#background) + - [Describing tildemush](#describing-tildemush) + - [Creating tildemush](#creating-tildemush) - [Getting started](#getting-started) - [Conventions used in this handbook](#conventions-used-in-this-handbook) - [Requirements](#requirements) - [Platforms](#platforms) - [Software](#software) - [Starting tildemush](#starting-tildemush) + - [To start tildemush](#to-start-tildemush) - [Understanding the interface](#understanding-the-interface) - [Using tildemush](#using-tildemush) - [Scripting with WITCH](#scripting-with-witch) @@ -31,6 +29,11 @@ of Contents" to an H1, and remove the title of the document" --> + + https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/async_test.py --> -# Quick start - -This section is for people who have a [tilde.town](https://tilde.town) -account, and are comfortable with what they know about tildemush, but -need a few commands to get them started. - -1. `ssh` into [tilde.town](https://tilde.town) - -2. Run `tmclient` - -3. Use the `up-arrow`, `down-arrow`, and `enter-key` to login or register - -**Caution !!** - tildemush's database may be wiped, because it is -still under development. This means that anything you create, may be -deleted. - # What is tildemush? -## Description +This section consists of the following topics: -## Background +- [Describing tildemush](#describing-tildemush) +- [Creating tildemush](#creating-tildemush) + +## Describing 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 looks like a chatroom with elements such as: + +* Your location name +* A list user-created objects that exist in your location +* Your inventory + +tildemush also has its own scripting language called WITCH. This +language is used to create in-game objects, which users can interact +with. tildemush provides a separate tab for scripting in WITCH. + +## Creating tildemush + +[For vilmibm, if they are comfortable with filling this out. Go all out!] # Getting started +This section consists of the following topics: + +- [Conventions used in this handbook](#conventions-used-in-this-handbook) +- [Requirements](#requirements) + - [Platforms](#platforms) + - [Software](#software) +- [Quick start](#quick-start) +- [Starting tildemush](#starting-tildemush) + ## Conventions used in this handbook * **Note ++** - Notes signify additional information * **Tip >>** - Tips signify an alternate procedure for completing a step -* **Caution !!** - Cautions signify that damage may occur +* **Caution !!** - Cautions signify that damage or loss of data may occur * **Example** - Examples provide a visual reference of how a procedure would be performed * `Inline code` - Inline code signifies package names, filenames, commands, and keyboard keys * ```Code block - Code blocks signify file contents, or an interface element``` +* Section - Heading 1s are referred to as "Sections" +* Topics - Heading 2s, 3s, etc. are referred to as "Topics" ## Requirements +TODO + ### Platforms +TODO + ### Software +TODO + ## Starting tildemush +Starting tildemush will run the software required to connect to the +tildemush server that exists on [tilde.town](https://tilde.town). + +### To start tildemush + +**Caution !!** - Before continuing, you should know that tildemush's +database may be wiped at any time, because it is still under +development. This means that anything you create, may be deleted at +any time. + +1. `ssh` into [tilde.town](https://tilde.town) + +2. Run `tmclient` + +3. Use the `up-arrow`, `down-arrow`, and `enter-key` to login or + create an account + # Understanding the interface + + # Using tildemush # Scripting with WITCH