You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
123 lines
4.0 KiB
123 lines
4.0 KiB
ABOUT
|
|
|
|
Termighty is a script package designed for use with the TinTin++ MUD client and the
|
|
Aardwolf MUD (http://aardwolf.com). It is meant to provide quality of life features
|
|
for players on UNIX-like platforms with minimal resource consumption or distraction.
|
|
|
|
An explicit goal of Termighty is to keep compatibility with modern versions of
|
|
TinTin++ and tmux, as well as to be easy to update and maintain for anyone who
|
|
wishes to do so.
|
|
|
|
Termighty is named in honor of the mighty terminal, from which one can have a
|
|
first-class MUDding experience; and the humble termite, a favorite snack of the
|
|
aardwolf.
|
|
|
|
INFO
|
|
|
|
Players can download the package, run bin/termighty, and play.
|
|
|
|
Anyone interested in development of Termighty should peruse the HTML documentation
|
|
in docs/
|
|
|
|
Termighty attempts to keep up to date with TinTin++ and tmux. Presently it is
|
|
developed and tested against:
|
|
|
|
- TinTin++ 2.02.12 (2021-08-30) - https://tintin.mudhalla.net/
|
|
- tmux 3.1c (2020-10-30) - https://github.com/tmux/tmux
|
|
|
|
The optional notification system by default relies on the following:
|
|
|
|
- notify-send (libnotify-bin)
|
|
- ogg123 (vorbis-tools)
|
|
|
|
Termighty assumes a UTF-8 capable terminal. For compatibility with ASCII-only
|
|
terminals, edit conf/options.tin and set mapType to 0.
|
|
|
|
GETTING STARTED
|
|
|
|
0. Check prerequisites, install if necessary
|
|
|
|
REQUIRED:
|
|
tt++ -V (tested: 2.02.11)
|
|
tmux -V (tested: 3.1c)
|
|
UTF-8 terminal (edit conf/options.tin, set maptype 0 if not)
|
|
|
|
OPTIONAL:
|
|
notify-send -v
|
|
ogg123 -V
|
|
|
|
1. Clone the repository
|
|
|
|
git clone https://git.sr.ht/~fierre/termighty
|
|
|
|
2. Start termighty
|
|
|
|
cd termighty; ./bin/termighty
|
|
|
|
CONFIGURING
|
|
|
|
Termighty tries to be plug and play with sane defaults. However, there are a few
|
|
knobs you can turn.
|
|
|
|
For channel filtering, add or remove the complete GMCP channel name to
|
|
privateChannels in conf/options.tin . See the Aardwolf GMCP Channel reference here
|
|
for the available names: http://www.aardwolf.com/wiki/index.php/Clients/GMCP#aardmodules_comm
|
|
|
|
To disable chat log timestamps, change tsFormat in conf/options.tin to {}
|
|
|
|
During play, use "loadconfig" to update configured options, for example after
|
|
changing potion preferences.
|
|
|
|
For notifications, edit scripts in hooks/
|
|
|
|
POTION TRACKING AND QUAFFING
|
|
|
|
- qh quaffs the current healing potion
|
|
- qm quaffs the current mana potion
|
|
- hpotName sets the name of your healing potion of choice
|
|
Example: hpotName (!(Light Relief)!)
|
|
- hpotCmd sets the command to use to quaff your healing potion of choice
|
|
Example: hpotCmd quaff light
|
|
- mpotName sets the name of your mana potion of choice
|
|
- mpotCmd sets the command to use to quaff your mana potion of choice
|
|
|
|
Use 'loadconfig' after changing potion configuration.
|
|
|
|
MAPPING
|
|
|
|
Rooms will be automatically mapped as you explore.
|
|
|
|
Maps will be autosaved every 5 minutes, and saved on disconnect (quit).
|
|
|
|
If you need to restore map data, look at mapdata/autosave.map.
|
|
|
|
To interact with the map:
|
|
|
|
- msearch <roomID|token> -- will find all rooms matching the provided token.
|
|
A partial match is fine, and will return all mapped rooms that match (case-
|
|
insensitive).
|
|
|
|
- mfind <roomID|room name> -- will show the speedwalk to the provided roomID or
|
|
exact room name.
|
|
|
|
- mrun <roomID|room name> -- same as mfind, but runs the path for you.
|
|
|
|
Map support is preliminary. Portals are not supported yet. Room tags like norecall,
|
|
noportal, etc. are not yet usefully processed.
|
|
|
|
CONTACT
|
|
|
|
In game: Fierre
|
|
TinTin++ Forums: Fierre - https://tintin.sourceforge.io/forum/index.php
|
|
Issue tracker: https://todo.sr.ht/~fierre/termighty
|
|
Email: See game or git history
|
|
|
|
LICENSE
|
|
|
|
Termighty is provided under the Unlicense with the hope that it can be useful to MUD
|
|
players for years to come.
|
|
|
|
WEBSITE
|
|
|
|
https://git.sr.ht/~fierre/termighty
|