tildetown
/
tildemush-docs
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

main
m455 2020-03-29 15:56:58 -04:00
parent bd69b10634
commit 3c2397bd0a
1 changed files with 25 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,15 +1,25 @@
# Tildemush documentation # Tildemush documentation
This document serves as a reference for [tildemush](https://github.com/vilmibm/tildemush), tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to
[tilde.town](https://tilde.town)'s tildemush virtual community, lead provide an environment for creativity, imagination, and art. Currently, tildemush hosted on
by [vilmibm](https://tilde.town/~vilmibm/). [tilde.town](https://tilde.town).
This document is for users who have an account on [tilde.town](https://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
# Table of contents # Table of contents
- [What is tildemush?](#what-is-tildemush) - [About this document](#about-this-document)
- [Purpose and goals](#purpose-and-goals)
- [Conventions used in this documentation](#conventions-used-in-this-documentation) - [Conventions used in this documentation](#conventions-used-in-this-documentation)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Getting started](#getting-started) - [Getting started](#getting-started)
@ -63,6 +73,10 @@ This document is for users who have an account on [tilde.town](https://tilde.tow
- [To share your WITCH code](#to-share-your-witch-code) - [To share your WITCH code](#to-share-your-witch-code)
- [Frequently asked questions](#frequently-asked-questions) - [Frequently asked questions](#frequently-asked-questions)
<!-- markdown-toc end -->
<!-- References and todos <!-- References and todos
add before 'understanding the interface': add before 'understanding the interface':
@ -106,24 +120,13 @@ misc references:
https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/async_test.py https://github.com/vilmibm/tildemush/blob/master/server/tmserver/tests/async_test.py
--> -->
# What is tildemush? # About this document
tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to This document serves as a reference for [tildemush](https://github.com/vilmibm/tildemush),
provide an environment for creativity, imagination, and art. Currently, tildemush hosted on [tilde.town](https://tilde.town)'s tildemush virtual community, lead
[tilde.town](https://tilde.town). by [vilmibm](https://tilde.town/~vilmibm/).
tildemush may look like a chat room, but it is completely programmable, and includes other elements This document is for users who have an account on [tilde.town](https://tilde.town).
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 # Conventions used in this documentation