RcGcDw/README.md

43 lines
2 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 Goat compatible Discord webhook* is a project created to track changes on the wiki directly on Discord.
**Screenshots** of the script in action can be found [on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation).
### Features ###
* Fetch recent changes from MediaWiki wiki or/and Discussions from Fandom wikis 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
* Very customizable
### 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).
### 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](https://eduardoaddad.com.br) Brazilian Portuguese translation
* BabylonAS and Russian Minecraft Wiki community Russian translation
* Mak_and_Iv Ukrainian translation
Thank you!
### Other extensions/compatible programs ###
* [Wiki Utilities](https://github.com/Sidemen19/Wiki-Utilities) - an integration allowing administrator to execute revert/block or delete actions on the wiki using reactions in messages created by RcGcDw/RcGcDb. Author: [Sidemen19](https://github.com/Sidemen19)
### Wiki ###
For more information, check the [wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Home)!