Code Monkey home page Code Monkey logo

butter's Introduction

butter

A dumb Matrix bot. May contain traces of nuts.

It can do the following:

  • Respond to !ping requests! \o/
  • Maintain a database of quotes (using !quoteadd/!qa and !quote/!q)

Installation

Install crystal using your favourite package manager as guided by the Crystal docs. After that, building butter should be as easy as:

shards build

The resulting binary is then located in ./bin/butter.

macOS Mojave note: You may run into an error saying the compiler could not find OpenSSL. To fix that, install openssl from Homebrew and point PKG_CONFIG_PATH to OpenSSL's pkgconfig directory:

# zsh, bash:
export PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig

# tcsh:
setenv PKG_CONFIG_PATH /usr/local/opt/openssl/lib/pkgconfig

Usage

Copy the config.example.yml to config.yml and modify it to your needs. Then... initialize the database and just run it! (after you've built it of course, see Installation section above on how to do that)

# Create the initial database
./bin/butter -c config.yml -m up

# Authenticate with your home server for the first time
./bin/butter -c config.yml

# Once you got your access token and exported the MATRIX_ACCESS_TOKEN variable,
# run it again to start the bot:
./bin/butter -c config.yml

Once the bot is running, invite it to a channel and try running some commands, such as !ping.

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/rrerrNet/butter/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

butter's People

Contributors

nilsding avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.