Archived
1
0
Fork 0
This repository has been archived on 2020-07-31. You can view files and clone it, but cannot push or open issues or pull requests.
news-script/README.md

23 lines
1,021 B
Markdown
Raw Normal View History

2018-05-13 10:12:34 +03:00
# A set of utilities for tracking text-based game releases
Originally a parser for Russian Interactive Fiction, now it's much more than that.
2017-02-08 06:11:07 +02:00
2018-05-13 10:12:34 +03:00
There are three executable PHP scripts here that serve different functions but share the code.
2017-02-16 07:33:46 +02:00
2018-05-13 10:29:18 +03:00
### run.php
2018-05-13 10:12:34 +03:00
This one was the first.
Its function is simple: it scans some game hosting sites, finds the new games (published during the last week) and prints a neat list in Markdown or HTML format.
All automatic.
2018-05-13 10:29:18 +03:00
### bot.php
2018-05-13 10:12:34 +03:00
This one does the same in continuous fashion, posting the feed to Mastodon or Telegram.
2018-05-13 10:29:18 +03:00
### wiki.php
2018-05-13 10:12:34 +03:00
And this one makes wiki pages for the [IFWiki](http://ifwiki.ru).
It uses Russian IFWiki syntax and templates but it would be easy to alter for the English IFWiki as well if you'd want that.
2018-05-13 10:29:18 +03:00
## Installation
1. Copy the `config.ini.example` to `config.ini`, edit for your liking.
2. Copy the `config.yml.example` to `config.yml` if you need to run `bot.php`; the other two use INI config format. (I know the code is not 100% merged)
3. Run the scripts.