tildetown
/
tildemush-docs
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
53 Commits
1 Branch
0 Tags
70 KiB
Go to file
m455 14dffc616e pushing for now. breakfast time 2020-03-22 10:01:28 -04:00
README.md pushing for now. breakfast time 2020-03-22 10:01:28 -04:00

README.md

Tildemush documentation

This documentation serves as a reference for tilde.town's tildemush virtual community, lead by vilmibm. It is intended for users who have an account on tilde.town. If you are looking for a testing or developing environment, see vilmibm's notes here

Table of contents

What is tildemush?

tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to provide an environment for creativity, imagination, and art. Currently, tildemush hosted on tilde.town.

tildemush may look like a chat room, but it is completely programmable, and includes other elements such as:

  • Locations that can be traversed by users
  • User-scripted objects that users can interact with
  • User inventory and apparel
  • A scripting tab for creating objects
  • and many more

Purpose and goals

TODO for vilmibm

Conventions used in this documentation

  • 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

Getting started

This section describes conventions, which will help you understand the formatting used in this document, and the requirements for using tildemush.

This section consists of the following subsections:

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. Press the enter key

Creating a new user account

TODO: Significance to user

To create a new user account

TODO: procedures

Logging in

TODO: Significance to user

To log in

TODO: procedures

Resetting your password

TODO: Significance to user

To reset your password

TODO: procedures

Configuring tildemush

TODO: Significance to user

To configure tildemush

TODO: procedures

Exiting from the start menu

TODO: Significance to user

To exit from the start menu

TODO: procedures

MAIN tab

The main tab consists of:

  • The chat box, which contains:

    • User messages
    • Events
    • Actions from users
    • Actions from objects
    • Responses from objects

  • The location box, which contains:

    • Your current location's name
    • Your current location's description
    • Your current location's user-created objects

  • The map box, which contains:

    • TODO: Verify if these are the places you have visited or all places that connect to the current location

  • The inventory box, which contains:

    • Number of objects you have
    • Names of objects you have

Accessing the MAIN tab

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

To access the MAIN tab

  1. Press F1

WITCH tab

The WITCH tab consists of:

  • The object pane, which displays the name and permissions of the object that is being edited.
  • The object-scripting pane, which displays the scripts of the object that is being edited. This is the area you will edit the functionality of an object.

Accessing the WITCH tab

The WITCH tab provides an interface for creating objects.

To access the WITCH tab

  1. Press F2

WORLDMAP tab

The WORLDMAP tab consists of:

  • Area blocks, which are user-created locations you can travel to in the MAIN tab.
  • Direction names, which are user-created names that a user can type to travel to different area blocks in the MAIN tab

Accessing the WORLDMAP tab

The WORLDMAP tab provides visuals on how all locations are connected.

To access the WORLDMAP tab

  1. Press F3

SETTINGS tab

The SETTINGS tab is under development.

Accessing the SETTINGS tab

The SETTINGS tab is under development.

To access the SETTINGS tab

  1. Press F4

QUIT tab

The QUIT tab does not contain elements. It serves as a reminder of how to quit tildemush. See the Quitting tildemush subsection.

Using tildemush

This section will teach you how to use tildemush and assumes you are familiar with tildemush's interface.

This section consists of the following subsections:

TODO

Sending a message to all users in your current location

The MAIN tab allows you to interact with users and objects. The MAIN tab is where you will communicate with other users.

To send a message to all users in your current location

  1. Ensure you are in the MAIN tab
  2. Type your message
  3. Press Enter

Tip: You can also use the /say command to send a message to all users in your current location.

Example:

/say hey there! can anyone hear me?

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: Explain significance to user

This section consists of the following subsections:

TODO

Extra tips

This section will describe useful actions for working in tildemush and the terminal.

This section consists of:

  • Copying text
  • Pasting text

Copying text

There are various ways to highlight text in the terminal, one of the easiest ways is to use your mouse.

To copy text

  1. Highlight the text you want to copy using your mouse
  2. Hold the Shift and Ctrl keys
  3. Press c
  4. Release the Shift and Ctrl keys

Pasting text

[TODO]

To paste text

  1. Hold the Shift and Ctrl keys
  2. Press v
  3. Release the Shift and Ctrl keys

Tip - Your terminal emulator may allow you to paste text using one of the following methods:

  • middle-clicking
  • right-clicking, and then selecting Paste.

Sharing your WITCH code

TODO: Significance to user

To share your WITCH code

TODO: procedures

Frequently asked questions

TODO

  • Is tildemush the same as IRC?
    • TODO: Answer