aquarium bot

Aquarium bot is a discord bot that works in the background of your server that lets you catch and look at fish 🐟 This was created for a class project.

Remix this bot on glitch here

How to Use

Initializing the bot 🤖

This bot is meant to run in the background of an active server.

To start, create 3 different channels. You can technically name them anything you'd like, but from now on I'm going to be calling them the aquarium, the ocean, and the lab. 

In aquarium, initialize the channel with the message "ob! build aquarium here". 

In ocean, initialize the channel with "ob! fish here".

In lab, initialize the channel with "ob! build lab here".

Using the ocean 🌊

The ocean will regularly spawn wild fish to catch. To catch a spawned fish, send a message with the word "catch" in it. When it's caught, you will see the fish's name and description!

You can only catch the latest fish that was spawned. The fish in the ocean will only draw from a pre-set list of fish- it will not include fish made in the lab (even if a lab-made fish was released).

Using the aquarium 🐠
You can use the aquarium to see fish you've caught or made in the lab! To see 1-5 random fish, send a message that includes "look". To see the latest fish caught, send a message with "latest fish".

You can also interact with fish in the aquarium. To feed the fish, send a message with "feed" followed by the fish's ID. Feeding a fish increases it'd bond, which doesn't do anything except it's cute to feed fish :^)

To release a fish send a message with "release" followed by the fish's ID. Releasing a fish will remove it from the aquarium.

Using the lab 🧪

You can use the lab to create a fish. The syntax for creating a fish in a message is:

make fish! image url | Fish Name | Fish Description

If you'd like to use a randomly generated image, name, or description, leave a whitespace in that spot. Images must start with "http" and end with an image extension like .png.

Lab fish will automatically appear in the lab, but will not appear in the ocean.

Current limitations ⚠️

The current bot was only intended to be installed on one server, so it does not take into account that it may be used by multiple servers. The way it is implemented makes it so:

• There can only be one ocean, lab, and aquarium across all servers it's installed in
• It will count messages from all servers when considering when to spawn fish in the ocean
• Fish in the aquarium can be seen by another server if the aquarium channel is ever changed