https://github.com/Satont/yakui

Yet another Twitch bot written on typescript, focused on perfomance.
https://github.com/Satont/yakui

bot nodejs overlays postgresql timers twitch typescript vuejs

Last synced: 8 days ago
JSON representation

Yet another Twitch bot written on typescript, focused on perfomance.

• Host: GitHub
• URL: https://github.com/Satont/yakui
• Owner: Satont
• Archived: true
• Created: 2019-07-29T09:08:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-19T11:11:04.000Z (about 2 years ago)
• Last Synced: 2024-03-07T01:32:16.224Z (4 months ago)
• Topics: bot, nodejs, overlays, postgresql, timers, twitch, typescript, vuejs
• Language: TypeScript
• Homepage:
• Size: 10.9 MB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Lists

• awesome-twitch-dev - Satont/yakui - Yet another Twitch bot written on typescript. (Libraries / JavaScript (Node.js))

README

        
# Deprecated

I wrote a public bot with similar functionality. If you want to try it, it's available at https://tsuwari.tk

# Yakui twitch bot

![](https://img.shields.io/github/workflow/status/satont/yakui/Publish%20Docker/master?label=docker&style=for-the-badge) ![](https://img.shields.io/github/workflow/status/Satont/yakui/Build%20Web%20and%20Bot/master?style=for-the-badge) ![](https://img.shields.io/david/satont/yakui?style=for-the-badge) ![](https://discord.gg/a5XFNKq)

## Features

- Custom commands:

  - you can create a command with JavaScript evaluation;

  - already built-in variables;

  - also supports custom variables.

- Timers: send message in chat periodically.

- Variables: create some variable, which can be used in timers or custom commands.

- Moderation system.

- Users stats counting:

  - messages;

  - time on stream;

  - bits;

  - tips;

  - time of follow.

- Integrations:

  - Streamlabs;

  - DonationAlerts;

  - Qiwi Donate;

  - Spotify.

- Keywords system.

- Points system:

  - count user points per watching or chatting.

- Overlays system:

  - you can create some overlay and use it in your OBS!

- Events system:

  - trigger tip, bit, host and do something!

## Installation

### Prerequirements

 - Postgres

 - Node >= 12

Installation process:

```shell

git clone https://github.com/Satont/yakui

cd yakui

npm install

npm run build

cp .env.example .env

```

Dockerized:

```yml

version: "3.2"

services:

  yakui:

    image: satont/yakui

    restart: always

    volumes:

      - ./logs:/app/logs/

    env_file:

      - .env

    ports:

      - 3000:3000

```

As option there is mirror registry based on gitlab: `registry.gitlab.com/satont/yakui:latest`

## Help

- [Discord server](https://discord.gg/a5XFNKq)

## Credits

Special thanks goes to sogehige, our bot logger was copied from his project.