mirror of
https://gitlab.com/chicken-riders/RcGcDw.git
synced 2025-02-22 00:14:10 +00:00
Documentation, gitlab related files
This commit is contained in:
parent
546907fa84
commit
32ddbedb42
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,3 +1,4 @@
|
|||
settings.json
|
||||
pygettext.py
|
||||
lastchange.txt
|
||||
.directory
|
||||
|
|
16
.gitlab/issue_templates/Missing event.md
Normal file
16
.gitlab/issue_templates/Missing event.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
Wiki
|
||||
(where the event occured)
|
||||
|
||||
|
||||
|
||||
When
|
||||
(when the event occured)
|
||||
|
||||
|
||||
|
||||
What type
|
||||
(if you know what type of the event was it, it would be appreciated if you let us know)
|
||||
|
||||
|
||||
|
||||
|
11
README.md
11
README.md
|
@ -20,7 +20,7 @@ Explanation for settings:
|
|||
`lang` – language for the messages, currently available options are: de, en, pl
|
||||
`header` – it's recommended to leave this value as it is, it's a header the script will use to communicate with Gamepedia. Please note that without it, no communication will be possible.
|
||||
`limit` – amount of actions retrieved every `cooldown` amount of seconds. The higher it is the more network data will be used and the data will be processed longer, setting it to higher values is not recommended, but if you want to make sure no edit is omitted (which only happen if there are more actions in last `cooldown` seconds than this value).
|
||||
`webhookURL` – webhook URL you can get using channel settings in Discord
|
||||
`webhookURL` – webhook URL you can get using [channel settings in Discord](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
|
||||
`limitrefetch` – limit of how many changes can be retrieved when refetch happens, cannot be lower than limit. -1 if you want to disable auto-refetch
|
||||
`wikiname` – a name of the wiki the bot will work on, required in some messages
|
||||
`avatars` – this section makes specific types of messages overwrite the default webhook avatar
|
||||
|
@ -30,15 +30,22 @@ Explanation for settings:
|
|||
|
||||
`verbose_level` – a number (min 0, max 50) identifying the type of messages that will be written into the console. (CRITICAL 50, ERROR 40, WARNING 30, INFO 20, DEBUG 10)
|
||||
`show_updown_messages` – bool value, depending on this settings the messages whenever the wiki goes up and down will be sent to the channel
|
||||
`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.
|
||||
|
||||
#### 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
|
||||
|
||||
Translators:
|
||||
* MarkusRost for German translation
|
||||
* 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
|
||||
|
||||
### Other ###
|
||||
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.
|
||||
|
|
Loading…
Reference in a new issue