Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hetic-mt-p2021/rpgo

Simple Discord Bot for a School project written in GO. This bot will allow you to create your own RPG character and fight against enormous monsters to become the strongest one.
https://github.com/hetic-mt-p2021/rpgo

Last synced: about 1 month ago
JSON representation

Simple Discord Bot for a School project written in GO. This bot will allow you to create your own RPG character and fight against enormous monsters to become the strongest one.

Host: GitHub
URL: https://github.com/hetic-mt-p2021/rpgo
Owner: HETIC-MT-P2021
License: mit
Created: 2020-10-16T13:22:01.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2020-12-08T16:27:51.000Z (about 4 years ago)
Last Synced: 2024-11-11T12:28:54.041Z (3 months ago)
Language: Go
Homepage:
Size: 61.5 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        ![License](https://img.shields.io/github/license/HETIC-MT-P2021/RPGo)

![golang](https://img.shields.io/github/languages/top/HETIC-MT-P2021/RPGo)

![golang-version](https://img.shields.io/github/go-mod/go-version/HETIC-MT-P2021/RPGo)

![commit](https://img.shields.io/github/last-commit/HETIC-MT-P2021/RPGo)

![build-CI](https://img.shields.io/github/workflow/status/HETIC-MT-P2021/RPGo/CI)

# RPGo 💣

Simple Discord Bot for a School project written in GO.

This bot will allow you to create your own RPG character and fight against enormous monsters to become the strongest one.

## Project features

* ✅ Create a character

* ⏱ Have specific character classes

* ⏱ Have a random background spawned per character created

## Authors

[Athénais Dussordet](https://github.com/Araknyfe)

[Alexandre Lellouche](https://github.com/AlexandreLch)

Last but not least : [Thomas Raineau](https://github.com/Traineau)

## Usage

```git config core.hooksPath .githooks```

> Configure GitHooks

```cp docker-compose.yaml.dist docker-compose.yaml```

> Docker configuration override, don't forget to add the Token and SQL variables

``` docker-compose up --build```

> Run the project

## Resources

External libraries used : 

* [discordgo](https://github.com/bwmarrin/discordgo) : used to connect to the Discord API

* [gomock](https://github.com/golang/mock/gomock) : used to mock functions in command tests

* [sqlmock](https://github.com/DATA-DOG/go-sqlmock) : used to mock sql functions in repository test

## Pattern implemented

The command pattern is implemented throughout the project as it is well suited for an RPG Discord bot. [Here](https://refactoring.guru/design-patterns/command) is some documentation on how we implemented it.