https://github.com/rockerboo/blur
Twitch Chat Bot in Elixir
https://github.com/rockerboo/blur
chat-bot elixir
Last synced: 10 months ago
JSON representation
Twitch Chat Bot in Elixir
- Host: GitHub
- URL: https://github.com/rockerboo/blur
- Owner: rockerBOO
- License: mit
- Created: 2015-07-20T04:44:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-26T17:27:28.000Z (almost 5 years ago)
- Last Synced: 2025-02-28T10:50:21.185Z (11 months ago)
- Topics: chat-bot, elixir
- Language: Elixir
- Homepage: https://hex.pm/packages/blur
- Size: 117 KB
- Stars: 18
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Blur
====
Twitch Chat Bot
[](https://coveralls.io/github/rockerBOO/blur)
**Note** This is under heavy changes. Things might break with each release as we solidify the API.
**Note** See 0.3.0-beta branch for the most up to date code. Currently missing some functionality to get it working.
This library will be a core component that will interact with IRC and have a bunch of helper commands to interact with IRC, WS and OBS connections.
## Install
First, add Blur to your mix.exs dependencies:
```elixir
def deps do
[{:blur, "~> 0.2.1-rc1"}]
end
```
Then, update your dependencies:
```sh-session
$ mix deps.get
```
You will need to authenticate with OAuth. This is set with the `TWITCH_CHAT_KEY` environmental variable. See [.env.example](.env.example) for all the variables.
```elixir
# The key generated from https://twitchapps.com/tmi/.
export TWITCH_CHAT_KEY=oauth:
```
Then, you'll want to start the Blur application.
```elixir
# [user, channels]
Blur.App.start_link(["800807", ["#rockerboo"]])
```
## Quick Start
```sh-session
iex -S mix
iex> Blur.App.start_link(["800807", ["#rockerboo"]])
{:ok, }
iex> Blur.say "#rockerboo", "yo"
:ok
```
## Usage
```elixir
Blur.say("#rockerboo", "yo")
```
See the [Blur](lib/blur.ex) module for the current list of options.