tildemush-docs/README.md

tildemush manual

This manual will serve as a reference for tilde.town's tildemush virtual community, lead by vilmibm. It is intended for new and experienced users who have an account on 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's notes here

Table of Contents

• What is tildemush?
• Purpose and Goals
• Getting started
  • Conventions used in this manual
  • Requirements
• Understanding the interface
  • MAIN tab
    • The chatbox
    • The location box
    • The map box
    • The inventory box
  • WITCH tab
    • Element a here
    • Element b here
  • WORLDMAP tab
    • Element a here
    • Element b here
  • SETTINGS tab
    • Element a here
    • Element b here
  • QUIT tab
• Using tildemush
  • Starting tildemush
    • To start tildemush
  • Accessing the MAIN tab
    • To access the MAIN tab
  • Sending a message to all users in your current location
    • To send a message to all users in your current location
  • Copying text
    • To copy text
  • Pasting text
    • To paste text
  • Accessing the WITCH tab
    • To access the WITCH tab
  • Accessing the WORLDMAP tab
    • To access the WORLDMAP tab
  • Accessing the SETTINGS tab
    • To access the SETTINGS tab
  • Quitting tildemush
    • To quit tildemush
• Scripting with WITCH
• More information

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.

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

• Conventions used in this manual
• 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"
• Topics - Heading 2s, 3s, etc. are referred to as "Topics"

Requirements

• A tilde.town account

Understanding the interface

This section consists of the following topics:

• MAIN tab
• WITCH tab
• WORLDMAP tab
• SETTINGS 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 topic.

Using tildemush

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

• Starting 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.

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

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