updated heading hierarchy
m455
parent
c74a40748e
commit
026bf17bb7
110
README.md
110
README.md
|
|
@ -4,11 +4,11 @@ tildemush is a text-based, programmatic virtual community on the command line. t
|
|||
provide an environment for creativity, imagination, and art. Currently, tildemush hosted on
|
||||
[tilde.town](https://tilde.town).
|
||||
|
||||
# Purpose and goals
|
||||
## Purpose and goals
|
||||
|
||||
TODO for vilmibm
|
||||
|
||||
# Table of contents
|
||||
## Table of contents
|
||||
|
||||
- [About this document](#about-this-document)
|
||||
- [Conventions used in this documentation](#conventions-used-in-this-documentation)
|
||||
|
|
@ -111,7 +111,7 @@ misc references:
|
|||
https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/async_test.py
|
||||
-->
|
||||
|
||||
# About this document
|
||||
## About this document
|
||||
|
||||
This document serves as a reference for [tildemush](https://github.com/vilmibm/tildemush),
|
||||
[tilde.town](https://tilde.town)'s tildemush virtual community, lead
|
||||
|
|
@ -119,7 +119,7 @@ by [vilmibm](https://tilde.town/~vilmibm/).
|
|||
|
||||
This document is for users who have an account on [tilde.town](https://tilde.town).
|
||||
|
||||
# Conventions used in this documentation
|
||||
## Conventions used in this documentation
|
||||
|
||||
* **Note** - Notes signify additional information
|
||||
* **Tip** - Tips signify an alternate procedure for completing a step
|
||||
|
|
@ -131,11 +131,11 @@ This document is for users who have an account on [tilde.town](https://tilde.tow
|
|||
* Section - Heading 1s are referred to as "Sections"
|
||||
* subsections - Heading 2s, 3s, etc. are referred to as "subsections"
|
||||
|
||||
# Requirements
|
||||
## Requirements
|
||||
|
||||
* A [tilde.town](https://tilde.town) account
|
||||
|
||||
# Getting started
|
||||
## Getting started
|
||||
|
||||
TODO
|
||||
|
||||
|
|
@ -148,13 +148,13 @@ This section consists of the following subsections:
|
|||
- [Configuring tildemush](#configuring-tildemush)
|
||||
- [Exiting from the start menu](#exiting-from-the-start-menu)
|
||||
|
||||
## Starting tildemush
|
||||
### Starting tildemush
|
||||
|
||||
Starting tildemush will run the software required to connect to the
|
||||
tildemush virtual community that exists on
|
||||
[tilde.town](https://tilde.town).
|
||||
|
||||
### To start tildemush
|
||||
#### To start tildemush
|
||||
|
||||
**Caution** - Before continuing, you should know that tildemush's
|
||||
database may be wiped at any time, because it is still under
|
||||
|
|
@ -165,47 +165,47 @@ any time.
|
|||
2. Run `tmclient`
|
||||
3. Press `<Enter>`
|
||||
|
||||
## Creating a new user account
|
||||
### Creating a new user account
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To create a new user account
|
||||
#### To create a new user account
|
||||
|
||||
TODO: procedures
|
||||
|
||||
## Logging in
|
||||
### Logging in
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To log in
|
||||
#### To log in
|
||||
|
||||
TODO: procedures
|
||||
|
||||
## Resetting your password
|
||||
### Resetting your password
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To reset your password
|
||||
#### To reset your password
|
||||
|
||||
TODO: procedures
|
||||
|
||||
## Configuring tildemush
|
||||
### Configuring tildemush
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To configure tildemush
|
||||
#### To configure tildemush
|
||||
|
||||
TODO: procedures
|
||||
|
||||
## Exiting from the start menu
|
||||
### Exiting from the start menu
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To exit from the start menu
|
||||
#### To exit from the start menu
|
||||
|
||||
TODO: procedures
|
||||
|
||||
# Understanding the interface
|
||||
## Understanding the interface
|
||||
|
||||
This section will introduce you to each interface tab, and each element inside of each tab.
|
||||
|
||||
|
|
@ -217,7 +217,7 @@ This section consists of the following subsections:
|
|||
- [SETTINGS tab](#settings-tab)
|
||||
- [QUIT tab](#quit-tab)
|
||||
|
||||
## MAIN tab
|
||||
### MAIN tab
|
||||
|
||||
The main tab consists of:
|
||||
|
||||
|
|
@ -226,7 +226,7 @@ The main tab consists of:
|
|||
* The map box
|
||||
* The inventory box
|
||||
|
||||
### The chatbox
|
||||
#### The chatbox
|
||||
|
||||
The chat box will display the following:
|
||||
|
||||
|
|
@ -236,7 +236,7 @@ The chat box will display the following:
|
|||
* Actions from objects
|
||||
* Responses from objects
|
||||
|
||||
### The location box
|
||||
#### The location box
|
||||
|
||||
The location box will display the following:
|
||||
|
||||
|
|
@ -244,59 +244,59 @@ The location box will display the following:
|
|||
* Your current location's description
|
||||
* Your current location's user-created objects
|
||||
|
||||
### The map box
|
||||
#### The map box
|
||||
|
||||
The map box will display the following:
|
||||
|
||||
TODO: Verify if these are the places you have visited or all places that connect to the current location
|
||||
|
||||
### The inventory box
|
||||
#### The inventory box
|
||||
|
||||
The inventory box will display the following:
|
||||
|
||||
* Number of objects you have
|
||||
* Name(s) of objects you have
|
||||
|
||||
## WITCH tab
|
||||
### WITCH tab
|
||||
|
||||
The WITCH tab consists of:
|
||||
|
||||
* The object pane
|
||||
* The object-scripting pane
|
||||
|
||||
### The object pane
|
||||
#### The object pane
|
||||
|
||||
The object pane displays the name and permissions of the object that is being edited.
|
||||
|
||||
### The object-scripting pane
|
||||
#### The object-scripting pane
|
||||
|
||||
The object-scripting pane displays the scripts of the object that is being edited. This is the area you will edit the functionality of an object.
|
||||
|
||||
## WORLDMAP tab
|
||||
### WORLDMAP tab
|
||||
|
||||
The WORLDMAP tab consists of:
|
||||
|
||||
* Area blocks
|
||||
* Direction names
|
||||
|
||||
### Area blocks
|
||||
#### Area blocks
|
||||
|
||||
Area blocks are user-created locations you can travel to in the tildemush world.
|
||||
|
||||
### Direction names
|
||||
#### Direction names
|
||||
|
||||
Direction names are user-created names that a user can type to travel to different area blocks.
|
||||
|
||||
## SETTINGS tab
|
||||
### SETTINGS tab
|
||||
|
||||
The SETTINGS tab is under development.
|
||||
|
||||
## QUIT tab
|
||||
### QUIT tab
|
||||
|
||||
The QUIT tab does not contain elements. It serves as a reminder of how
|
||||
to quit tildemush. See the [Quitting tildemush](#quitting-tildemush) subsection.
|
||||
|
||||
# Accessing tabs
|
||||
## Accessing tabs
|
||||
|
||||
This section will provide information on each tildemush tab and teach you how to access each tildemush tab.
|
||||
|
||||
|
|
@ -307,39 +307,39 @@ This section consists of the following subsections:
|
|||
* [Accessing the WORLDMAP tab](#accessing-the-worldmap-tab)
|
||||
* [Accessing the SETTINGS tab](#accessing-the-settings-tab)
|
||||
|
||||
## Accessing the MAIN tab
|
||||
### Accessing the MAIN tab
|
||||
|
||||
The MAIN tab can be accessed from any of the tabs.
|
||||
|
||||
### To access the MAIN tab
|
||||
#### To access the MAIN tab
|
||||
|
||||
1. Press `F1`
|
||||
|
||||
## Accessing the WITCH tab
|
||||
### Accessing the WITCH tab
|
||||
|
||||
The WITCH tab provides an interface for creating objects.
|
||||
|
||||
### To access the WITCH tab
|
||||
#### To access the WITCH tab
|
||||
|
||||
1. Press `F2`
|
||||
|
||||
## Accessing the WORLDMAP tab
|
||||
### Accessing the WORLDMAP tab
|
||||
|
||||
The WORLDMAP tab provides visuals on how all locations are connected.
|
||||
|
||||
### To access the WORLDMAP tab
|
||||
#### To access the WORLDMAP tab
|
||||
|
||||
1. Press `F3`
|
||||
|
||||
## Accessing the SETTINGS tab
|
||||
### Accessing the SETTINGS tab
|
||||
|
||||
The SETTINGS tab is under development.
|
||||
|
||||
### To access the SETTINGS tab
|
||||
#### To access the SETTINGS tab
|
||||
|
||||
1. Press `F4`
|
||||
|
||||
# Using tildemush
|
||||
## Using tildemush
|
||||
|
||||
This section will teach you how to use tildemush and assumes you are familiar with
|
||||
[tildemush's interface](#understanding-the-interface).
|
||||
|
|
@ -348,11 +348,11 @@ This section consists of the following subsections:
|
|||
|
||||
TODO
|
||||
|
||||
## Sending a message to all users in your current location
|
||||
### 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
|
||||
#### To send a message to all users in your current location
|
||||
|
||||
1. Ensure you are in the MAIN tab
|
||||
2. Type your message
|
||||
|
|
@ -367,15 +367,15 @@ location.
|
|||
/say hey there! can anyone hear me?
|
||||
```
|
||||
|
||||
## Quitting tildemush
|
||||
### Quitting tildemush
|
||||
|
||||
Quitting tildemush will bring you back to your normal shell session on tilde.town.
|
||||
|
||||
### To quit tildemush
|
||||
#### To quit tildemush
|
||||
|
||||
1. Press `F9`
|
||||
|
||||
# Scripting with WITCH
|
||||
## Scripting with WITCH
|
||||
|
||||
TODO: Explain significance to user
|
||||
|
||||
|
|
@ -383,7 +383,7 @@ This section consists of the following subsections:
|
|||
|
||||
TODO
|
||||
|
||||
# Extra tips
|
||||
## Extra tips
|
||||
|
||||
This section will describe useful actions for working in tildemush and the terminal.
|
||||
|
||||
|
|
@ -392,22 +392,22 @@ This section consists of:
|
|||
* Copying text
|
||||
* Pasting text
|
||||
|
||||
## Copying 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
|
||||
#### 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
|
||||
### Pasting text
|
||||
|
||||
[TODO]
|
||||
|
||||
### To paste text
|
||||
#### To paste text
|
||||
|
||||
1. Hold the `Shift` and `Ctrl` keys
|
||||
2. Press `v`
|
||||
|
|
@ -418,15 +418,15 @@ There are various ways to highlight text in the terminal, one of the easiest way
|
|||
* middle-clicking
|
||||
* right-clicking, and then selecting `Paste`.
|
||||
|
||||
## Sharing your WITCH code
|
||||
### Sharing your WITCH code
|
||||
|
||||
TODO: Significance to user
|
||||
|
||||
### To share your WITCH code
|
||||
#### To share your WITCH code
|
||||
|
||||
TODO: procedures
|
||||
|
||||
# Frequently asked questions
|
||||
## Frequently asked questions
|
||||
|
||||
TODO
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue