Frisk/RcGcDw
1
0
Fork 0
mirror of https://gitlab.com/chicken-riders/RcGcDw.git synced 2025-02-23 00:24:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated README to make it more clear

Browse source
This commit is contained in:
Frisk 2018-07-17 17:23:52 +02:00
parent 1380deafcb
commit aca7c3977d
No known key found for this signature in database
GPG key ID: 0E9A7D3C0A01586C
1 changed files with 1 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -15,27 +15,7 @@ Recent changes Gamepedia compatible Discord webhook is a project made from earli
* Re-sends edits after down-time
### settings.json ###
Explanation for settings:
`cooldown` – interval for how often changes are retrieved from the wiki (due to used solutions, the real interval is ~1 sec longer).
`wiki` – wiki prefix the bot is supposed to work with (for example, for English Minecraft Wiki it's minecraft (https://**minecraft**.gamepedia.com) and for Polish Minecraft Wiki minecraft-pl (https://**minecraft-pl**.gamepedia.com)
`lang` – language for the messages, currently available options are: de, en, fr, pl.
`header` – it's recommended to leave this value as it is, it's a header the script will use to communicate with Gamepedia. Please note that without it, no communication will be possible.
`limit` – amount of actions retrieved every `cooldown` amount of seconds. The higher it is the more network data will be used and the data will be processed longer, setting it to higher values is not recommended unless cooldown value is higher it also cannot be higher than 500.
`webhookURL` – webhook URL you can get using [channel settings in Discord](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks).
`limitrefetch` – limit of how many changes can be retrieved when refetch happens, cannot be lower than limit. -1 if you want to disable auto-refetch. Value cannot be higher than 500.
`wikiname` – a name of the wiki the bot will work on, required in some messages.
`avatars` – this section makes specific types of messages overwrite the default webhook avatar.
* `connection_failed` – message printed when script fails connection with the wiki several times.
* `no_event` – error message when the event couldn't be recognized by the script.
* `embed` – every embed message showing changes.
`verbose_level` – a number (min 0, max 50) identifying the type of messages that will be written into the console. (CRITICAL 50, ERROR 40, WARNING 30, INFO 20, DEBUG 10).
`show_updown_messages` – bool value, depending on this settings the messages whenever the wiki goes up and down will be sent to the channel.
`appearience` – section with different types of actions and logs, and corresponding to them colors/icons. In here you can set custom icon or color!
`overview` – bool value, sends a day overview to the channel if true.
`overview_time` – **local machine time** at which the day overview will be sent.
`license_regex` – if you have an unusual or translated template for applying licenses to images, you can modify this value with proper regex expression. The capturing group for license name should be named "license". **remember about double escaping the backslashes**
`license_regex_detect` – a regex detecting a license, it differs from `license_regex` by the fact that it has to match only the beginning of license template. **remember about double escaping the backslashes**
[Explanation for settings](/Settings.json)
### How to use ###
Make sure you have installed all of dependencies and **filled settings.json properly**. You can also use `pip install -r requirements.txt` to install dependencies automatically. If you are using Raspberry Pi you won't have newest Python version installed, you can use [this guide](https://gist.github.com/dschep/24aa61672a2092246eaca2824400d37f).