Skip to content

Latest commit

ย 

History

82 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Spring Festival Crush - Match 3

App Store Swift iOS License

๐ŸŽฎ Demo

Gameplay Demo

Overview

Spring Festival Crush - Match 3 is a vibrant match-3 puzzle game that captures the essence of the Spring Festival. Immerse yourself in a world filled with festive joy, challenging puzzles, and stunning graphics that celebrate the season.

โœจ Features

  • ๐ŸŽ‰ Festive Theme: Dive into the spirit of the Spring Festival with themed levels and elements that bring the celebration to life.
  • ๐Ÿงฉ Challenging Gameplay: Overcome a variety of levels that increase in difficulty, offering endless fun and a test of your puzzle-solving skills.
  • โšก Smooth Experience: Enjoy fluid animations and intuitive controls for a seamless gaming experience.
  • ๐ŸŽต Immersive Audio: Experience traditional Chinese music and sound effects that enhance the festive atmosphere.
  • ๐ŸŒŸ Multiple Zodiac Themes: Play through different Chinese zodiac animal themes with unique challenges.
  • ๐Ÿ“Š Progress Tracking: Save your progress and track your achievements across all levels.
  • ๐Ÿ’ฅ Special Power-Up Tiles: Earn powerful tiles through skillful matches for explosive chain reactions.
  • โค๏ธ Lives System: Ten hearts pace your play session, regenerating over time โ€” or refill instantly with a rewarded video.
  • ๐Ÿงฐ Pre-Level Boosters: Spend coins earned from levels on extra moves or a tile-clearing hammer before a tough level.
  • ๐Ÿงฉ Rich Level Mechanics: Multi-hit vault locks, spreading chocolate blockers, jelly overlays, ice-frozen tiles, ingredient-escort goals, and optional countdown timers.

๐Ÿ“ฑ Screenshots

Gameplay Screenshot 1 Screenshot 2

๐Ÿงณ Requirements

  • iOS Version: iOS 17.0 or later
  • Compatible Devices: iPhone, iPad
  • Xcode: 15.0 or later
  • Swift: 5.0+

๐Ÿ’ป Installation

iOS App Store

The game is available for download on the App Store. Click the link below to download:

Download on the App Store

Local Development

  1. Clone the repository:

    git clone https://github.com/banghuazhao/Spring-Festival-Crush.git
    cd Spring-Festival-Crush
  2. Open the project:

    • Open SpringFestivalCrush.xcodeproj in Xcode
    • Select your target device or simulator
  3. Build and run:

    • Press Cmd + R to build and run the project
    • Or click the "Play" button in Xcode

๐ŸŽฏ How to Play

  1. Match 3 or More: Swipe to match three or more identical elements in a row to clear them from the board.
  2. Complete Objectives: Meet the goals for each level within the allotted moves or time limit.
  3. Progress Through Levels: Advance through increasingly difficult levels and unlock new challenges as you go.
  4. Unlock Zodiac Themes: Complete levels to unlock different Chinese zodiac animal themes.

๐Ÿ’ฅ Special Tiles

Match Tile Effect
4 in a row ๐Ÿ’ฅ Enhanced Explodes all surrounding tiles with a shockwave
5 in a row ๐ŸŒŸ Universal (Five) Swap with any tile to clear every tile of that type on the board
L / T shape โšก Lightning Clears the entire row and column instantly
๐Ÿ”’ Lock Lock Requires an adjacent match to break free
โ›“๏ธ Heavy Lock Heavy Lock Takes two adjacent matches to remove

Special tiles can be swapped directly to trigger their effect at any time. Some levels start with one already on the board โ€” a preview of what's to come, or a helping hand on a tougher level.

๐Ÿงฉ Level Elements

Element Behavior
๐Ÿ” Vault Lock Three-hit lock: vault โ†’ heavy lock โ†’ lock โ†’ cleared
๐Ÿซ Chocolate Clears like a lock, but spreads to an adjacent tile each move if left alone
๐ŸŸฉ Jelly A layer under the tile โ€” keep matching over it to clear it, regardless of what's on top
๐ŸงŠ Ice Freezes a tile in place; breaks one layer at a time when a neighboring match clears
๐ŸŽ Ingredient Guide it down to the bottom row to collect it
โฑ๏ธ Timer Some levels race the clock in addition to (or instead of) move count

โค๏ธ Lives & Boosters

  • Start with 10 lives; one is spent each time you fail a level, regenerating over time.
  • Out of lives? Watch a rewarded video for +1 life, or wait for the countdown.
  • Before a tough level, spend coins (earned by completing levels) on a +5 Moves boost or a Hammer that clears one tile of your choice mid-level.

๐Ÿ—๏ธ Project Structure

SpringFestivalCrush/
โ”œโ”€โ”€ Model/                 # Data models and game logic
โ”‚   โ”œโ”€โ”€ Game/             # Core game mechanics
โ”‚   โ”œโ”€โ”€ Level/            # Level data and objectives
โ”‚   โ”œโ”€โ”€ Music/            # Audio management
โ”‚   โ”œโ”€โ”€ Record/           # Progress tracking
โ”‚   โ””โ”€โ”€ Settings/         # App settings and themes
โ”œโ”€โ”€ Scene/                # SpriteKit game scenes
โ”œโ”€โ”€ View/                 # SwiftUI views and UI components
โ”œโ”€โ”€ Assets.xcassets/      # Images and app icons
โ”œโ”€โ”€ Sounds/               # Audio files
โ”œโ”€โ”€ Levels/               # Level configuration files
โ””โ”€โ”€ Util/                 # Utility classes and extensions

๐Ÿ› ๏ธ Development

Tech Stack

  • Language: Swift 5.0+
  • Game Framework: SpriteKit
  • UI Framework: SwiftUI
  • Concurrency: Swift Concurrency (async/await)
  • Data Persistence: SwiftData
  • Ad Integration: Google AdMob
  • Build System: Xcode

Key Features

  • Modern Swift: Leverages the latest Swift features including async/await and SwiftData
  • Performance Optimized: Efficient memory management and smooth 60fps gameplay
  • Accessibility: Supports VoiceOver and other accessibility features
  • Localization: Available in English, Simplified Chinese, and Traditional Chinese

๐Ÿ“‹ Release Notes

Version 3.0 (Latest)

  • ๐ŸŒŸ New Universal (Five) power-up tile: match 5 in a row to earn it, then swap to clear every tile of one type
  • โšก New Lightning power-up tile: formed from L/T-shape matches, clears an entire row and column at once
  • ๐Ÿ’ฅ Double-lock tile mechanic: heavy locks require two adjacent matches to break
  • ๐ŸŽจ Distinct activation effects for each power-up (shockwave ring, beam chain-link pull, yellow flash bar)
  • ๐Ÿพ Tiger zodiac: 10 new levels added
  • ๐Ÿ“ˆ Rat and Ox zodiacs extended to 15 levels each
  • ๐Ÿ”ง Enhanced tile now spawns at the exact position of the swapped tile
  • โค๏ธ Lives system: 10 hearts, regenerating over time, with a rewarded-video refill option
  • ๐Ÿงฐ Pre-level boosters: spend coins on +5 moves or a tile-clearing hammer before a level starts
  • ๐ŸŽฌ Rewarded video ads for bonus lives and coins
  • ๐ŸŽ“ First-time tutorial hint highlighting a real swappable pair on your very first level
  • ๐Ÿงฉ New level elements: three-hit vault locks, spreading chocolate blockers, jelly overlays, ice-frozen tiles, ingredient-escort goals, and optional countdown timers โ€” all authorable in any level's data, not just debug content
  • ๐ŸŒŸ Special power-up tiles can now be pre-placed in level data, giving 17 levels across all three zodiacs a tutorial preview or a difficulty-easing assist
  • ๐Ÿ–ฅ๏ธ Rebuilt in-game HUD as a proper component system (measured layout instead of hardcoded offsets, a single-banner hint system, a data-driven booster tray) โ€” fixes a real layout bug where the HUD could balloon to fill the screen
  • ๐Ÿ› Fixed candies falling straight through locks/blockers instead of stopping at them, then reworked hole-filling into a proper water-flow model (diagonal cascade around blockers) after the first fix left permanent gaps โ€” and fixed a same-row variant of that fix that could freeze the game by oscillating forever between two blocked cells
  • ๐Ÿ› Fixed selection indicator showing a broken-image cross on emoji-rendered tiles
  • ๐Ÿ› Fixed rewarded ads failing to load (wrong ad format) and failing to present from inside a sheet
  • ๐Ÿ› Fixed two levels with lock targets that mathematically exceeded the lock tiles available, making them unwinnable regardless of skill

Version 2.0

  • โœจ Enhanced graphics and animations
  • ๐ŸŽต Improved audio experience with traditional Chinese music
  • ๐ŸŒŸ Added new zodiac themes and levels
  • ๐Ÿ“Š Better progress tracking and achievements
  • ๐Ÿ› Bug fixes and performance improvements

Version 1.0

  • ๐ŸŽฎ Initial release with core match-3 gameplay
  • ๐ŸŽจ Spring Festival themed graphics and elements
  • ๐Ÿ“ฑ Support for iPhone and iPad

๐Ÿค Contributing

We welcome contributions to the project! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add some amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Development Guidelines

  • Follow Swift style guidelines
  • Add comments for complex logic
  • Test on both iPhone and iPad
  • Ensure accessibility compliance

๐Ÿ› Issues & Support

If you encounter any bugs or have suggestions:

  • GitHub Issues: Open an issue
  • App Store Reviews: Leave a review on the App Store
  • Email Support: Contact us through the app settings

๐Ÿ“ž Contact

Get in touch with us:

For business inquiries or collaboration opportunities, please reach out through GitHub or the app.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE.md file for details.

๐Ÿ™ Acknowledgments

  • Traditional Chinese music and sound effects
  • Spring Festival cultural elements and themes
  • The SpriteKit and SwiftUI communities
  • All beta testers and contributors

ยฉ 2019 - 2026 Spring Festival Crush - Match 3 by Appsbay. All rights reserved.

About

A Chinese Spring Festival-themed Match-3 game built with Swift, leveraging SpriteKit for game mechanics, SwiftUI for the UI, Swift Concurrency for enhanced performance, and SwiftData for model persistence.

Topics

Resources

Stars

28 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages