# botzilla

**Repository Path**: mirrors_servo/botzilla

## Basic Information

- **Project Name**: botzilla
- **Description**: Matrix bot tuned for Mozilla's needs
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Botzilla
===

This is a very work-in-progress bot for Matrix, to use on the Mozilla Matrix
server.

Hack
===

Make sure that nodejs 10 or more is installed on your machine.

- Run `npm install` to make sure all your dependencies are up to date.
- Copy `config.json.example` to `config.json` and fill the access token for
  your bot as documented there.
- (Optional) Make your code beautiful with `npm run pretty`.
- Start the script with `npm start`.

Available modules
===

[See the list](./src/modules). You can refer to a module by its filename in
the modules directory.

How to create a new module
===

- Create a new JS file in `./src/modules`.
- It must export an object of the form:

```js
{
    handler: async function(client, roomId, msg) {
        client.sendText(roomId, "hello world!");
    },
    help: "An help message for this module."
}
```

- The module's name is the file name, add it to your configuration.
- Fun and profit.

Deploy
===

A Dockerfile has been set up to ease local and production deployment of this
bot. You can spawn an instance with the following:

    docker run -ti \
        -v /path/to/local/config.json:/config.json \
        -v /path/to/local/data-dir:/app/data \
        bnjbvr/botzilla

Community
===

If you want to hang out and talk about botzilla, please join our [Matrix
room](https://matrix.to/#/#botzilla:delire.party).

There's also a [Matrix room](https://matrix.to/#/#botzilla-tests:delire.party)
to try the bot features live.