RcGcDw/README.md

39 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Overview ##
*Recent changes Gamepedia compatible Discord webhook* is a project made from earlier recent changes module of IRC bot. It has been remade as independent script for public use.
Screenshots of the script in action can be found [on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation).
### Features ###
* Fetch recent changes from Gamepedia wiki and send them to Discord channel using a webhook
* Two appearance modes - embed and compact
* Send daily overviews, that show general information about wiki activity
* Supports multiple languages (included EN, PL, BR, RU, FR, UK)
* Re-sends missed edits after start
### Dependencies ###
* **Python 3.6>**
* requests 2.18.4>
* beautifulsoup 4.6.0>
* schedule 0.5.0>
* lxml 4.2.1>
### settings.json ###
[Explanation for settings](https://gitlab.com/piotrex43/RcGcDw/wikis/settings.json)
### How to use ###
[Refer to the guide on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Guide). If you don't have the means to host it you can request me to host it for you.
### Contributors ###
* MarkusRost for enormous help with pointing out bugs, space for improvements and contributing to the code.
* I'd like to thank Minecraft Wiki English Discord server community, most notably Jack McKalling for input on how the script should work, especially formatting and what information should be there.
#### Translators ####
* MarkusRost German translation
* JSBM French translation
* Eduaddad Brazilian Portuguese translation
* BabylonAS Russian translation
* Mak_and_Iv Ukrainian translation
Thank you!
### Wiki ###
For more information, check the [wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Home)!