https://github.com/juancarlospaco/nim-telegram-bot
Nim Telegram Bot.
https://github.com/juancarlospaco/nim-telegram-bot
async bot cat-memes nim nim-lang telegram telegram-bot
Last synced: 2 months ago
JSON representation
Nim Telegram Bot.
- Host: GitHub
- URL: https://github.com/juancarlospaco/nim-telegram-bot
- Owner: juancarlospaco
- License: mit
- Created: 2018-07-16T22:25:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-05T15:02:31.000Z (over 6 years ago)
- Last Synced: 2025-01-26T14:48:40.711Z (4 months ago)
- Topics: async, bot, cat-memes, nim, nim-lang, telegram, telegram-bot
- Language: Nim
- Size: 2.68 MB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# nim-telegram-bot
- Easy `*.ini` & `*.md` Customization. Single Binary, ~150 Kilobytes size. Tiny CPU & Net use. Plugins.
## Install
- `nimble install nim_telegram_bot`
## Compile
To compile from sources, get the Code:
```bash
git clone https://github.com/juancarlospaco/nim-telegram-bot.git
cd nim-telegram-bot/
```
Compile:
```bash
nim e build_nim_telegram_bot.nims
```
**Optional**, Compilation and Run for Development only (Hacks, testing, dev, etc)
```bash
nim c -r -d:ssl nim_telegram_bot.nim
```
## Config
- Rename the file `config.ini.TEMPLATE` to `config.ini`.
- Edit the file `config.ini` to set `api_key`, `polling_interval`, etc.
- Edit the file `coc_text.md` to customize **Code Of Conduct** text (AKA Rules).
- Edit the file `motd_text.md` to customize **Message Of The Day** text.
- Edit the file `help_text.md` to customize **Help** text.
- Edit the file `donate_text.md` to customize **Donations** text.
You can hack any of the `*.ini` and `*.md` to customize.
When ever you have the error of missing `*.md` files, you can just use an empty file.
[Check the Docs on Nimble!.](https://nimble.directory/docs/nimtelegrambot)
Run `nim doc nim_telegram_bot.nim` for more Docs!.
## Plugins
On run the bot creates the following folders:
```
./plugins/
./plugins/bash/
./plugins/python/
./plugins/geo/
./plugins/static/
```
**Bash scripts plugins:**
`./plugins/bash/` are for `*.sh` Bash scripts plugins,
the filename must be all lowercase and not contain whitespaces and end with `*.sh`,
the filename will be the command to trigger the plugin, eg `foo.sh` will be `/foo` on Telegram chat,
output of the script will be sent as string to chat by the bot,
anything you want the bot to say just print it to standard output.
Comments are allowed on the SH file.
File extension is case sensitive, so its `*.sh`, not `*.SH`.
Example Bash plugin:
```bash
# example.sh
echo "This is an example Bash plugin."
```
**Python plugins:**
`./plugins/python/` are for `*.py` Python 3 plugins,
the filename must be all lowercase and not contain whitespaces and end with `*.py`,
the filename will be the command to trigger the plugin, eg `lol.py` will be `/lol` on Telegram chat,
the return of the `main()` function of the script will be sent as string to chat by the bot,
anything you want the bot to say just return it on `main()` as `str` type,
the `main()` function name is a convention, is hardcoded and can not be changed.
No other functions are needed on the INI. Comments are allowed on the Python file.
File extension is case sensitive, so its `*.py`, not `*.PY`.
Example `./plugins/python/foo.py` will be `/foo` on Telegram chat and will call `foo.main()`.
Example Python plugin:
```python
# example.py
def main():
return "Example Python Plugin."
```
**Geo Location Sharing plugins:**
`./plugins/geo/` are for `*.ini` Geo Location Sharing plugins,
the filename must be all lowercase and not contain whitespaces and end with `*.ini`,
the filename will be the command to trigger the plugin, eg `bar.ini` will be `/bar` on Telegram chat,
Geo Location of the INI will be sent as Map Thumbnail and Open Street Map Link to chat by the bot,
anything you want the bot to Geo Locate just add `latitude` and `longitude` to the INI.
No other keys are needed on the INI. Comments are allowed on the INI.
File extension is case sensitive, so its `*.ini`, not `*.INI`.
Example Geo Location Sharing plugin:
```ini
# example.ini
latitude = 55.42
longitude = 42.66
```
**Static Files plugins:**
`./plugins/static/` are for `*.*` Static Files "plugins",
the filename must be all lowercase and not contain whitespaces,
the filename will be the command to trigger the plugin, eg `baz.jpg` will be `/baz` on Telegram chat,
the file will be sent as attached Document file to chat by the bot,
anything you want the bot to share just copy it to that folder.
File extension is case sensitive, so it must be lower case.
Example Static Files plugin: Any file is Ok.
**Nim-based Plugins:**
Maybe in the future we implement it, but right now it has few builtin functionalities
that if you want to create a new functionality using Nim just send the Pull Request,
to be integrated into the Core directly instead of as a Plugin,
all functionalities can be Enabled / Disabled from the `config.ini` anyways.
# CrossCompilation On Demand
The bot will reply any valid `*.nim` plain text source code file with
CrossCompiled stripped native binary executables for Linux and Windows,
including the SHA1 CheckSums on the chat (it compiles, does not run),
theres limits on total file size and total line count,
it can be disabled and configured from the `config.ini`.
No extra hardening security features are in place for this feature,
since Telegram already has Kick and Ban, check `firejails` or `docker` for this,
disable if you expect malware code.
## Run
```bash
./nim_telegram_bot
```
The source code needs the following files on the same current folder to compile:
- `coc_text.md`
- `motd_text.md`
- `help_text.md`
- `donate_text.md`
The binary executable needs the following files on the same current folder to run:
- `config.ini`
Example to compile:
```
/home/user/bot/nim_telegram_bot.nim
/home/user/bot/coc_text.md
/home/user/bot/motd_text.md
/home/user/bot/help_text.md
/home/user/bot/donate_text.md
```
Example to run:
```
/home/user/bot/nim_telegram_bot
/home/user/bot/config.ini
```
**Optional**, you can use any Linux command like `chrt`, `trickle`, `firejails`, `docker`, `rkt` with the Bot too.
## Requisites
*For Compilation only!, if it compiles it does not need Nim nor Telebot.*
- [Nim](https://nim-lang.org/install_unix.html) `>= 0.18.0`
- [Telebot](https://github.com/ba0f3/telebot.nim) [`nimble install telebot`](https://nimble.directory/pkg/telebot)
- [OpenExchangeRates](https://github.com/juancarlospaco/nim-openexchangerates#nim-openexchangerates) [`nimble install openexchangerates`](https://nimble.directory/pkg/openexchangerates)
- [NimPy](https://github.com/yglukhov/nimpy) [`nimble install nimpy`](https://nimble.directory/pkg/nimpy)
**Optional** For Photos on-demand:
- 1 Working USB WebCam Camera on `/dev/video0`.
- FFMPEG (Linux package, with WebP support).
**Optional** For CrossCompilation on-demand:
- `strip` (Linux package).
- `upx` (Linux package).
- `sha1sum` (Linux package).
**Optional** For Python Plugins:
- `python` (3.7+, older Python versions maybe works but its not supported).
**Optional** For Web Screenshots on-demand:
- `CutyCapt` http://cutycapt.sourceforge.net
- `XVFB` for HeadLess Servers without X only, if you have X running is not required.
**Optional** For Python Compilation:
- `nuitka` (Linux package).
### Single File
**Optional**, this is for advanced users only.
If you want to compile to 1 file, without any extra `*.md` files.
On the source code find and remove the lines:
```nim
helps_texts = readFile("help_text.md")
coc_text = readFile("coc_text.md")
motd_text = readFile("motd_text.md")
donate_text = readFile("donate_text.md")
```
On the source code find and uncomment the lines:
```nim
helps_texts = staticRead("help_text.md")
coc_text = staticRead("coc_text.md")
motd_text = staticRead("motd_text.md")
donate_text = staticRead("donate_text.md")
```
Recompile, it will Embed all the `*.md` files on the binary executable.
You will need to Recompile to change any content of the `*.md` files.
You can later delete all the `*.md` files.
### Performance Profiling
**Optional**, this is for advanced developers only.
Find and uncomment the line `import nimprof` on `nim_telegram_bot.nim`.
```bash
nim c --profiler:on --stacktrace:on -d:ssl -d:release --app:console --opt:size nim_telegram_bot.nim
./nim_telegram_bot
```
Then open the file `profile_results.txt`.
## Check code
**Optional**, this is for advanced developers only.
How to Lint the code.
```bash
nimble check
nim check src/nim_telegram_bot.nim
```
### CrossCompile
**Optional**, this is for advanced developers only.
Linux -> Windows, this allows to generate a `*.EXE` for Windows on Linux.
On Linux install all this packages:
```
mingw-w64-binutils mingw-w64-crt mingw-w64-gcc mingw-w64-headers mingw-w64-winpthreads mingw-w64-gcc-base mingw-w64-*
```
Usually only installing `mingw-w64-gcc` gets all the rest as dependency.
Names are from ArchLinux AUR, should be similar on other Distros
### Contributions
- This is cross-collaboration work of [Rlyeh HackLab](https://rlab.be) and [NimAr](https://t.me/NimArgentina) communities.