jobtalle/koi

Koi Farm, a koi breeding game

Koi Farm

A Koi breeding game. Get it on steam or on itch.io.

Building

HTML, CSS and Javascript content is compressed using squish.py, which is included in this repository as a submodule. Before building, ensure that this library has been cloned as well.

Make sure node.js and python 3 are installed. After calling npm i to install all required packages, the following commands can be used to create binaries using electron:

Operating system	Command
Windows (32 bit)	npm run build-win-32
Windows (64 bit)	npm run build-win-64
Linux (64 bit)	npm run build-linux-64
Mac (64 bit)	npm run build-mac-64

Additionally, npm run compress can be called to compress HTML, CSS and Javscript content without building binaries. The compressed HTML file release.html will be created in the project root. The file requires the audio, font, svg and language directories to run, as well as favicon.ico and manifest.json.

Translations

The game is available in several languages. Translations can be found in this repository, and new translations can be proposed there; when new translations are made, I will add them to the game.

Contributing

Contributions can be proposed by submitting pull requests. The best place to ask questions is in the official discord, which has a dedicated channel for source code related discussions.

License

Koi Farm is distributed under the Apache 2.0 with Commons Clause license.

Audio by 3xBlast.

Concept art by Samma van Klaarbergen.

Logo by Eveline Dubblinga.

koi's Issues

Fish card view

Card shows a high res version of the fish, and enumerates its stats:

• Age
• Colors
• Size (or weight)

Card book page turning

Focal point for ridge pattern

Similar to #3

Fish card image

Card image could be static (rendered as a texture by the main renderer, then converted to canvas), or dynamic, which requires a WebGL context & renderer per card.

Let grass color vary depending on noise

Cards can disappear when they are being dragged during a page refresh

Ideally, they should be placed back into the card hand.

When koi dragging release event is not called, the held koi can be destroyed

When selecting a new koi without handling the previous drop event, memory may be lost.

Support for multiple ponds

Multiple ponds can be played at. When switching to another pond, other ponds are paused.

Pond selection could be done using GUI similar to a phone home view, swiping left or right moves through the ponds.

Refreshing sometimes gives unexpected weather

Sometimes rain fades away directly after refreshing / deserializing. This may indicate that the previous weather state is not serialized correctly.

Move fish growth speed, mating frequency, offspring count and age to fish body

The Fish object will then merely represent a body in the world, the body will represent all individual properties.

Only show drop target when close to it

It's quite annoying to have it in view when dragging fish between ponds

Replace palette track system by hardcoded progression system

Palette positions should not mutate. Instead, certain combinations of colors should have a certain chance to mutate into a new color.

Palette tracks will still exist (for design purposes), but palette samples will not be 2D. Instead, they will be indices.

Stereo panning model

A shared panning model which calculates pan based on screen position. This model should not use the entire possible range, and have a dead zone in the center.

Card book

A book for collecting and storing cards.

Grass audio should fade out

Currently, it stops abruptly. The intensity should slowly decay to zero instead.

Sun rays during sunny weather

Diagonal sun rays would be cool to make sunny weather stand out more.

Card targets are sometimes out of view

Caused by getting the HTML rectangle of the book when it is out of view

Make a better visual representation of turning cards into fish

Currently the card overlaps the thing you'd want to see.

Don't show card book when a fish is turned into a card

Currency

Koi can be sold. Possibly through their card view.

Pricing for koi should depend on a base price and the number of units sold. For example, the price for a certain fish can be 10 / (f * sold + 1), which means the first fish of that type gives 10 coins, and all subsequent ones less than that. In this formula, f determines how fast the price decreases.

Additionally, sold can diminish over time to prevent the market becoming saturated forever.

New pattern mixing rules

If both fish have equal layer types and an equal palette track, interpolate properties according to sigmoid samplers.

If fish are different, pick either pattern.

Always mutate in the end.

These rules assure that any new color mutation will be explicitly designed.

Cull rock backfaces

Shiny koi

Palette samples can have the shiny property. This adds glistering effects and possibly particles to a color. Koi can have different degrees of shininess; it may apply to one or more layers.

Audio engine

Should support panning to localize sounds produced at fish locations.

OGG is the preferred format, AAC can be a fallback for edge & safari.

No audio on android

Audio does not play on android at this point

Prevent cards from turning into fish when they are dropped close to the hand area

Fish weight

Fish weight calculations are required for sound production & fish rating

Link manifest.json

Web app manifest can suggest the browser to display the app in landscape mode, which is desirable. Also see this.

Dropping fish on drop target uses wrong hitbox

The fish sometimes turn into cards when dropped outside the target

Granular grass effect does not play when moving the cursor quickly

Detecting whether the effect should play should work similarly to wind displacement: check the path the cursor has moved with a certain interval.

Make layer disappearance chance dependent on visibility

Factor in threshold, focus size

Grass moves based on previous last position when starting a new move

Hand of cards

Cards should snap back into card hand when not being moved

Touch events are not sufficient to allow audio to play

This means that on touch event, the audio engine is created, but it fails to play audio.

Fixing this may fix #39

Better hitboxes

Hitboxes are not accurate and hard to catch, they need two phases:

• Fine phase, using exact hitboxes, and
• Offset phase, which also triggers outside koi.

This enables fish to be picked up easier with touch controls, while preventing offset overlap.

Card book page shading while turning

Card book pages should be shaded as the pages turn

Turn cards back into fish

Make koi more visible while dragging

Currently they get hidden under the finger when using touch controls

Book close button

This should be used instead of clicking outside the book area

Turn fish into cards by dragging them down to the card hand area

When using touch controls, turning a card into a fish loses focus after spawning the fish

Detect where wind gusts are visible & should cause audio effects

Wind gusts over water don't show up

Resizing breaks weather transitions

Book open button

Card book

A book with pages of cards. Some card slots have specific conditions for the card they should hold.

Spawn new fish under the broadest part of the mother fish

Focal point for stripes pattern

Threshold gets higher the further it is from the focal point

Fish audio panning

Fish effects should be panned depending on fish location

Focal point for spots pattern

Roughly the same as #2, with extra dimension

When turning cards into fish, the fish body should be under the cursor