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

31 lines
1.2 KiB
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
[![pipeline status](https://gitlab.com/ifiction/news-script/badges/master/pipeline.svg)](https://gitlab.com/ifiction/news-script/commits/master)
2019-04-16 08:52:05 +03:00
[Русская версия readme](README.rus.md)
These are executable PHP scripts 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
2019-04-16 08:52:05 +03:00
### kril.php
Just ignore this, it's for Russian IF comp.
2018-05-13 10:29:18 +03:00
## Installation
2019-04-16 09:32:10 +03:00
1. Install `pandoc` and `php` with `mbstring` and `xml` extensions.
1. Install [`composer`](https://getcomposer.org/) and execute `composer install`
2018-05-15 14:11:18 +03:00
1. Copy the `config.yml.example` to `config.yml`, edit it.
1. Run the scripts.