2018-09-17 05:42:14 +00:00
|
|
|
# itte
|
|
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
Mini IRC bot module in Lua.
|
2018-09-17 05:42:14 +00:00
|
|
|
|
|
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
Currently supported:
|
|
|
|
|
|
|
|
|
|
- Authentication via SASL (plain) or Nickserv
|
|
|
|
|
- Joining multiple servers
|
|
|
|
|
- Config reload
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
- [Lua 5.x](https://www.lua.org/)
|
|
|
|
|
- [luasocket](https://w3.impa.br/~diego/software/luasocket/)
|
|
|
|
|
- [luasec](https://github.com/brunoos/luasec)
|
2018-09-17 05:42:14 +00:00
|
|
|
|
2019-01-15 17:26:21 +00:00
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
See the bot files in the `examples/` directory for usage notes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Example: ramenkan
|
|
|
|
|
|
|
|
|
|
- Install Lua and other dependencies, e.g. for Alpine:
|
|
|
|
|
`apk add lua-socket lua-sec`
|
2018-09-17 05:42:14 +00:00
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
- Copy the `itte*.lua` files to the `examples/` directory. Copy the
|
|
|
|
|
`examples/sample.servers.lua` as `ramenkan.servers.lua` and change the server
|
|
|
|
|
settings as applicable.
|
2018-09-17 05:42:14 +00:00
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
- Run: `nohup lua /path/to/examples/ramenkan.lua >/dev/null 2>&1 &`
|
2018-09-17 05:42:14 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2022-03-14 06:57:49 +00:00
|
|
|
BSD-3.0
|
