2020-01-07 22:44:30 +00:00
|
|
|
# tildemush handbook
|
2020-01-07 23:05:03 +00:00
|
|
|
|
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
|
|
|
|
|
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 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 -->
|
2020-01-08 01:17:27 +00:00
|
|
|
**Table of Contents**
|
2020-01-07 22:24:28 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
- [tildemush handbook](#tildemush-handbook)
|
2020-01-07 22:44:30 +00:00
|
|
|
- [What is tildemush?](#what-is-tildemush)
|
2020-01-08 01:17:27 +00:00
|
|
|
- [Describing tildemush](#describing-tildemush)
|
|
|
|
|
- [Creating tildemush](#creating-tildemush)
|
2020-01-07 22:44:30 +00:00
|
|
|
- [Getting started](#getting-started)
|
2020-01-07 22:24:28 +00:00
|
|
|
- [Conventions used in this handbook](#conventions-used-in-this-handbook)
|
|
|
|
|
- [Requirements](#requirements)
|
2020-01-07 22:44:30 +00:00
|
|
|
- [Platforms](#platforms)
|
|
|
|
|
- [Software](#software)
|
2020-01-07 23:05:03 +00:00
|
|
|
- [Starting tildemush](#starting-tildemush)
|
2020-01-08 01:17:27 +00:00
|
|
|
- [To start tildemush](#to-start-tildemush)
|
2020-01-07 23:05:03 +00:00
|
|
|
- [Understanding the interface](#understanding-the-interface)
|
|
|
|
|
- [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 -->
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
<!-- 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
|
|
|
-->
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
# What is tildemush?
|
2020-01-07 22:24:28 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
This section consists of the following topics:
|
2020-01-07 23:05:03 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
- [Describing tildemush](#describing-tildemush)
|
|
|
|
|
- [Creating tildemush](#creating-tildemush)
|
2020-01-07 23:05:03 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
## Describing tildemush
|
2020-01-07 23:05:03 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
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).
|
2020-01-07 23:05:03 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
tildemush looks like a chatroom with elements such as:
|
2020-01-07 23:22:40 +00:00
|
|
|
|
2020-01-08 01:17:27 +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
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
## Creating tildemush
|
2020-01-07 22:24:28 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
[For vilmibm, if they are comfortable with filling this out. Go all out!]
|
2020-01-07 22:44:30 +00:00
|
|
|
|
|
|
|
|
# Getting started
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
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)
|
|
|
|
|
|
2020-01-07 22:44:30 +00:00
|
|
|
## 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
|
2020-01-08 01:17:27 +00:00
|
|
|
* **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```
|
2020-01-08 01:17:27 +00:00
|
|
|
* Section - Heading 1s are referred to as "Sections"
|
|
|
|
|
* Topics - Heading 2s, 3s, etc. are referred to as "Topics"
|
2020-01-07 23:05:03 +00:00
|
|
|
|
2020-01-07 22:24:28 +00:00
|
|
|
## Requirements
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
TODO
|
|
|
|
|
|
2020-01-07 22:44:30 +00:00
|
|
|
### Platforms
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
TODO
|
|
|
|
|
|
2020-01-07 22:44:30 +00:00
|
|
|
### Software
|
2020-01-07 22:49:41 +00:00
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
TODO
|
|
|
|
|
|
2020-01-07 22:49:41 +00:00
|
|
|
## Starting tildemush
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
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
|
|
|
|
|
|
2020-01-07 22:49:41 +00:00
|
|
|
# Understanding the interface
|
|
|
|
|
|
2020-01-08 01:17:27 +00:00
|
|
|
<!-- messy notes for this section begin here
|
|
|
|
|
tildemush runs on the command line and contains the following
|
|
|
|
|
tabs:
|
|
|
|
|
|
|
|
|
|
* MAIN
|
|
|
|
|
* WITCH
|
|
|
|
|
* WORLDMAP
|
|
|
|
|
* SETTINGS
|
|
|
|
|
* Chatroom
|
|
|
|
|
*
|
|
|
|
|
with usernames, but it also has different areas users can exist
|
|
|
|
|
in. Each area contains users and objects.
|
|
|
|
|
-->
|
|
|
|
|
|
2020-01-07 22:49:41 +00:00
|
|
|
# Using tildemush
|
|
|
|
|
|
|
|
|
|
# Scripting with WITCH
|
2020-01-07 23:05:03 +00:00
|
|
|
|
|
|
|
|
# More information
|
