6.9 KiB
tildemush handbook
This handbook 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 handbook will provide an introduction to tildemush, understanding the interface, using tildemush, and the WITCH scripting language.
Table of Contents
- tildemush handbook
- What is tildemush?
- Purpose and Goals
- Getting started
- Understanding the interface
- Using 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
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.
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 handbook
- 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 keysCode 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:
[TODO: UPDATE THIS]
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
TODO
Element a here
TODO
Element b here
TODO
WORLDMAP tab
TODO
Element a here
TODO
Element b here
TODO
SETTINGS tab
TODO
Element a here
TODO
Element b here
TODO
QUIT tab
TODO
Using tildemush
TODO: PC TODO: Update this as it progresses
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.
-
sshinto tilde.town -
Run
tmclient -
Use the
up-arrow,down-arrow, andenter-keyto 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
- Press
F1
Accessing the WITCH tab
[TODO]
To access the WITCH tab
- Press
F2
Accessing the WORLDMAP tab
[TODO]
To access the WORLDMAP tab
- Press
F3
Accessing the SETTINGS tab
[TODO]
To access the SETTINGS tab
- Press
F4
Quitting tildemush
TODO
To quit tildemush
- Press
F9
Scripting with WITCH
TODO Section outline