Skip to content
This repository was archived by the owner on Feb 16, 2024. It is now read-only.

AustinKong/koi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Koi

A boid simulation using the rules of avoidance, cohesion and alignment

About

Image

Description

Project "Koi" is a simple boid simulation using the rules of avoidance, cohesion and alignment based on this resource. It simulates a small koi pond, where fishes swim around in a realistic motion and forms schools. There isn't much interactivity, but it is quite a mesmerizing sight to look at. 🤩

Features:

  • Animated fishes, swimming in schools
  • Fishes avoid obstacles, and swim around them
  • Click on a point to create a disturbance, causing the fishes to scatter!

Technology

  • Unity: Game engine to run the simulation
  • C#: Backend logic

Getting Started

Deployment

Download instructions for users (for Windows only):

  1. Download Release1.0.0.zip
  2. Unzip Release1.0.0.zip
  3. Run 'Project Koi.exe'

Dependencies

  • Unity

Installation

Installation and setup instructions for developers:

  1. Install Unity Hub
  2. Install Unity version 2020.3.30f1 or recommended LTS
  3. Fork and clone the repository
  4. Start coding and build something awesome!

Contributing

This project is no longer under active development. Suggestions, issues and bug reports will not be actively resolved. However, pull requests and forks are always welcome!

Help

Controls

Alt + F4 - Quit
D - Toggle decorative objects (Does not affect simulation)
R - Toggle obstacles (rocks)
Left mouse button - Create a disturbance at cursor, causing fish to scatter

Authors

Austin Kong @AustinKong

Special thanks to BlackThornProd for technique of animating fish

License

This project is licensed under MIT license. View license in license.txt

About

A boid simulation using the rules of avoidance, cohesion and alignment

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages