43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# matrix-sticker-manager
|
|
|
|
[![#stickermanager:t2bot.io](https://img.shields.io/badge/matrix-%23stickermanager:t2bot.io-brightgreen.svg)](https://matrix.to/#/#stickermanager:t2bot.io)
|
|
[![TravisCI badge](https://travis-ci.org/turt2live/matrix-sticker-bot.svg?branch=master)](https://travis-ci.org/turt2live/matrix-sticker-manager)
|
|
|
|
A matrix service to allow users to make their own sticker packs.
|
|
|
|
# Usage
|
|
|
|
1. Invite `@stickers:t2bot.io` to a private chat
|
|
2. Send the message `!stickers help` to get information about how to use the bot
|
|
|
|
# Building your own
|
|
|
|
*Note*: You'll need to have access to an account that the bot can use to get the access token.
|
|
|
|
1. Clone this repository
|
|
2. `npm install`
|
|
3. `npm run build`
|
|
4. Copy `config/default.yaml` to `config/production.yaml`
|
|
5. Run the bot with `NODE_ENV=production node index.js`
|
|
|
|
You will also need to create an appservice registration file and add it to your homeserver:
|
|
```yaml
|
|
id: sticker-manager
|
|
url: http://localhost:8082
|
|
as_token: "YOUR_AS_TOKEN"
|
|
hs_token: "YOUR_HS_TOKEN"
|
|
sender_localpart: "stickers"
|
|
namespaces:
|
|
users: []
|
|
rooms: []
|
|
aliases:
|
|
- exclusive: true
|
|
regex: "#_stickerpack_.+:t2bot.io"
|
|
```
|
|
|
|
# Docker
|
|
|
|
```
|
|
docker build -t turt2live/matrix-sticker-manager .
|
|
docker run -v /app/config/production.yaml:config.yaml -v /app/storage:storage -p 8082:8082 turt2live/matrix-sticker-manager
|
|
``` |