dhDSouza / RetroBot

RetroBot é um bot para Discord que permite que os membros de um servidor de Discord registrem seus nomes de usuário da plataforma RetroAchievements, acompanhem suas conquistas de jogos retrô.
GNU General Public License v3.0
2 stars 1 forks source link
discord-bot python retroachievements-api retrogaming sqlite

RetroBot - Bot de Conquistas RetroAchievements para Discord

RetroBot é um bot para Discord que permite que os membros de um servidor registrem seus nomes de usuário da plataforma RetroAchievements e acompanhem suas conquistas de jogos retrô.

Funcionalidades

Pré-requisitos

Antes de começar, você precisará das seguintes ferramentas instaladas/configuradas:

Instalação

  1. Clone este repositório para sua máquina local:

    git clone https://github.com/dhDSouza/RetroBot.git
    cd RetroBot
  2. Instale o pipenv se ainda não estiver instalado:

    pip install pipenv
  3. Crie e ative o ambiente virtual com pipenv:

    pipenv install
    pipenv shell
  4. Crie um arquivo .env na raiz do projeto e adicione suas variáveis de ambiente:

    DISCORD_TOKEN=seu_token_do_discord
    RA_API_KEY=sua_chave_da_api_do_retroachievements
    CHANNEL=seu_canal_do_discord

Como Usar

Iniciar o bot:

Para iniciar o bot, rode o seguinte comando:

pipenv run start

Comandos Disponíveis

Documentação e Políticas

Licença

Este projeto é licenciado sob os termos da GNU General Public License v3.0. Você é livre para usar, modificar e distribuir o software, desde que mantenha os créditos e a licença original.

Referência ao RetroAchievements

O RetroBot utiliza a API do RetroAchievements para obter dados sobre conquistas e atividades de jogos retrô. Agradecemos ao RetroAchievements por disponibilizar a API e permitir que a comunidade desenvolva ferramentas como esta.

Como Contribuir

Contribuições são sempre bem-vindas! Siga os passos abaixo para contribuir:

  1. Faça um fork deste repositório.

  2. Crie uma nova branch para sua feature ou correção:

    git checkout -b minha-feature
  3. Faça as modificações desejadas e commit:

    git commit -m "Adiciona nova funcionalidade"
  4. Envie para o seu fork:

    git push origin minha-feature
  5. Abra um Pull Request descrevendo as mudanças feitas.

Contato

Se você tiver dúvidas, sugestões ou problemas, fique à vontade para abrir um issue ou entrar em contato diretamente através do dhs.danielsouza@gmail.com.