https://github.com/scriptkitties/musashi

The official channel bot for #scriptkitties
https://github.com/scriptkitties/musashi

irc-bot perl6

Last synced: 23 days ago
JSON representation

The official channel bot for #scriptkitties

• Host: GitHub
• URL: https://github.com/scriptkitties/musashi
• Owner: scriptkitties
• License: agpl-3.0
• Created: 2017-09-07T13:00:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-06-09T07:01:51.000Z (about 6 years ago)
• Last Synced: 2025-01-12T20:46:27.193Z (over 1 year ago)
• Topics: irc-bot, perl6
• Language: Raku
• Homepage: https://scriptkitties.church
• Size: 70.3 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Musashi

Musashi is the channel bot for [Scriptkitties](http://scriptkitties.church/), a

community that can be found in `#scriptkitties` on

[Freenode](https://freenode.net/).

## Configuration

Before you can use the bot, you will need to write some configuration. Musashi

checks `$XDG_CONFIG_HOME/musashi.toml`. A basic configuration file to get you

started would be:

    debug = true

    [bot]

    nickname = "musashi"

    username = "musashi"

    [irc]

    host = "chat.freenode.net"

    port = 6697

    ssl  = true

    channels = [

      "#scriptkitties-musashi"

    ]

## Running the bot

There are multiple ways to run the bot. You can download the source and run it

directly from the repository, which is by far the most convenient when

developing. However, for running in production, you may prefer using the Docker

image.

### From the repository

To run Musashi straight from her repository, you will need to clone it, install

dependencies and then run the `musashi` program.

    cd -- "$(mktemp)"  # or just cd to any other directory

    git clone https://gitlab.com/skitties/musashi.git .

    zef install --deps-only .

    perl6 -Ilib bin/musashi

### From Docker

Every commit, a new Docker image is built through GitLab CI. These images can

be found in the related registry, `registry.gitlab.com/skitties/musashi`. Every

commit made to master will update the `latest` tag.

You will need to mount a configuration file into the Docker image to make the

bot work correctly.

    docker run -it \

      -v "$XDG_CONFIG_HOME/musashi.toml:/root/.config/musashi.toml" \

      registry.gitlab.com/skitties/musashi:latest

## License

This project is distributed under the terms of the GNU Affero General Public

License 3.0.