Aktualisiere Readme

This commit is contained in:
Akamaru 2016-08-28 21:44:41 +02:00
parent 7822775813
commit 1b0097aa9f
3 changed files with 12 additions and 17 deletions

1
.gitignore vendored
View File

@ -5,3 +5,4 @@ tmp/*
miku/plugins/licht.lua miku/plugins/licht.lua
Bot-Kommandoliste.txt Bot-Kommandoliste.txt
msg.txt msg.txt
merge.sh

View File

@ -1,13 +1,14 @@
# Mikubot v2 # Mikubot V2
[![Build Status](https://travis-ci.org/Akamaru/Mikubot-V2.svg?branch=master)](https://travis-ci.org/Akamaru/Mikubot-V2)
Der multifunktionale Telegram-Bot. Der multifunktionale Telegram-Bot.
[Offizieller Kanal](https://telegram.me/Mikubot_Updates) [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 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 V2 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 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.
##Anleitung ##Anleitung
@ -42,7 +43,7 @@ Klone danach diese Repo. kopiere die `config.lua.example` nach `config.lua` und
- `bot_api_key`: API-Token vom BotFather - `bot_api_key`: API-Token vom BotFather
- `admin`: Deine Telegram-ID - `admin`: Deine Telegram-ID
Starte danach den Bot mit `./launch.sh`. Um den Bot anzuhalten, führe erst `/halt` über Telegram aus. Starte danach den Bot mit `sh launch.sh`. Um den Bot anzuhalten, führe erst `/halt` über Telegram aus.
Beim Start werden einige Werte in die Redis-Datenbank unter `telegram:credentials` und `telegram:enabled_plugins` eingetragen. Mit `/plugins enable` kannst du Plugins aktivieren, es sind nicht alle von Haus aus aktiviert. Beim Start werden einige Werte in die Redis-Datenbank unter `telegram:credentials` und `telegram:enabled_plugins` eingetragen. Mit `/plugins enable` kannst du Plugins aktivieren, es sind nicht alle von Haus aus aktiviert.
@ -58,21 +59,14 @@ Ein Administrator kann den Bot über folgende Plugins steuern:
| `banhammer.lua` | Siehe /hilfe banhammer| Blockt User vom Bot und kann Whitelist aktivieren | `banhammer.lua` | Siehe /hilfe banhammer| Blockt User vom Bot und kann Whitelist aktivieren
| `control.lua` | /restart | Startet den Bot neu | | `control.lua` | /restart | Startet den Bot neu |
| | /halt | Speichert die Datenbank und stoppt den Bot | | | /halt | Speichert die Datenbank und stoppt den Bot |
| | /script | Führt mehrere Kommandos aus, getrennt mit Zeilenumbrüchen |
| `luarun.lua` | /lua | Führt LUA-Kommandos aus |
| `plugins.lua` | /plugins enable/disable | Aktiviert/deaktiviert Plugins | | `plugins.lua` | /plugins enable/disable | Aktiviert/deaktiviert Plugins |
| `shell.lua` | /sh | Führt Shell-Kommandos aus | | `shell.lua` | /cmd | Führt Shell-Kommandos aus |
* * *
## Gruppenadministration über tg-cli
Dieses Feature wird in Mikubot nicht unterstützt.
* * * * * *
## Liste aller Plugins ## Liste aller Plugins
Mikubot erhält laufend neue Plugins und wird kontinuierlich weiterentwickelt! Siehe [hier](https://github.com/Brawl345/Mikubot-v2/tree/master/miku/plugins) für eine 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.
* * * * * *
#Für Entwickler #Für Entwickler

View File

@ -78,7 +78,7 @@ function bot:on_msg_receive(msg, config) -- The fn run whenever a message is rec
name1 = '' name1 = ''
end end
if msg.from.last_name then if msg.from.last_name then
name2 = msg.from.last_name name2 = ' '..msg.from.last_name
else else
name2 = '' name2 = ''
end end
@ -87,7 +87,7 @@ function bot:on_msg_receive(msg, config) -- The fn run whenever a message is rec
else else
name3 = '' name3 = ''
end end
full_name = '\27[1m\27[31m'..name1..' '..name2..'\27[0m'..name3 full_name = '\27[1m\27[31m'..name1..name2..'\27[0m'..name3
if msg.forward_from then if msg.forward_from then
if msg.forward_from.first_name then if msg.forward_from.first_name then