tildemush-docs/tildemush-handbook.md

236 lines
6.3 KiB
Markdown
Raw Normal View History

# tildemush handbook
2020-01-07 23:30:21 +00:00
This handbook will serve as a reference for
[tilde.town](https://tilde.town)'s tildemush virtual community, lead
2020-01-08 01:24:34 +00:00
by [vilmibm](https://tilde.town/~vilmibm/). It is intended for new and
experienced users who have an account on
2020-01-07 23:30:21 +00:00
[tilde.town](https://tilde.town). This handbook will provide an
introduction to tildemush, understanding the interface, using
tildemush, and the WITCH scripting language.
2020-01-07 22:24:28 +00:00
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**
2020-01-07 22:24:28 +00:00
- [tildemush handbook](#tildemush-handbook)
- [What is tildemush?](#what-is-tildemush)
- [Describing tildemush](#describing-tildemush)
- [Creating tildemush](#creating-tildemush)
- [Getting started](#getting-started)
2020-01-07 22:24:28 +00:00
- [Conventions used in this handbook](#conventions-used-in-this-handbook)
- [Requirements](#requirements)
- [Starting tildemush](#starting-tildemush)
- [To start tildemush](#to-start-tildemush)
- [Understanding the interface](#understanding-the-interface)
2020-01-08 01:35:40 +00:00
- [MAIN tab](#main-tab)
2020-01-08 02:04:28 +00:00
- [Accessing the MAIN tab](#accessing-the-main-tab)
- [To access the MAIN tab](#to-access-the-main-tab)
- [The chatbox](#the-chatbox)
- [The location box](#the-location-box)
- [The map box](#the-map-box)
- [The inventory box](#the-inventory-box)
2020-01-08 01:35:40 +00:00
- [WITCH tab](#witch-tab)
2020-01-08 02:04:28 +00:00
- [Element a here](#element-a-here)
- [Element b here](#element-b-here)
2020-01-08 01:35:40 +00:00
- [WORLDMAP tab](#worldmap-tab)
2020-01-08 02:04:28 +00:00
- [Element a here](#element-a-here-1)
- [Element b here](#element-b-here-1)
2020-01-08 01:35:40 +00:00
- [SETTINGS tab](#settings-tab)
2020-01-08 02:04:28 +00:00
- [Element a here](#element-a-here-2)
- [Element b here](#element-b-here-2)
2020-01-08 01:35:40 +00:00
- [QUIT tab](#quit-tab)
- [Using tildemush](#using-tildemush)
- [Scripting with WITCH](#scripting-with-witch)
- [More information](#more-information)
2020-01-07 22:24:28 +00:00
<!-- markdown-toc end -->
<!-- Note to self:
Everytime the TOC is generated, change the "Table of Contents" to an
H1, and remove the title of the document"
-->
2020-01-07 23:31:43 +00:00
<!-- 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)
2020-01-07 23:33:00 +00:00
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
2020-01-07 23:31:43 +00:00
-->
# What is tildemush?
2020-01-07 22:24:28 +00:00
This section consists of the following topics:
- [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:
2020-01-07 23:22:40 +00:00
* 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.
2020-01-07 22:24:28 +00:00
## Creating tildemush
2020-01-07 22:24:28 +00:00
[For vilmibm, if they are comfortable with filling this out. Go all out!]
# Getting started
This section consists of the following topics:
2020-01-08 02:04:28 +00:00
- [Conventions used in this handbook](#conventions-used-in-this-handbook)
- [Requirements](#requirements)
- [Starting tildemush](#starting-tildemush)
2020-01-08 02:04:28 +00:00
- [To start tildemush](#to-start-tildemush)
## Conventions used in this handbook
2020-01-07 22:24:28 +00:00
2020-01-07 23:07:48 +00:00
* **Note ++** - Notes signify additional information
2020-01-07 23:10:20 +00:00
* **Tip >>** - Tips signify an alternate procedure for completing a step
* **Caution !!** - Cautions signify that damage or loss of data may occur
2020-01-07 23:10:20 +00:00
* **Example** - Examples provide a visual reference of how a procedure would be performed
2020-01-07 23:07:48 +00:00
* `Inline code` - Inline code signifies package names, filenames, commands, and keyboard keys
2020-01-07 23:08:27 +00:00
* ```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"
2020-01-07 22:24:28 +00:00
## Requirements
2020-01-08 01:24:34 +00:00
* A [tilde.town](https://tilde.town) account
2020-01-07 22:49:41 +00:00
## Starting tildemush
Starting tildemush will run the software required to connect to the
2020-01-08 01:24:34 +00:00
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
2020-01-07 22:49:41 +00:00
# Understanding the interface
2020-01-08 01:35:40 +00:00
This section consists of the following topics:
2020-01-08 02:04:28 +00:00
[TODO: UPDATE THIS]
2020-01-08 01:35:40 +00:00
## MAIN tab
2020-01-08 02:04:28 +00:00
The main tab consists of:
* The chat box
* The location box
* The map box
* The inventory box
### Accessing the MAIN tab
The MAIN tab can be accessed from any of the tabs.
#### To access the MAIN tab
1. Press `F1`
### 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
2020-01-08 01:35:40 +00:00
## WITCH tab
TODO
2020-01-08 02:04:28 +00:00
### Element a here
TODO
### Element b here
TODO
2020-01-08 01:35:40 +00:00
## WORLDMAP tab
TODO
2020-01-08 02:04:28 +00:00
### Element a here
TODO
### Element b here
TODO
2020-01-08 01:35:40 +00:00
## SETTINGS tab
TODO
2020-01-08 02:04:28 +00:00
### Element a here
TODO
### Element b here
TODO
2020-01-08 01:35:40 +00:00
## QUIT tab
TODO
2020-01-07 22:49:41 +00:00
# Using tildemush
2020-01-08 02:04:28 +00:00
Section outline
2020-01-07 22:49:41 +00:00
# Scripting with WITCH
2020-01-08 02:04:28 +00:00
Section outline
# More information