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

Added requirements file, updated readme and settings example

Browse source
This commit is contained in:
Frisk 2018-06-22 15:05:48 +02:00
parent 427ba332bd
commit aed5573e4a
No known key found for this signature in database
GPG key ID: 0E9A7D3C0A01586C
3 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -11,7 +11,6 @@ Recent changes Gamepedia compatible Discord webhook is a project made from earli
### Features ###
* Fetch recent changes from Gamepedia wiki and send them to Discord channel using a webhook
* Send day overview, that lists how active was the wiki this day
* Customable with many different settings
* Can support multiple languages
### settings.json ###
@ -34,14 +33,15 @@ Explanation for settings:
`appearience` – section with different types of actions and logs, and corresponding to them colors/icons. In here you can set custom icon or color!
### How to use ###
Make sure you have installed all of dependencies and filled settings.json properly.
When you are sure, use `python rcgcdw.py` command to run the script.
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).
When you are sure everything is fine, go to root directory with all of script files and use `python rcgcdw.py` or `python3 rcgcdw.py`command to run the script.
#### Free (?) hosting ####
If you want I can host the script for you for free. Just [contact me](https://minecraft.gamepedia.com/User:Frisk#Contact). If you want to go with this option, be aware that this is far from the best option, I host all of the scripts on my Raspberry PI, it can go down at any moment, I try to keep every script running, but obviously sometimes it's just not possible. So, choosing this option, don't expect 100% uptime.
### Credits ###
* 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
* 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.
* MarkusRost for enormous help with pointing out bugs and space for improvements.
Translators:
* MarkusRost for German translation
@ -51,3 +51,6 @@ Translators:
Script seem to use about 17MB of RAM and negligible amount of CPU when fetching changes.
Script does not log bot actions by default.
"I GoT "Unable to process the event" mESSage!!! WHaT HApND?" - it means there is some kind of action that does not have a template in the script, please [create a ticket](https://gitlab.com/piotrex43/RcGcDw/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) with information on what wiki this error ocurred and when.
### License ###
Everything except the locale directory is under GNU Affero General Public License v3.0 license. The translations are used with allowance of translators, and all rights to them are owned by their respective authors.

4
requirements.txt Normal file
View file

@ -0,0 +1,4 @@
beautifulsoup4 >= 4.6.0; python_version >= '3.6'
requests >= 2.18.4
schedule >= 0.5.0
lxml >= 4.2.1

2
settings.json.example
View file

@ -3,7 +3,7 @@
"wiki": "minecraft",
"lang": "en",
"header": {
"user-agent": "FrisksRcGcDw/0.5"
"user-agent": "FrisksRcGcDw/1.0"
},
"limit": 11,
"webhookURL": "https://discordapp.com/api/webhooks/111111111111111111/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",