sirtimme / alpagotchi

Take care of your own digital alpaca. 🦙

Alpagotchi

Alpagotchi allows any user to create and take care of their own digital alpaca.

Table of Contents

1. Commands overview
2. Self-hosting
3. Useful links

Commands overview

Usage	Task
buy [itemName] [1-10]	Buys the amount of items from the shop
feed [itemName] [1-5]	Feeds the alpaca with the item
gift [@user] [itemName] [1-5]	Gifts the amount of items to the mentioned user
help	Displays all commands of Alpagotchi
inventory	Shows the bought items from the shop
alpaca	Shows your alpaca and his stats
nick [nickname]	Gives your alpaca a nickname
pet	Increases joy of your alpaca
shop	Displays all items which can be bought
balance	Shows your balance of fluffies
work	Work to earn a random amount of fluffies
sleep [minutes]	Let your alpaca sleep and regenerates energy
outfit [outfit]	Change the appearance of your alpaca
delete	Deletes all of your stored data
init	Initialize your alpaca in the database
language	Sets the bots' language within a guild

Self-hosting

Alpagotchi provides a docker image to host it yourself. The docker image can be found on dockerhub.

Important

This directory structure is needed for Alpagotchi to run:

/
├── docker-compose.yml
└── .env

The .env file needs the following entries:

TOKEN=                      # the bot token
OWNER_ID=                   # your discord user id

# if you leave the version variables empty, Alpagotchi uses default values
POSTGRES_VERSION=
ADMINER_VERSION=
ALPAGOTCHI_VERSION=

POSTGRES_USER=              # the database username of your choice
POSTGRES_PASSWORD=          # the database password of your choice
POSTGRES_URL=               # the jdbc url of the postgres database
POSTGRES_DB=                # the database name of your choice

The docker-compose.yml configures the following services:

• postgres database for data storage
• the discord bot
• adminer for accessing the database via GUI

version: '3.8'

name: alpagotchi
services:
  database:
    image: postgres:${POSTGRES_VERSION:-15.4}
    restart: on-failure
    environment:
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
      POSTGRES_DB: ${POSTGRES_DB}
    volumes:
      - pg-data:/var/lib/postgresql/data
    ports:
      - "5432:5432"
        
  bot:
    container_name: bot
    image: alpagotchi/discord-bot:${ALPAGOTCHI_VERSION:-0.0.1}
    depends_on:
      - database
    restart: on-failure
    environment:
      TOKEN: ${TOKEN}
      OWNER_ID: ${OWNER_ID}
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
      POSTGRES_URL: ${POSTGRES_URL}

  adminer:
    image: adminer:${ADMINER_VERSION:-4.8.1}
    depends_on:
      - database
    restart: on-failure
    environment:
      ADMINER_DESIGN: pepa-linha-dark
    ports:
      - "8080:8080"

volumes:
  pg-data:

Useful links

• Official Alpagotchi website
• Discord invite link of the Alpagotchi bot
• Discord invite link of the support server
• Top.gg page of Alpagotchi

alpagotchi's Issues

Missing env var `OWNER_ID` in README

The image of Alpagotchi needs an env var OWNER_ID which isnt referenced in the docker-compose example

Improve README

Image version of Alpagotchi does not match README

The most recent version of the Alpagotchi image on dockerhub is 0.0.1. The fallback value in the README should reflect that

Providing instructions to build the bot from source

There should be instructions or a script to let the user build the bot from source himself.

These instructions should contain:

• the required tools and dependencies to build and run the application (and the corresponding versions)
• the command procedure you have to execute
• maybe a guide how to configure the bot

Besides this, the Releases-Tab should be used to provide a prebuild jar file

Refactor directory structure

Add admin commands for modifying DB data

Refactor image versions into fallback notations

Change the used image versions as a fallback to remove the need that the consumer needs to specify them if they dont want to

Update dependencies

Refactor general `Utils` class into specialized classes

Update java version to 21

Upgrade java version from 17 to 21

Add better documentation to README and Dockerhub

Create stored procedure to decrease hunger / thirst

Remove automatic tag creation

The automatic tag creation is going to be replaced by a manual workflow.

Refactor `utils` package into logical classes

Refactor keys in resourcebundle to consistent naming

Add image versions as env var to docker compose file