Browse Source

merge remote readme changes

master
Brandon Cornejo 2 years ago
parent
commit
45208414dc
  1. 15
      README.md

15
README.md

@ -18,6 +18,7 @@ For reference, I host this configuration on a Linux VPS and thus am able to "tak
* Chat Monitor
* Map Door Text parser
* Hotspot timers
* Group shield monitor
* ASCII map
### Commands and Scripts
@ -28,8 +29,8 @@ For reference, I host this configuration on a Linux VPS and thus am able to "tak
Read a letter in your inventory and print a solution, with the term to scry highlighted. Mostly uses the data from the Dead Letters page on the [wiki](https://dwwiki.mooo.com/wiki/Dead_letter_office_jobs). Works only for **difficult customers** and **distant lands**.
#### Prompt: TPA/XP Monitor
* Files: `src/prompt.tin`, `src/xpmonitor.tin`, `src/tpamonitor.tin`
#### Prompt: TPA/XP/Quota Monitor
* Files: `src/prompt.tin`, `src/xpmonitor.tin`, `src/tpamonitor.tin`, `src/quota.tin`
A tintin++ split across the top of the MUD window proper that displays a few bits of information:
1) How long has the session been running
@ -37,6 +38,9 @@ A tintin++ split across the top of the MUD window proper that displays a few bit
3) The average XP/hour rate over that time
4) Do you have a TPA active
5) What colour is your TPA currently
6) How long until quota flips (appears if relevant)
7) Quota timer is coloured when in the last hour
8) In-game alerts for 1 hour, 30m, 10m left of quota
#### Map Door Text GMCP Parser
* Files: `src/mdtparse.py`, `mdtconfig.json`, `src/gmcp.tin`
@ -45,7 +49,7 @@ A tintin++ split across the top of the MUD window proper that displays a few bit
This python script (`src/mdtparse.py`) parses the mapdoortext data delivered by GMCP as you move rooms and displays a nice formatted list. Customizable with a configuration file (`mdtconfig.json`) that allows for picking out particular NPCs, assigning them point values, and colouring.
#### Item/NPC/Room Search
* Files: `src/quow.tin`
* Files: `src/db.tin`
* Made possible by [Quow's](http://quow.co.uk) fantastic data collection and publicly available database.
A series of TinTin aliases that invoke SQLite to search through Quow's database and retrieve various information about game items, people and places.
@ -123,7 +127,7 @@ All of the above searches (room, npc, npcitem, item) are filterable by area, jus
```
#### Speedwalking
* Files: `src/maproute.py`, `src/gmcp.tin`, `src/quow.tin`
* Files: `src/maproute.py`, `src/gmcp.tin`, `src/db.tin`
* Route-finding logic and of course the database taken directly from [Quow's](http://quow.co.uk) lovely MUSHclient package.
A python script (`src/maproute.py`) is handed the room_identifier of your current location and of your target location and attempts to create an alias to walk you there. This functionality can be invoked in-game with the `db route #` command, where `#` is the result number (0-9) that preceeds the results in any of the previously mentioned database search commands (`db item`, `db npc`, `db room`, `db gatherable`)
@ -286,6 +290,9 @@ Clears out all current group shield data, and then runs "group shields" again to
* Per day separated log files
* More...
### Layouts
The "Discworld" shell script will configure a slim (mobile friendly) layout when run with no arguments. This adds a split for chat and MDT stacked above the MUD window itself. If run with "full" as an argument, the timers, shield monitor, ascii-map will be off to the right hand side. If you are already inside of the "discworld" tmux session, running "Discworld" will re-arrange the layout as specified for easy switching between desktop and mobile.
## Credit Where It's Due
I've spent a lot of time and effort on this setup to make it perfect for my use and the contents herein have all been touched or modified by me in some way if not created outright, but I've been inspired by and blatantly stolen bits of it from two folks in particular:

Loading…
Cancel
Save