Skip to content

jobtalle/Koi

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

49297fe · May 6, 2024
Apr 28, 2024
Dec 21, 2021
May 6, 2024
Feb 8, 2021
May 1, 2024
Oct 4, 2021
Apr 28, 2024
Sep 5, 2021
Mar 12, 2021
Mar 26, 2021
Aug 21, 2023
Oct 4, 2021
Jan 21, 2021
Jan 16, 2021
Apr 28, 2024
Nov 17, 2020
Aug 26, 2022
May 6, 2024
Mar 26, 2021
Dec 7, 2021
Dec 18, 2021

Repository files navigation

Koi Farm

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

alt text

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.