diff --git a/README.md b/README.md index 81f155e..419ebbc 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,20 @@ Originally a parser for Russian Interactive Fiction, now it's much more than tha There are three executable PHP scripts here that serve different functions but share the code. -## run.php +### run.php 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. -## bot.php +### bot.php This one does the same in continuous fashion, posting the feed to Mastodon or Telegram. -## wiki.php +### wiki.php 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. + +## 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. diff --git a/config.ini.example b/config.ini.example index 0247aa0..0e301e9 100644 --- a/config.ini.example +++ b/config.ini.example @@ -1,2 +1,8 @@ STYLE = "RUS" FORMAT = "HTML" +WIKI = "https://ifwiki.ru/api.php" +WIKIUSER = "wikiuser" +WIKIPASSWORD = "wikipassword" +DUMMY = true +VNDB_USER="vndbuser" +VNDB_PASSWORD="vndbpassword"