Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marahin/letter-bot

Letter is a Discord bot for reserving respawns in Tibia.
https://github.com/marahin/letter-bot

booking bot discord respawn tibia

Last synced: 22 days ago
JSON representation

Letter is a Discord bot for reserving respawns in Tibia.

Host: GitHub
URL: https://github.com/marahin/letter-bot
Owner: Marahin
License: mit
Created: 2023-10-06T16:50:33.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-07-01T11:56:17.000Z (7 months ago)
Last Synced: 2024-12-30T10:42:41.393Z (26 days ago)
Topics: booking, bot, discord, respawn, tibia
Language: Go
Homepage: https://tibialoot.com
Size: 8.12 MB
Stars: 9
Watchers: 2
Forks: 7
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Letter, Tibia's booking bot

[![Go Report Card](https://goreportcard.com/badge/github.com/marahin/letter-bot)](https://goreportcard.com/report/github.com/marahin/letter-bot)

![License](https://img.shields.io/github/license/marahin/letter-bot)

[![golangci-lint](https://github.com/Marahin/letter-bot/actions/workflows/golangci-lint.yml/badge.svg?branch=main)](https://github.com/Marahin/letter-bot/actions/workflows/golangci-lint.yml)

[![ci](https://github.com/Marahin/letter-bot/actions/workflows/test.yml/badge.svg)](https://github.com/Marahin/letter-bot/actions/workflows/test.yml)

[![CodeQL](https://github.com/Marahin/letter-bot/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Marahin/letter-bot/actions/workflows/github-code-scanning/codeql)

---

Letter is a Discord bot for reserving respawns in [Tibia](https://tibia.com). It registers slash commands allowing users to manage their respawn bookings.  

Currently used by servers with over 3k members. 

---

[![buymeacoffee](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=marahin&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff)](https://www.buymeacoffee.com/marahin)  

If you like the bot and want to support its development, you can buy me a coffee!

---

## Overview

* [**LICENSE**](LICENSE)

* [Invite link, self-hosting](#Invite-link-self-hosting)

* [Trivia](#Trivia)

* [**Screenshots**](#Screenshots)

  * [Booking](#Booking)

  * [Unbooking](#Unbooking)

  * [Feedback](#Feedback)

  * [Pie chart showing distribution of reservations](#Pie-chart-showing-distribution-of-reservations)

  * [List of upcoming reservations](#List-of-upcoming-reservations)

* [**Development**](#Development)

--- 

## Invite link, self-hosting

**Hosted version is available on demand**. Reach out on [Tibialoot Discord Server](https://discord.com/invite/F4YKgsnzmc). 

Self-hosting is possible but it's your job to figure out how you want it done. If you require support, hit us up [Tibialoot Discord Server](https://discord.com/invite/F4YKgsnzmc).

## Trivia

Letter bot originated within [Refugees](https://www.tibia.com/community/?subtopic=guilds&page=view&GuildName=Refugees), the dominating guild on one of the oldest Tibia servers, Celesta.

## Screenshots

### Booking

![booking command](docs/booking.png)

### Unbooking

![unbooking command](docs/unbooking.png)

### Feedback

![reservation outcomes](docs/reservations_outcomes.png)

### Pie chart showing distribution of reservations

![summary pie chart](docs/summary_pie_chart.png)

## List of upcoming reservations

![summary list](docs/sample_summary_list.png)

## Development

### Prerequisites

* `docker` and `docker-compose` (unless you want to go bare-metal),

* `make` (unless you want to run commands manually),

* `go` (if you want to develop),

### docker-compose

#### Initial setup

1. Copy `.env.example` to `.env` and fill in the values (or leave as-is).

3. Run `docker-compose up -d` to start the stack.

4. Run `docker-compose exec bot sh -c "bin/migrate"` to apply migrations.

4. Run `docker-compose exec db bash -c "seed"` to fill any entry-level data.

5. Run `docker-compose restart bot` (as it failed originally, when the database was not set up).

#### After initial setup

1. To start: `docker-compose up -d`

2. Development should hot reload (recompile and restart the bot) on file changes.

2. To stop:`docker-compose stop` or `... down`

#### Shutdown / teardown

1. To shut the service down, `docker-compose stop`

2. (optional) To remove containers and networks, `docker-compose down`

2. (optional) To remove the volumes, such as database, `docker volume rm letter_bot_postgres`

### Database and migrations

If you change SQL schema in any way, remember to:

* regenerate sqlc: `make sqlc-generate` - this generates Go wrapper around our queries,

* run `docker-compose exec bot sh -c "bin/generate_migration "` - so if you change a timestamp, you could name it `"users_timestamps"`.

### Contributing

We will be very happy for each contribution. 

1. Fork the repository

2. Create a branch with your changes

3. Push the branch to your fork

4. Create a pull request

5. Wait for the review

## Credits

Letter-bot is one of many tools prototyped by (and for) [TibiaLoot.com](https://tibialoot.com)  

Author: [marahin](https://github.com/marahin)

Contributors: 

* [patryk-fuhrman](https://github.com/patryk-fuhrman)

* [pawcioma](https://github.com/pawcioma/)