Akamaru/Mikubot
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Yago 2015-01-12 21:17:16 +01:00
parent ff36d07e01
commit 01d92dba1d
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -11,30 +11,25 @@ Multimedia
- When user sends youtube URL, send to origin video image. - When user sends youtube URL, send to origin video image.
![http://i.imgur.com/0FGUvU0.png](http://i.imgur.com/0FGUvU0.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/zW7WWWt.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/kPK7paz.png) ![http://i.imgur.com/0FGUvU0.png](http://i.imgur.com/0FGUvU0.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/zW7WWWt.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/kPK7paz.png)
Command list
Default enabled commands
------------ ------------
``` ```
!9gag -> send random image from 9gag !9gag -> send random image from 9gag
!echo [whatever] -> echoes the msg !echo [whatever] -> echoes the msg
!eur [USD] -> EURUSD market value
!uc3m -> Fortunes from Universidad Carlos III
!get (value_name) -> retrieves variables saved with !set !get (value_name) -> retrieves variables saved with !set
say hello to [name] -> Says hello to someone
!help -> Lists all available commands
!img [topic] -> search image with Google API and sends it
!ping -> bot sends pong
!rae [word] -> Spanish dictionary
!set [value_name] [data] -> Set value !set [value_name] [data] -> Set value
!img [topic] -> search image with Google API and sends it
!loc (location) -> Gets information about a location, maplink and overview
!stats -> Numer of messages by user !stats -> Numer of messages by user
!time [area] -> Displays the local time in an area !time [area] -> Displays the local time in an area
!tw [text] -> Sends a tweet
!version -> Shows bot version !version -> Shows bot version
!weather (city) -> weather in that city (Madrid is default) !google terms -> Searches Google
!help -> Lists all available commands
``` ```
Installation Installation
------------ ------------
```bash ```bash
# Tested on Ubuntu 14.04, for other OSs check out https://github.com/vysheng/tg#installation # Tested on Ubuntu 14.04, for other OSs check out https://github.com/vysheng/tg#installation
$ sudo apt-get install libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev unzip git $ sudo apt-get install libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev unzip git
@ -52,12 +47,28 @@ $ sudo luarocks install luasocket
$ cd $HOME $ cd $HOME
$ git clone https://github.com/yagop/telegram-bot.git --recursive $ git clone https://github.com/yagop/telegram-bot.git --recursive
$ cd telegram-bot/tg $ cd telegram-bot/tg
$ ./configure && make $ ./configure && make && cd ..
$ cd .. $ ./launch.sh # Will ask you for a phone number & confirmation code.
```
Enable more [`plugins`](https://github.com/yagop/telegram-bot/tree/master/plugins)
-------------
See the plugins list with `!plugins` command.
Enable with `!plugins enable [name]`.
Disable with `!plugins disable [plugin]`.
Those commands require a privileged user, privileged users are defined inside `data/config.lua` (generated by the bot), stop de bot and edit if necessary.
Run it as a daemon
------------
If your linux/unix comes with [upstart](http://upstart.ubuntu.com/) you can run the bot by this way
```bash
$ sed -i "s/yourusername/$(whoami)/g" etc/telegram.conf $ sed -i "s/yourusername/$(whoami)/g" etc/telegram.conf
$ sed -i "s_telegrambotpath_$(pwd)_g" etc/telegram.conf $ sed -i "s_telegrambotpath_$(pwd)_g" etc/telegram.conf
$ sudo cp etc/telegram.conf /etc/init/ $ sudo cp etc/telegram.conf /etc/init/
$ ./launch.sh # Will ask you for a phone number & confirmation code.
``` ```
Contact me Contact me