Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cblgh/sector7557
a peer-to-peer distributed multi-user dungeon, built ontop of cabal
https://github.com/cblgh/sector7557
cabal dat mud node nodejs p2p
Last synced: 2 months ago
JSON representation
a peer-to-peer distributed multi-user dungeon, built ontop of cabal
- Host: GitHub
- URL: https://github.com/cblgh/sector7557
- Owner: cblgh
- License: agpl-3.0
- Created: 2020-08-04T15:02:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-06T14:28:33.000Z (over 4 years ago)
- Last Synced: 2024-10-03T23:51:34.046Z (3 months ago)
- Topics: cabal, dat, mud, node, nodejs, p2p
- Language: JavaScript
- Homepage: https://mud.cblgh.org
- Size: 31.3 KB
- Stars: 18
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sector7557
_a peer-to-peer distributed multi-user dungeon, built ontop of cabal_
**Create** Walk with the arrow keys, place tiles by pressing WASD. Change a
selected tile by pressing keys on your keyboard. Certain tiles are impassable.
**Describe** Stand on a tile, press `Enter` and type to describe the tile
underneath the player character. The description will be shown to anyone who
stands on the tile. Even if the tile is replaced with another sigil, the
description will remain. Descriptions can be overwritten in the same manner as
they are written.
**Chat** Chat with others in the same world by pressing `Enter` and invoking the
`/w` command.
_the walkers phase in and out of the sectors, leaving traces of the worlds they build_
## Install
```sh
npm i -g sector7557
```
## Usage
```sh
# read the help
sector7557 --help
sector7557 --manual
# join sector7557
sector7557 mud.cblgh.org # join the public instance
sector7557 --new # create a new world
```
### Commands
The commands can be invoked by pressing enter, to trigger the terminal, and then writing them per the syntax.
```
/w write a chat message
start entering a description for tile at player position
/nick set nickname
/sector name or describe the entire current sector
/fg set tile foreground color
/bg set tile background color
/self if 1 character, set's player character. if color code, sets player color
/help show the ingame help
/reset reset current fg/bg color selection
/legend print a legend of the allowed and passable sigils which can be placed
/clear clear non-player chat messages (e.g. legend, help)
press various keyboard keys to select a tile sigil for creation
force redraw screen (clears up buggy screen artefacts from ANSI color clash)
```
### Color name
You can set colors for tiles and for your player character using the `fg`, `bg`
and `self` commands from above. When setting a color, a code from below must be
used.
Note: Colors on the same line below, e.g. _red2, pink_, are the same color, the
latter being an alias.
```
black
black2
grey, gray
grey2, gray2
red
red2, pink
green
green2
yellow
yellow2
blue
blue2
magenta
magenta2
teal, cyan
teal2, cyan2
white
white2
none
```
### Tiles and Sigils
The world is built out of **tiles**, which consist of a **sigil** and
**foreground** / **background** colors. A sigil is a simple ASCII character.
There is a limited amount of characters which are allowed as tiles at the
moment, a subset of which are passable (can be traversed by a player).
See the list of sigils below. It can also be found inside sector7557 by invoking `/legend`.
```
PASSABLE
.|-_,>x<^v¤!?"
ALLOWED (but not passable)
\* #o+$%&/()=;§:
```
It is likely that the amount of sigils will be expanded in future patches.
### Terminology
* The player is a **walker**
* The world is made out of **sectors**
* Each screen is a **map**
* A tile is a combination of a **sigil**, a foreground color (**fg**), and a
background color **(bg)**