Browse Source

Update 'README.md'

main
travis 5 months ago
parent
commit
aace92e5b2
  1. 33
      README.md

33
README.md

@ -1,5 +1,30 @@ @@ -1,5 +1,30 @@
# cnd-tdih
# CaNerDUH Presents:
CaNerDUH Presents:
This Day In History for Mystic BBS
## This Day In History for Mystic BBS
This Mystic BBS mod which will display show random events from This Day In History. It is written with Mystic Python (MPY).
## Installation
### Requirements
1. Python 3 working with Mystic BBS
2. curl (to Download the JSON file)
### Files
1. Copy tdih.mpy to the scripts folder for your theme
2. Copy the tdih.ans to the text folder for your theme
### Cron job
In order to automate the downloading of the events each day you will need a cron job similar to this:
```
0 0 * * * curl -s https://history.muffinlabs.com/date -o /mystic/tdih.json
```
Just edit the path to the root directory of your Mystic BBS.
### Mystic Configuration
Use Menu option **GZ** and **tdih** in the data field. (I like to launch mine from the prelogin menu.)

Loading…
Cancel
Save