tildemush-docs/README.md

# Tildemush documentation

This manual will serve as a reference for
[tilde.town](https://tilde.town)'s tildemush virtual community, lead
by [vilmibm](https://tilde.town/~vilmibm/). It is intended for new and
experienced users who have an account on
[tilde.town](https://tilde.town). This manual will provide an
introduction to tildemush, understanding the interface, using
tildemush, and the WITCH scripting language.

If you are looking for a testing or developing environment, see
[vilmibm](https://github.com/vilmibm)'s notes [here](https://github.com/vilmibm/tildemush)

# Table of contents

- [What is tildemush?](#what-is-tildemush)
- [Purpose and goals](#purpose-and-goals)
- [Getting started](#getting-started)
    - [Conventions used in this manual](#conventions-used-in-this-manual)
    - [Requirements](#requirements)
- [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)
        - [Element a here](#element-a-here)
        - [Element b here](#element-b-here)
    - [WORLDMAP tab](#worldmap-tab)
        - [Element a here](#element-a-here-1)
        - [Element b here](#element-b-here-1)
    - [SETTINGS tab](#settings-tab)
        - [Element a here](#element-a-here-2)
        - [Element b here](#element-b-here-2)
    - [QUIT tab](#quit-tab)
- [Using tildemush](#using-tildemush)
    - [Starting tildemush](#starting-tildemush)
        - [To start tildemush](#to-start-tildemush)
    - [Accessing the MAIN tab](#accessing-the-main-tab)
        - [To access the MAIN tab](#to-access-the-main-tab)
    - [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)
    - [Copying text](#copying-text)
        - [To copy text](#to-copy-text)
    - [Pasting text](#pasting-text)
        - [To paste text](#to-paste-text)
    - [Accessing the WITCH tab](#accessing-the-witch-tab)
        - [To access the WITCH tab](#to-access-the-witch-tab)
    - [Accessing the WORLDMAP tab](#accessing-the-worldmap-tab)
        - [To access the WORLDMAP tab](#to-access-the-worldmap-tab)
    - [Accessing the SETTINGS tab](#accessing-the-settings-tab)
        - [To access the SETTINGS tab](#to-access-the-settings-tab)
    - [Quitting tildemush](#quitting-tildemush)
        - [To quit tildemush](#to-quit-tildemush)
- [Scripting with WITCH](#scripting-with-witch)
- [More information](#more-information)

<!-- References
23:28 <vilmibm> m455: re: the conversation in tush: it's a little hard to read but you can get a good idea of what WITCH provides here:
                https://github.com/vilmibm/tildemush/blob/master/server/tmserver/witch_header.hy
23:29 <vilmibm> there are also functioning WITCH examples in the test suite, for example,
                https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/game_object_test.py#L160
23:30 <vilmibm> (why a common test game object is a horse named Snoozy is a memory I have since lost)
23:31 <vilmibm> ah there are a bunch of WITCH objects in here! just search the page for "incantation"
                https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/async_test.py
-->

# 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 looks like a chat room with elements such as:

* Your location name
* A list user-created objects that exist in your location
* Your inventory
* A scripting tab for creating objects

# Purpose and goals

[For vilmibm, if they are comfortable with filling this out. Go all out!]

# Getting started

This section consists of the following subsections:

- [Conventions used in this manual](#conventions-used-in-this-manual)
- [Requirements](#requirements)

## Conventions used in this manual

* **Note** - Notes signify additional information
* **Tip** - Tips signify an alternate procedure for completing a step
* **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"
* subsections - Heading 2s, 3s, etc. are referred to as "subsections"

## Requirements

* A [tilde.town](https://tilde.town) account

# Understanding the interface

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
* The location box
* The map box
* The inventory box

### The chatbox

The chat box will display the following:

* 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]

### 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:

TODO: List elements

### Element a here

TODO

### Element b here

TODO

## WORLDMAP tab

The WORLDMAP tab consists of:

TODO: List elements

### Element a here

TODO

### Element b here

TODO

## SETTINGS tab

The SETTINGS tab consists of:

TODO: List elements

### Element a here

TODO

### Element b here

TODO

## 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

TODO: WIIFM
TODO: Update this section outline as the headings are made

- [Starting tildemush](#starting-tildemush)
    - [To start tildemush](#to-start-tildemush)

## Starting tildemush

Starting tildemush will run the software required to connect to the
tildemush virtual community 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

## Accessing the MAIN tab

The MAIN tab can be accessed from any of the tabs.

### To access the MAIN tab

1. Press `F1`

## Sending a message to all users in your current location

[TODO]

### To send a message to all users in your current location

1. Type your message
2. Press `Enter`

## Copying text

[TODO]

### To copy text

1. Highlight the text you want to copy using your mouse
2. Hold `Shift` and `Ctrl`
3. Press `c` while holding down `Shift` and `Ctrl`

## Pasting text

[TODO]

### To paste text

1. Hold `Shift` and `Ctrl`
2. Press `v` while holding down `Shift` and `Ctrl`

**Tip** - Your terminal emulator may allow you to paste text by right-clicking, and then selecting `Paste`.

## Accessing the WITCH tab

[TODO]

### To access the WITCH tab

1. Press `F2`

## Accessing the WORLDMAP tab

[TODO]

### To access the WORLDMAP tab

1. Press `F3`

## Accessing the SETTINGS tab

[TODO]

### To access the SETTINGS tab

1. Press `F4`

## Quitting tildemush

Quitting tildemush will bring you back to your normal shell session on tilde.town.

### To quit tildemush

1. Press `F9`

# Scripting with WITCH

TODO: WIIFM
TODO: Section outline

# More information