roryejinn/lotj-mudlet-ui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Updating README

Browse Source
This commit is contained in:
Matt Wagner 2020-10-24 23:59:54 -07:00
parent 36d4b9a513
commit f69412b70c
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -2,25 +2,13 @@
This is an attempt to provide a richer UI for [Legends of the Jedi MUD](https://www.legendsofthejedi.com/) in Mudlet. This is an attempt to provide a richer UI for [Legends of the Jedi MUD](https://www.legendsofthejedi.com/) in Mudlet.
![Image of UI with ground map](https://github.com/rengawm/lotj-mudlet-ui/blob/main/images/ground-map.png?raw=true)
## Features ## Features
### Live-updating Status Bar
![Image of Status Bar](https://github.com/rengawm/lotj-mudlet-ui/blob/main/images/stats-bar.png?raw=true)
Right above your input box, you'll see a bunch of useful information which updates live. This includes:
- Your HP/Move/(Mana?)
- Opponent's name and percentage
- Current comlink channel and encryption code
- Ship speed, coordinates, hull, shield, energy
- Piloting and chaff indicators, and a countdown to the next space tick
### Ground Map ### Ground Map
![Image of UI with ground map](https://github.com/rengawm/lotj-mudlet-ui/blob/main/images/ground-map.png?raw=true)
This package includes a script hooking into Mudlet's mapper so you can map by (mostly) just walking around an unexplored area. This package includes a script hooking into Mudlet's mapper so you can map by (mostly) just walking around an unexplored area.
It works fairly well on all existing planets. It's based on room vnums, which means it will consider each ship to be fully unique rooms. It works fairly well on all existing planets. It's based on room vnums, which means it will consider each ship to be fully unique rooms.
@ -41,6 +29,18 @@ After initializing it by running various in-game commands, this map will show al
Certain types of chat content are scraped from the main console and copied into tabbed chat windows for easier history browsing. Certain types of chat content are scraped from the main console and copied into tabbed chat windows for easier history browsing.
### Live-updating Status Bar
![Image of Status Bar](https://github.com/rengawm/lotj-mudlet-ui/blob/main/images/stats-bar.png?raw=true)
Right above your input box, you'll see a bunch of useful information which updates live. This includes:
- Your HP/Move/(Mana?)
- Opponent's name and percentage
- Current comlink channel and encryption code
- Ship speed, coordinates, hull, shield, energy
- Piloting and chaff indicators, and a countdown to the next space tick
## Installing ## Installing