Caml_bot is a Twitch.tv chatbot for my channel mxthevsz there! 🤗
- It has its own IRC Client built completely from scratch.
- It parses incoming messages and handle them as commands.
- It can have public and mod-only commands.
-
Parse commands from files: The things that game devs do, create a DSL and make it very easy to integrate new functionalities without having to touch source-code.
-
Parse natural language: Just an idea, but it would be very cool if the bot can respond to "what is X?" and other simple questions instead of replying to
!started commands.
This project uses esy for package management. It can install packages from opam and from npm. Checkout the esy getting started section for instructions on how to install it.
It also depends on PostgreSQL as the DBMS. A PostgreSQL container can be started by docker-compose.
For project related dependencies, see esy.json.
- Clone this repository
- Create the configuration files
.envandsecrets.conf. You can checkout the example files for each of them in the root of the project. Two things to note here: for now only localhost is supported as the database host, and you will a need special token to connect to Twitch IRC. If you don't have aTMI OAuth token, you can generate one at https://twitchapps.com/tmi/. - Run
make installto install the depencies. - Run
make build - If you are going to develop some features, you can start the compiler by running
make dev. - Now you can run
make runand it will use the configurations files to run the project. Make sure you have Docker up and running before running.
See the Makefile for more details. It's very simple.
This piece of software was built in a UNIX machine, and it depends on linkage of the Unix library in compile-time, therefore it was untested in a Windows environment, and you may need WSL2 to run Caml_bot in your Windows machine, but I don't know for sure.
If you have any problem, feel free to file an issue or if you are willing to contribute to the project, open a pull request as well!
Released under MIT License 2021