diff --git a/README.md b/README.md index 0cbba71..e0d5abb 100644 --- a/README.md +++ b/README.md @@ -35,29 +35,28 @@ MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMdyymMMMMMMMMMMMMMMMMMMMMMMMMMMM ``` ## summary ``` -dr1p4ns1 v2.3 - cp437 ansi parsing - this logic will be rolled into bots like krylon/maple/g1mp +dr1p4ns1 v2.3 - cp437 ansi parser ``` ## screenshots ![screenshots](screenshots/ss1.jpg) ![screenshots](screenshots/ss2.jpg) +## overview +``` +a menu system to browse ansi files, copy/remove files, preview ansi files and pump them out over irc. +ansi files can be queued so that when you pump they are being sent in a sequential manner. +``` ## prerequisites - `python3` +## content +- dr1p4ns1.py - **main file** +- ansiscii/*.ans - **example: directory of ansi files** ## usage - main file -``` -running 'python3 dr1p4ns1.py' will load all the ansi files in the present working directory -running 'python3 dr1p4ns1.py ansiscii' will load all the ansi files in a directory path -``` -## files overview -``` -dr1p4ns1.py - main file -ansiscii/*.ans - an example ansi files directory -``` +- syntax: `python3 dr1p4ns1.py` - **will load all the ansi files in the present working directory** +- syntax: `python3 dr1p4ns1.py ansiscii` - **will load all the ansi files in this directory path** +## setting up environment +- `git clone --recursive https://git.tcp.direct/decoded/dr1p4ns1.git` ## notes -``` -PUMPQUEUE: using the q key you can queue up a bunch of ansis to pump, then just press p to fire -them off. if there is nothing in the queue then whatever is on the screen will be pumped to fifo. -``` -``` -FIFO: in order to use the pump feature, you need a fifo setup in something like weechat/irsii/etc.. -if you have one setup, adjust the FIFO_PATH at the top of dr1p4ns1.py -``` +- **PUMPQUEUE:** using the q key you can queue up a bunch of ansis to pump, then just press p to fire + them off. if there is nothing in the queue then whatever is on the screen will be pumped to fifo. +- **FIFO:** in order to use the pump feature, you need a fifo setup in something like weechat/irsii/etc.. + if you have one setup, adjust the FIFO_PATH at the top of dr1p4ns1.py