diff --git a/README.md b/README.md index 5fa6aea..fd4de09 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # A set of utilities for tracking text-based game releases Originally a parser for Russian Interactive Fiction, now it's much more than that. -There are three executable PHP scripts here that serve different functions but share the code. +[Русская версия readme](README.rus.md) + +These are executable PHP scripts that serve different functions but share the code. ### run.php This one was the first. @@ -15,6 +17,9 @@ This one does the same in continuous fashion, posting the feed to Mastodon or Te 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. +### kril.php +Just ignore this, it's for Russian IF comp. + ## Installation 1. Copy the `config.yml.example` to `config.yml`, edit it. diff --git a/README.rus.md b/README.rus.md new file mode 100644 index 0000000..1061da5 --- /dev/null +++ b/README.rus.md @@ -0,0 +1,33 @@ +# Утилиты для отслеживания релизов текстовых игр +Изначально парсер для русской интерактивной литературы, теперь нечто большее. + +Каждый скрипт делает что-то своё, но основной код у них общий. + +### run.php +Этот был первым, он самый простой. +Он сканирует хостинги игр, находит новые релизы за последнюю неделю и выводит +в консоль список в форматах Markdown или HTML. Всё автоматически. + +Если передать параметр, например, `itch`, то он сканирует только указанный сайт. + +Второй параметр - URL страницы, чтобы просканировать страницу одной игры. + +### bot.php +То же самое, но постоянно и постит вывод в Mastodon и/или Telegram. + +### wiki.php +Сканирует страницу одной игры и создаёт записи на [IFWiki.](http://ifwiki.ru) + +Если страница уже есть на вики, выводит текст, который хотел записать. +Автоматически заменять текст не пытается, это надо смотреть вручную. +Если находит обложку игры, тоже заливает её на вики. + +### kril.php +Оформление результатов [КРИЛа 2018.](http://kril.ifiction.ru) + +## Установка + +1. Скопировать `config.yml.example` в `config.yml`, отредактировать. + 1. Параметр `DRY_RUN` отвечает за тест: `true` означает, что скрипты бота и вики не попытаются создавать страницы и постить записи, а выведут текст и закончат работу. +1. Скачать [`composer`](https://getcomposer.org/) и выполнить `composer install` +1. Запустить скрипты. (консольный php 7+ с установленными php-xml и php-mbstring) diff --git a/config.yml.example b/config.yml.example index 4bd411a..9a6b480 100644 --- a/config.yml.example +++ b/config.yml.example @@ -1,14 +1,14 @@ DRY_RUN: true -TELEGRAM: true -MASTODON: true -MASTODON_ACCESS_TOKEN: token +TELEGRAM: true # нужен ли Telegram +MASTODON: true # нужен ли Mastodon +MASTODON_ACCESS_TOKEN: token # токен аккаунта Mastodon MASTODON_SERVER: https://botsin.space MASTODON_USER: user TELEGRAM_API_KEY: some-key-here TELEGRAM_BOT_NAME: bot name TELEGRAM_CHAT_ID: id -BITLY_TOKEN: token -parsers: # delete unused +BITLY_TOKEN: token # токен сервиса сокращения ссылок bit.ly для Mastodon и Telegram +parsers: # delete unused / удалите ненужное - classname: Qsp - @@ -37,10 +37,10 @@ parsers: # delete unused classname: Gamejolt - classname: Steam -STYLE: 'RUS' -FORMAT: 'HTML' -WIKI: "https://ifwiki.ru/api.php" -WIKIUSER: "wikiuser" -WIKIPASSWORD: "wikipassword" -VNDB_USER: "vndbuser" -VNDB_PASSWORD: "vndbpassword" +STYLE: 'RUS' # RUS / ENG +FORMAT: 'HTML' # HTML / MARKDOWN +WIKI: "https://ifwiki.ru/api.php" # адрес API IFwiki +WIKIUSER: "wikiuser" # логин юзера IFWiki +WIKIPASSWORD: "wikipassword" # пароль бота IFWiki +VNDB_USER: "vndbuser" # логин VNDB +VNDB_PASSWORD: "vndbpassword" # пароль VNDB