Mikubot V2 > Mikubot 2
This commit is contained in:
GitHub
parent
3a8b7b8f48
commit
1dd54bea84
22
README.md
22
README.md
|
|
@ -1,16 +1,16 @@
|
|||
# Mikubot V2
|
||||
[](https://travis-ci.org/Akamaru/Mikubot-V2)
|
||||
# Mikubot 2
|
||||
[](https://travis-ci.org/Akamaru/Mikubot-2)
|
||||
|
||||
Der multifunktionale Telegram-Bot.
|
||||
|
||||
[Offizielle Webseite](https://ponywave.de/projekte/mikubot-v2/) | [Entwickler auf Telegram](http://telegram.me/Akamaru) **KEIN SUPPORT!** | [Offizieller Telegram-Kanal](https://telegram.me/Mikubot_Updates)
|
||||
|
||||
Mikubot ist ein auf Plugins basierender Bot, der die [offizielle Telegram Bot API](http://core.telegram.org/bots/api) benutzt. Geforkt wurde er von [Brawlbot](https://github.com/Brawl345/Brawlbot-v2) Ursprünglich wurde er 2015 auf Basis von Yagops [Telegram Bot](https://github.com/yagop/telegram-bot/) entwickelt, da aber die Entwicklung von tg-cli [zum Stillstand](https://brawlbot.tk/posts/ein-neuanfang) gekommen ist, wurden alle Plugins des bisher proprietären Brawlbots im Juni 2016 auf die Bot-API portiert und open-sourced. Im Juli und August 2016 wurden die zusätzlichen Plugins von Mikubot ebenfalls auf die Bot-API migriert.
|
||||
**Mikubot V2 basiert auf [otouto](https://github.com/topkecleon/otouto) von topkecleon.**
|
||||
Mikubot 2 ist ein auf Plugins basierender Bot, der die [offizielle Telegram Bot API](http://core.telegram.org/bots/api) benutzt. Geforkt wurde er von [Brawlbot](https://github.com/Brawl345/Brawlbot-v2) Ursprünglich wurde er 2015 auf Basis von Yagops [Telegram Bot](https://github.com/yagop/telegram-bot/) entwickelt, da aber die Entwicklung von tg-cli [zum Stillstand](https://brawlbot.tk/posts/ein-neuanfang) gekommen ist, wurden alle Plugins des bisher proprietären Brawlbots im Juni 2016 auf die Bot-API portiert und open-sourced. Im Juli und August 2016 wurden die zusätzlichen Plugins von Mikubot ebenfalls auf die Bot-API migriert.
|
||||
**Mikubot 2 basiert auf [otouto](https://github.com/topkecleon/otouto) von topkecleon.**
|
||||
|
||||
Mikubot V2 ist freie Software; du darfst ihn modifizieren und weiterverbreiten, allerdings musst du dich an die GNU Affero General Public License v3 halten, siehe **LICENSE** für Details.
|
||||
Mikubot 2 ist freie Software; du darfst ihn modifizieren und weiterverbreiten, allerdings musst du dich an die GNU Affero General Public License v3 halten, siehe **LICENSE** für Details.
|
||||
|
||||
##Anleitung
|
||||
## Anleitung
|
||||
|
||||
| Für User | Für Entwickler|
|
||||
|:----------------------------------------------|:------------------------------|
|
||||
|
|
@ -24,7 +24,7 @@ Mikubot V2 ist freie Software; du darfst ihn modifizieren und weiterverbreiten,
|
|||
### Ubuntu und Debian
|
||||
Falls du Ubuntu oder Debian verwendest, kannst du einfach `./install-dependencies.sh` ausführen, damit alles installiert wird. Ergänze dann noch den `bot_api_key` und die `admin`-ID (Bekommst du in Telegram mit `@Mikubot id`) und kopiere die config.lua.example nach config.lua.
|
||||
|
||||
####Optionale Pakete
|
||||
#### Optionale Pakete
|
||||
Diese Pakete werden für `flip-text.lua`, `shell.lua`, `speedtest_cli.lua` und `youtube_dl.lua` benötigt.
|
||||
* `sudo apt-get install -y cowsay scrot fswebcam vnstat vnstati youtube-dl npm`
|
||||
* `sudo npm install -g flip-text`
|
||||
|
|
@ -77,12 +77,12 @@ Ein Administrator kann den Bot über folgende Plugins steuern:
|
|||
|
||||
## Liste aller Plugins
|
||||
|
||||
Mikubot erhält laufend neue Plugins und wird kontinuierlich weiterentwickelt! Siehe [hier](https://github.com/Akamaru/Mikubot-V2/tree/master/miku/plugins) für eine Liste aller Plugins.
|
||||
Mikubot 2 erhält laufend neue Plugins und wird kontinuierlich weiterentwickelt! Siehe [hier](https://github.com/Akamaru/Mikubot-2/tree/master/miku/plugins) für eine Liste aller Plugins.
|
||||
|
||||
* * *
|
||||
#Für Entwickler
|
||||
# Für Entwickler
|
||||
## Plugins
|
||||
Mikubot benutzt ein Plugin-System, ähnlich Yagops [Telegram-Bot](http://github.com/yagop/telegram-bot).
|
||||
Mikubot 2 benutzt ein Plugin-System, ähnlich Yagops [Telegram-Bot](http://github.com/yagop/telegram-bot).
|
||||
|
||||
Ein Plugin kann zehn Komponenten haben, aber nur zwei werden benötigt:
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ Falls erfolgreich, wird bindings das deserialisierte Ergebniss der API zurückge
|
|||
* * *
|
||||
|
||||
## Datenbank
|
||||
Mikubot benutzt eine interne Datenbank, wie Otouto sie benutzt und Redis. Die "Datenbank" ist eine Tabelle, auf die über die Variable `database` zugegriffen werden kann (normalerweise `self.database`) und die als JSON-encodierte Plaintext-Datei jede Stunde gespeichert wird oder wenn der Bot gestoppt wird (über `/halt`).
|
||||
Mikubot 2 benutzt eine interne Datenbank, wie Otouto sie benutzt und Redis. Die "Datenbank" ist eine Tabelle, auf die über die Variable `database` zugegriffen werden kann (normalerweise `self.database`) und die als JSON-encodierte Plaintext-Datei jede Stunde gespeichert wird oder wenn der Bot gestoppt wird (über `/halt`).
|
||||
|
||||
Das ist die Datenbank-Struktur:
|
||||
|
||||
|
|
|
|||
Reference in New Issue