https://github.com/Half-Shot/matrix-presents-bot

A bot to help prepare presentations in matrix-presents
https://github.com/Half-Shot/matrix-presents-bot

Last synced: about 1 month ago
JSON representation

A bot to help prepare presentations in matrix-presents

• Host: GitHub
• URL: https://github.com/Half-Shot/matrix-presents-bot
• Owner: Half-Shot
• License: apache-2.0
• Created: 2020-02-07T14:13:00.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T14:34:50.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T11:19:19.520Z (about 2 months ago)
• Language: TypeScript
• Size: 185 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - Half-Shot/matrix-presents-bot - A bot to help prepare presentations in matrix-presents (others)

README

        
# `matrix-bot-sdk` Bot Templates

A template for creating bots with [matrix-bot-sdk](https://www.npmjs.com/package/matrix-bot-sdk).

## Projects using this template

- [matrix-zammad](https://github.com/Half-Shot/matrix-zammad) by [Half-Shot](https://github.com/Half-Shot)

Want your project listed? [Edit this doc](https://github.com/turt2live/matrix-bot-sdk-bot-template/edit/master/README.md).

## Running / Building

After clicking the 'use this template' button and cloning the repo, you'll need to install the dependencies

and open an editor to get started. This assumes you have at least **NodeJS 10 or higher**.

1. Replace this README with something useful.

2. Update your project's details in `package.json`.

3. Run `npm install` to get the dependencies.

To build it: `npm run build`.

To run it: `npm run start:dev`

To check the lint: `npm run lint`

*Think this should have a Docker image built-in? Add a 👍 to [this issue](https://github.com/turt2live/matrix-bot-sdk-bot-template/issues/1).*

### Configuration

This template uses a package called `config` to manage configuration. The default configuration is offered

as `config/default.yaml`. Copy/paste this to `config/development.yaml` and `config/production.yaml` and edit

them accordingly for your environment.

## Project structure

This is a somewhat opinionated template that is runnable out of the box. The project is TypeScript with

a linter that matches the bot-sdk itself. All the good bits of the bot are under `src/`.

### `src/index.ts`

This is where the bot's entry point is. Here you can see it reading the config, preparing the storage,

and setting up other stuff that it'll use throughout its lifetime. Nothing in here should really require

modification - most of the bot is elsewhere.

### `src/commands/handler.ts`

When the bot receives a command (see `index.ts` for handoff) it gets processed here. The command structure

is fairly manual, but a basic help menu and processing for a single command is there.

### `src/commands/hello.ts`

This is the bot's `!bot hello` command. It doesn't do much, but it is an example.

### `src/config.ts`

This is simply a typescript interface for your config so you can make use of types.

### `lib/`

This is where the project's build files go. Not really much to see here.

### `storage/`

This is the default storage location. Also not much to see here.

## Help!

Come visit us in [#matrix-bot-sdk:t2bot.io](https://matrix.to/#/#matrix-bot-sdk:t2bot.io) on Matrix if you're

having trouble with this template.

## Credits

Credit to anoa's [matrix-nio template](https://github.com/anoadragon453/nio-template) for the README format.