RcGcDw/README.md

52 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2018-06-15 13:56:35 +00:00
## Overview ##
*Recent changes Goat compatible Discord webhook* is a project created to track changes on MediaWiki wikis 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 a MediaWiki wiki and/or Discussions from Fandom wikis and send them to a 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)
2019-04-20 20:57:08 +00:00
* Re-sends missed edits after start
* Very customizable
2018-06-15 13:56:35 +00:00
2018-06-17 12:39:22 +00:00
### Dependencies ###
* **Python 3.7+**
* requests 2.18.4+
* beautifulsoup 4.6.0+
* lxml 4.2.1+
2018-06-17 12:39:22 +00:00
2019-04-20 20:57:08 +00:00
### settings.json ###
2018-07-17 15:26:48 +00:00
[Explanation for settings](https://gitlab.com/piotrex43/RcGcDw/wikis/settings.json)
2018-06-17 12:39:22 +00:00
### 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.
2018-06-18 22:13:24 +00:00
#### Translators ####
* MarkusRost German translation
* JSBM French translation
2020-09-14 01:53:05 +00:00
* [Eduaddad](https://eduardoaddad.com.br) Brazilian Portuguese translation
* BabylonAS, Philo and Russian Minecraft Wiki community Russian translation
* Mak_and_Iv Ukrainian translation
* Tamara Carvallo Spanish translation
* Lakejason0 - Simplified Chinese translation
Thank you!
2018-06-18 15:26:03 +00:00
2021-05-28 10:57:03 +00:00
[![Translation status](https://translate.wikibot.de/widgets/rcgcdw/-/multi-auto.svg)](https://translate.wikibot.de/engage/rcgcdw/?utm_source=widget)
2020-11-20 16:21:32 +00:00
2021-05-01 13:56:40 +00:00
### Extensions/compatible programs ###
2020-11-25 15:14:45 +00:00
* [Wiki Utilities](https://github.com/Sidemen19/Wiki-Utilities) an integration that allows wiki administrators to revert edits, block editors, and delete pages on the wiki by reacting to messages created by RcGcDw/RcGcDb. Author: [Sidemen19](https://github.com/Sidemen19)
2021-05-01 13:56:40 +00:00
### Alternatives ###
There are various alternatives to RcGcDw you may want to consider if for some reason RcGcDw doesn't satisfy your needs:
* [Wiki-Bot](https://wiki.wikibot.de/wiki/Wiki-Bot_Wiki) - while it's not exactly an alternative since Wiki-Bot is running a modified version of RcGcDw in the backend, you can use its rcscript feature to add a webhook for your wiki and have it work similarly to how RcGcDw does without hosting anything on your own,
* [Extension:Discord](https://www.mediawiki.org/wiki/Extension:Discord) - MediaWiki extension to do the same thing,
* [Extension:DiscordNotifications](https://www.mediawiki.org/wiki/Extension:DiscordNotifications) - another MediaWiki extension with the same goal.
### Wiki ###
2020-11-30 16:41:21 +00:00
For more information, check the [wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Home)!