-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4062ec9
commit 48a9a1d
Showing
1 changed file
with
49 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,49 @@ | ||
# Goodreads-Bot | ||
|
||
## TODO | ||
- Ajustar las fotos de perfil | ||
|
||
docker-compose.yml: | ||
|
||
``` | ||
version: "2.1" | ||
services: | ||
goodreads-discord-bot: | ||
image: ghcr.io/outerwinnie/goodreads-discord-bot:latest | ||
container_name: goodreads-discord-bot | ||
environment: | ||
- TZ=Europe/Madrid | ||
- CHANNEL_ID= | ||
- GUILD_ID= | ||
- DISCORD_TOKEN= | ||
- LOGLEVEL={20-10} | ||
- PGID=1000 | ||
- PUID=1000 | ||
restart: unless-stopped | ||
``` | ||
# π Goodreads & BookWyrm Discord Bot | ||
|
||
A Discord bot that tracks and shares new reviews from both Goodreads and BookWyrm users directly in your server. Keep your community updated with the latest book reviews! | ||
|
||
## β¨ Features | ||
|
||
- π **Automated Review Updates**: Periodically checks for new reviews from tracked Goodreads and BookWyrm users and shares them in your Discord channel. | ||
- β **Add/Remove Users**: Use slash commands to track or untrack users from Goodreads or BookWyrm. | ||
- π **Interactive Embeds**: Displays reviews in rich embed format with links, ratings, and user info. | ||
|
||
## π³ Docker Setup | ||
|
||
1. **Docker Compose**: | ||
|
||
Create a `docker-compose.yml` file with the following content: | ||
|
||
```yaml | ||
version: "2.1" | ||
services: | ||
goodreads-discord-bot: | ||
image: ghcr.io/outerwinnie/goodreads-discord-bot:latest | ||
container_name: goodreads-discord-bot | ||
environment: | ||
- TZ=Europe/Madrid | ||
- CHANNEL_ID= | ||
- GUILD_ID= | ||
- DISCORD_TOKEN= | ||
- LOGLEVEL={20-10} | ||
- PGID=1000 | ||
- PUID=1000 | ||
restart: unless-stopped | ||
``` | ||
2. **Run the bot**: | ||
```bash | ||
docker-compose up -d | ||
``` | ||
|
||
## π οΈ Usage | ||
|
||
### Commands | ||
|
||
- `/add`: Track a new Goodreads or BookWyrm user. | ||
- `/remove`: Untrack a user. | ||
- `/review_check`: Manually trigger a review check. | ||
- `/sync`: Sync the bot commands (for developers). | ||
|
||
|