Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simnalamburt/hyeonbot

:construction_worker: My own IRC bot
https://github.com/simnalamburt/hyeonbot

docker docker-image irc-bot

Last synced: about 1 month ago
JSON representation

:construction_worker: My own IRC bot

Awesome Lists containing this project

README

        

Hyeonbot [![Docker Badge]][Docker Link]
========
Personall IRC bot

```console
# Daum dictionary
<@사용자> dic elope
<@김젼봇> [ilóup] 눈이 맞아 함께 달아나다, 가출하다, 도망가다

<@사용자> d spado
<@김젼봇> [spéidou] 거세한 사람, 생식 불능자

# Fix mistakes
<@사용자> 한글화
<@김젼봇> 한글화 → 한국어 번역 https://t.co/ztyockmyrj 참고

# Highfive
<@사용자> ㅇㅅㅇ)b
<@김젼봇> d(ㅇㅅㅇ

<@사용자> >ㅅㅇ
<@김젼봇> ㅇㅅ<
```


How to run it
--------
```bash
# Using docker
docker run ghcr.io/simnalamburt/hyeonbot

# If you want to use non-default config
#
# Environment Variables:
# HYEONBOT_SERVER Hostname of IRC server (default: "irc.ozinger.org")
# HYEONBOT_PORT Port number (default: "6697")
# HYEONBOT_LOG_LEVEL Log level, one of "debug", "log", "info", "warn", "error", "fatal" (default: "debug")
#
# NOTE: hyeonbot requires TLS connection
docker run \
-e HYEONBOT_SERVER=irc.ozinger.org \
-e HYEONBOT_PORT=6697 \
ghcr.io/simnalamburt/hyeonbot

# If you want persistency
docker run -d --restart=always \
--mount type=bind,source=,target=/a \
ghcr.io/simnalamburt/hyeonbot

# Without docker
gem install hyeonbot && hyeonbot
```

### How to build it
```bash
docker buildx build --push \
--platform linux/amd64,linux/arm64/v8 \
--tag ghcr.io/simnalamburt/hyeonbot:x.y.z .
```

### How to build hyeonbot from source codes
```bash
gem build hyeonbot.gemspec
```


--------
*hyeonbot* is primarily distributed under the terms of both the [MIT license]
and the [Apache License (Version 2.0)]. See [COPYRIGHT] for details.

[Docker Badge]: https://badgen.net/badge/icon/github%20container%20registry?icon=docker&label
[Docker Link]: https://github.com/users/simnalamburt/packages/container/hyeonbot
[MIT license]: LICENSE-MIT
[Apache License (Version 2.0)]: LICENSE-APACHE
[COPYRIGHT]: COPYRIGHT