Skip to content

AhamSammich/lets-play-koikoi

Repository files navigation

Let's Play Koi-Koi

Let's Play Koi-Koi is a web-based card game that allows you to play the Japanese card game Koi-Koi against an AI opponent. This game features beautiful artwork created by various artists, and the primary goal of the project is to share these designs by making them playable online.

Play now at https://lets-play-koikoi.vercel.app!

How to Play

Overview

Koi-Koi is a simple card game that is typically played with hanafuda (literally "flower cards"). In this web-based version, the game is played with a standard 48-card deck. The objective of the game is to score points by collecting sets of cards, called "yaku". Points are awarded based on the number of yaku collected, and the player with the most points at the end of the game wins.

Gameplay

To play, simply click on the "Start" button on the homepage. You will be dealt a hand of cards, and the AI opponent will be dealt a hand as well. To collect sets of cards, you must match cards in your hand with cards on the table that share the same suit (flower). Once you have collected a yaku, you will be prompted to continue (and possibly collect more yaku) or end the round and score points.

The game ends when all cards have been played, or when one player reaches a predetermined number of points.

Try playing a round!

Rule Variations

Many different rules and game variants exist for Koi-Koi. This version offers some optional scoring rules with more to be added. More in-depth guides on rules and scoring can be found using the links below.

Artwork

The artwork featured in Let's Play Koi-Koi was created by various artists, and can be found in the "public/cards" directory of the repository. The history of Hanafuda reaches back quite far, but new reimaginations of the classic designs continue to surface to this day!

Example artwork from the game

Attributions

The currently available designs in the game are attributed to the following artists:

Design Artist
Modern Hanafuda Sarah Thomas
Moon Rabbit Hanafuda Kelsey Cretcher
Nishiki Fuda Estudio Artes
Pokemon Cards SablingArt
Koinobori & Hanami Hanafuda IndianWolf Studios
Hanafuda Parish Cherry

Browse the designs here!

Contribution

Whether you're an artist, developer, or fellow hanafuda enthusiast, contributions are certainly welcome! Check our CONTRIBUTING page to see how you can contribute to this project!

Development

If you would like to run a local copy of Let's Play Koi-Koi for development or testing purposes, follow these steps:

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies by running npm install in the root directory of the project.
  3. Run the development server by running npm run dev.
  4. Navigate to http://localhost:3000 in your web browser.

Technologies

This project was built using the Nuxt.js, Vue.js, and TypeScript.

Credits

Let's Play Koi-Koi was created by our contributors. All artworks uses in the game are attributed to and property of the respective artists. This project is licensed under the MIT License.

About

Play a game of Koi-Koi against an AI opponent

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published