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 docs

Browse source
This commit is contained in:
Frisk 2018-07-18 13:31:06 +02:00
parent 958dde8995
commit 23ba887d68
No known key found for this signature in database
GPG key ID: 0E9A7D3C0A01586C
1 changed files with 9 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,5 +1,6 @@
## Overview ##
Recent changes Gamepedia compatible Discord webhook is a project made from earlier recent changes module of FriskBot. It has been remade as independent script for public usage.
Presentation on how it looks on the Discord can be found [on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation).
### Dependencies ###
* **Python 3.6>**
@ -18,17 +19,7 @@ Recent changes Gamepedia compatible Discord webhook is a project made from earli
[Explanation for settings](https://gitlab.com/piotrex43/RcGcDw/wikis/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).
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.
Here is how you can setup the script in just few commands on a Linux distribution.
```bash
$ git clone https://gitlab.com/piotrex43/RcGcDw.git
$ cd RcGcDw
$ pip3 install -r requirements.txt
$ nano config.json.example
$ mv config.json.example config.json
$ python3 rcgcdw.py
```
[Refer to the guide on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Guide)
#### 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. The only requirement if you want to go with this option, is that the wiki is somewhat active.
@ -41,11 +32,12 @@ Translators:
* MarkusRost for German translation
* JSBM for French translation
### Other ###
### Support ###
The script does have [its own channel](https://discord.gg/pFDZrnE) on MarkusRost's Discord server. All updates will be announced there. If you need help feel free to hop there.
"A message "Unable to process the event" appeared on my channel, what does it mean" - 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.
### Performance ###
Script seem to use about 10-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.
[Here](https://imgur.com/a/ACOMyak) are screenshots of how few embeds look like.
### 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.
@ -57,4 +49,5 @@ There are several Discord server, the script is already running on, you can join
[Minecraft Wiki (DE)](https://discord.gg/F75vfpd) (on a hidden channel)
[Minecraft Wiki Polska](https://discord.gg/9ZCcTnT)
[Minecraft Wiki FR](https://discord.gg/PSK48k7) (temporarily)
Survived By Wiki