Skip to content

Controllable Koi fish using LCD Animation Library for Arduino

Notifications You must be signed in to change notification settings

Vladnet47/LCD-Koi-Fish

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

LCD-Koi-Fish

Table of Contents



Description

An example of what can be done with my LCD Animation Library for Arduino.

Using an Arduino Liquid Crystal Display (LCD) and a joystick, the player is able to swim around the screen like a Koi fish.

Some "features":

  • You can variate speed with joystick position
  • You can spawn a worm
  • You can eat the worm
  • If you don't touch the joystick, the fish swims by itself
  • If you spawn a worm when the fish is swimming by itself, it will chase and eat the worm

See it for yourself in the video below!



Prerequisites

In order to run the program, you must have access to the following:



How to Use

Wiring

The wiring portion uses this tutorial for LCD and this tutorial for the joystick controller. Note, the potentiometer is required because it allows you to regulate the brightness of the screen. For exact wiring, see the diagram below.


Uploading the Code

After you have connected the LCD and joystick to your Arduino, you can upload and run the code.

  1. If you haven't already, install the LCD Animation Library.
  2. Download the repository.
git clone https://github.com/Vladnet47/LCD-Koi-Fish.git
  1. Open src/KoiFish/KoiFish.ino using the Arduino IDE.
  2. Select the correct Board and Port under Tools.
  3. Upload the sketch to your board.

Controls

There are two main controls to the game.

  1. Move the joystick to swim with the fish.
  2. Click the joystick to spawn a worm in a random location.



FAQ

Why aren't there more fish?

The Arduino LCD only permits eight custom characters. The fish utilizes six and the worm utilizes two (at most). There simply is not enough onboard memory on the display, which is truly a shame, because it would be a simple addition with the LCD Animation Library.

Helpful Links

Purchase Arduino Microcontroller

Purchase Arduino LCD and Joystick

Wire Arduino LCD

Wire Arduino Joystick

Arduino IDE

LCD Animation Library

About

Controllable Koi fish using LCD Animation Library for Arduino

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages