Skip to content

softwarenacho/sushi-crush

Repository files navigation

Sushi Crush Game

Getting Started

Dive into the delicious world of Sushi Crush, a delightful match-3 puzzle game built using React and Next.js. Players swap adjacent sushi pieces on a board to create rows or columns of three or more identical pieces. Matched sushi pieces disappear, new ones fall into place, and players score points for each figure in a match. The game now features two exciting modes: Infinite and Levels.

Description

Sushi-Crush is an exciting match-3 puzzle game where players swap adjacent sushi pieces to create matches. The game is built using React and Next.js and provides a fun and interactive way to pass the time.

Game Modes

Infinite Mode

Objective: The goal is to match three or more identical sushi pieces in a row or column to score points continuously.

Gameplay:

  • Click on a sushi piece to select it. For touch devices, tap on a sushi piece.
  • Click on an adjacent piece to swap them. On touch devices, swipe horizontally or vertically between adjacent pieces.
  • If the swap creates a match of three or more identical pieces, those pieces will disappear, and new pieces will fall into place.
  • Continue making matches to accumulate points.

Scoring: Points are awarded based on the number of matches and the length of each match.

Moves: The game tracks the number of moves made.

Reset: Click the "Reset" button to start a new game.

Levels Mode

Objective: Complete established goals for each level to progress. The difficulty increases with each level.

Gameplay:

  • Select a level from the level selector page.
  • Each level has specific goals to accomplish, such as reaching a certain score or making a certain number of matches.
  • Similar to Infinite Mode, click or swipe to swap sushi pieces and create matches.
  • Complete the level's goals to earn up to 3 stars based on your performance.

Scoring: Points and stars are awarded based on the goals achieved and the efficiency of moves.

Unlocking Levels: Only the first level is unlocked at the beginning. Completing a level unlocks the next one.

Basic Instructions

  • Objective: The goal of the game is to match three or more identical sushi pieces in a row or column to score points. Multiple matches in a single movement will increase your average.

  • Gameplay:

  1. Click on a sushi piece to select it. For touch devices, tap on a sushi piece.
  2. Click on an adjacent piece to swap them. On touch devices, swipe horizontally or vertically between adjacent pieces.
  3. If the swap creates a match of three or more identical pieces, those pieces will disappear, and new pieces will fall into place.
  4. Continue making matches to accumulate points or complete the level goals.

Setup and Development

To set up Sushi-Crush locally, follow these steps:

  1. Clone the repository:
git clone https://github.com/softwarenacho/sushi-crush.git
  1. Navigate to the project directory:
cd sushi-crush
  1. Install dependencies:
   yarn install
  1. Start the development server:
  yarn dev
  1. You can build the production run:
  yarn build
  yarn start

The game should now be running at http://localhost:3000.

To Do

  • Levels Instructions
  • New types of Goals in Levels (time, specific figures)
  • High Scores
  • Offline
  • Online levels and highscores sync

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License. Feel free to modify this documentation as needed to fit your project's specifics.