Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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ô.
https://github.com/dhdsouza/retrobot
discord-bot python retroachievements-api retrogaming sqlite
Last synced: 1 day ago
JSON representation
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ô.
- Host: GitHub
- URL: https://github.com/dhdsouza/retrobot
- Owner: dhDSouza
- License: gpl-3.0
- Created: 2024-09-26T05:01:16.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T04:22:46.000Z (6 days ago)
- Last Synced: 2024-11-12T05:21:26.894Z (6 days ago)
- Topics: discord-bot, python, retroachievements-api, retrogaming, sqlite
- Language: Python
- Homepage:
- Size: 83 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
- Registrar um usuário do RetroAchievements no servidor Discord.
- Buscar as conquistas mais recentes de um usuário do RetroAchievements.
- Sortear um desafio aleatório de jogo retrô.
- Atualizar o desafio caso não tenha gostado do sorteado.
- Exibir perfil do usário no RetroAchievements.
- Exibir a atividade dos jogadores nos jogos retrô.
## Pré-requisitos
Antes de começar, você precisará das seguintes ferramentas instaladas/configuradas:
- [Python 3.10+](https://www.python.org/downloads/)
- [Discord Account & Bot Token](https://discord.com/developers/applications)
- Uma conta no [RetroAchievements](https://retroachievements.org/)
## Instalação
1. Clone este repositório para sua máquina local:
```bash
git clone https://github.com/dhDSouza/RetroBot.git
cd RetroBot
```
2. Instale o `pipenv` se ainda não estiver instalado:
```bash
pip install pipenv
```
3. Crie e ative o ambiente virtual com `pipenv`:
```bash
pipenv install
pipenv shell
```
4. Crie um arquivo `.env` na raiz do projeto e adicione suas variáveis de ambiente:
```bash
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:
```bash
pipenv run start
```
## Comandos Disponíveis
- **`!registrar `**: Registra o seu nome de usuário do RetroAchievements para acompanhar suas conquistas.
- **`!conquistas`**: Exibe as conquistas do usuário registrado nas últimas 24 horas.
- **`!desafio`**: Sorteia um novo desafio de jogo retrô e exibe os detalhes.
- **`!atualizar_desafio`**: Atualiza o desafio atual com um novo, caso o usuário deseje.
- **`!perfil`**: Exibe o perfil do usuário.
- **`!atividade`**: Exibe a última atividade do usuário.
- **`!ajuda`**: Exibe a lista de comandos disponíveis e uma breve descrição de cada um.
## Documentação e Políticas
- [Termos de Uso](./TERMS_OF_USE.md)
- [Política de Privacidade](./PRIVACY_POLICY.md)
## Licença
Este projeto é licenciado sob os termos da [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html). 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](https://retroachievements.org/) 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:
```bash
git checkout -b minha-feature
```
3. Faça as modificações desejadas e commit:
```bash
git commit -m "Adiciona nova funcionalidade"
```
4. Envie para o seu fork:
```bash
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 [[email protected]](mailto:[email protected]).