binaryatrocity/discworld-tintin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add tmux setup section to README.md

Browse Source
This commit is contained in:
Brandon Cornejo 2026-02-28 19:23:25 -06:00
parent da8179ab6f
commit 6948c9ed2d
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -89,6 +89,8 @@ High-level feature list (not exhaustive):
* [Quota Flip Alerts](#quota-flip-alerts) * [Quota Flip Alerts](#quota-flip-alerts)
* [Prompt Bar Timer](#prompt-bar-timer) * [Prompt Bar Timer](#prompt-bar-timer)
* [Other Color Highlights and Triggers](#other-color-highlights-and-triggers) * [Other Color Highlights and Triggers](#other-color-highlights-and-triggers)
* [Tmux Setup](#tmux-setup)
* [Toggle Full or Mobile View](#toggle-full-or-mobile-view)
* [Mouse Support](#mouse-support) * [Mouse Support](#mouse-support)
* [Scrolling Buffer](#scrolling-buffer) * [Scrolling Buffer](#scrolling-buffer)
* [Input Bar](#input-bar) * [Input Bar](#input-bar)
@ -173,8 +175,6 @@ You must force the MUD to show the ASCII map above look/glance output, use the f
* `options output map look = top` * `options output map look = top`
* `options output map lookcity = top` * `options output map lookcity = top`
# Features # Features
## Speedwalking and Room/NPC/Item Search ## Speedwalking and Room/NPC/Item Search
@ -701,6 +701,28 @@ A countdown of time left until your quota flips will be displayed in the [prompt
* copperhead mines * copperhead mines
- minesolve - minesolve
# Tmux Setup
The "Discworld" shell script either creates a new or attaches to an existing tmux session named `discworld`. When creating a session it uses [tmuxp](https://github.com/tmux-python/tmuxp) to create the layout and run initial commands for each pane. The layout definition for `tmuxp` is in the `discworld.yaml` file.
I recommend sym-linking the Discworld script to some place in your $PATH as 'disc' so that at anytime you can type `disc` into a terminal and create or take-over your DiscworldMUD session, for example:
```
sudo ln -s /home/myuser/discworld-tintin/Discworld /usr/bin/disc
```
## Toggle Full or Mobile View
When connected via mobile device its convenient to collapse the right-hand side bar, hiding the spot-timers, group shields and minimap panes to view the MUD full-width when in portrait orientation. The `Discworld` script configures two key bindings to quickly make this adjustment:
* `<leader>Ctrl-F` - toggle to full-view (sidebar visible)
* `<leader>Ctrl-G` - toggle to mobile-view (sidebar collapsed)
Here's an example of full-view on mobile:
![Screenshot](https://atr0phy.net/discworld-tintin/mobile_full.png)
And the collapsed view on mobile:
![Screenshot](https://atr0phy.net/discworld-tintin/mobile_collapsed.png)
# Mouse Support # Mouse Support
The latest versions of TinTin++ have expanded mouse support, which has been implemented in the following ways. The latest versions of TinTin++ have expanded mouse support, which has been implemented in the following ways.