Skip to content

vibe-with-wyn/slime-dash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

65 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Slime Dash ๐ŸŽฎ

There is currently an issue with itch.io web play, which is being addressed. To play or test the game install it on your android device for now.

Download APK Play on itch.io Unity License

A colorful 2D mobile platformer featuring precise jumping, coin collection, and challenging level progression


๐ŸŽฎ About

Slime Dash is a fast-paced 2D platformer where you guide a brave slime through dangerous levels filled with spikes, platforms, and collectible coins. Master the controls, avoid hazards, and reach the portal to unlock new challenges!

Game Features

  • ๐ŸŽฏ Progressive Level System with unlockable stages
  • ๐Ÿ’ฐ Coin Collection with persistent score tracking
  • โค๏ธ Lives System with checkpoint-based respawning
  • ๐ŸŽจ Smooth Animations - Idle, jump, die, swallow states
  • ๐ŸŽต Dynamic Sound Effects for all actions
  • ๐Ÿ“ฑ Mobile-Optimized for landscape play (1920ร—1080)
  • ๐Ÿ Portal Completion with satisfying animations
  • ๐Ÿ’พ Auto-Save Progress - your progress is always saved

๐Ÿ“ฑ Play Now

WebGL (Browser)

๐ŸŽฎ Play on itch.io

  • โœ… No installation required
  • โœ… Works on desktop and mobile browsers
  • โœ… Instant play - loads in seconds
  • โšก Hardware acceleration recommended

Download Android APK

๐Ÿ“ฅ Download Latest Release (v1.0.0)

Requirements

  • Android 7.0 (Nougat) or higher
  • 150MB free storage
  • Touch-screen device
  • Landscape orientation recommended

Installation

  1. Download SlimeDash.apk from Releases
  2. Enable Settings > Security > Install Unknown Apps (allow for your browser)
  3. Tap the downloaded APK file
  4. Tap Install, then Open

๐Ÿ•น๏ธ Controls

Mobile (Touch)

  • Move: Tap left/right on-screen buttons
  • Jump: Tap jump button
  • Navigate Menus: Tap UI elements

Tip: Touch controls are optimized for landscape orientation!


๐ŸŽฏ How to Play

  1. Navigate the Levels - Use precise jumps to cross platforms
  2. Collect Coins - Gather all coins for maximum score
  3. Avoid Hazards - Spikes and death zones will cost you a life
  4. Reach the Portal - Complete each level to unlock the next
  5. Manage Lives - You have 3 hearts - use them wisely!

Game Progression

  • Level 1: Tutorial - Learn the basics
  • Level 2+: Unlocked by completing previous levels
  • Checkpoints: Auto-respawn at checkpoints after death
  • Game Over: Retry or return to level selection

๐ŸŽจ Game Systems

Player Mechanics

  • Responsive Controls - Tight platformer feel with precise jumping
  • Ground Detection - Tag-based collision with overlap fallback
  • Animator States - IsGrounded, IsJumping, IsMoving
  • Input Locking - Disables during cutscenes and death

Lives & Respawn

  • 3 Hearts - Displayed as sprite hearts in the UI
  • Checkpoint System - Respawn at last checkpoint
  • Death Animation - Smooth death sequence before respawn
  • Game Over Panel - Retry button to restart level

Sound System

  • Action SFX - Jump, die, coin collect, movement
  • Button Feedback - Selection sounds on hover/click
  • Looping Movement - Continuous audio while moving
  • Mobile Audio Unlock - Automatically unlocked on first tap

Level Progression

  • Portal Completion - Enter portal to finish level
  • Unlock Next Level - Progression tracked via GameManager
  • Level Selection UI - Visual lock/unlock states
  • Persistent Progress - Saved via PlayerPrefs

๐Ÿ“Š Technical Details

Specification Details
Engine Unity 2021+
Language C# 9.0 (.NET Framework 4.7.1)
Platforms WebGL, Android
APK Size ~51 MB
Min Android 7.0 (API 24)
Resolution 1920ร—1080 (Landscape)
WebGL Size ~50 MB (Brotli compressed)
Testing NUnit - 12+ unit tests

Browser Requirements

  • Modern browser (Chrome 90+, Firefox 88+, Edge 90+, Safari 14+)
  • WebGL 2.0 support (WebGL 1.0 fallback available)
  • Hardware acceleration enabled
  • 512 MB WebGL memory (configurable)

๐Ÿ› ๏ธ Development

Key Systems

Player Controller

  • Tag-based ground checking with overlap detection
  • Touch and keyboard input support
  • Animator state management
  • Input enable/disable for cutscenes

Game Manager (Singleton)

  • Level unlock/completion tracking via PlayerPrefs
  • Persistent coin collection system
  • Scene-wide progress management

Lives & Respawn

  • Heart-based lives display with sprite toggling
  • Checkpoint system with configurable respawn points
  • Game Over panel with retry functionality
  • Integration with RespawnManager

Sound System

  • SoundEffectController - Detects animator states and plays SFX
  • ButtonSelectSfx - Plays selection sounds on UI interactions
  • Audio unlocking for mobile browsers

๐Ÿ—๏ธ Building from Source

Prerequisites

  • Unity 2021.3 LTS or newer
  • WebGL Build Support module installed

WebGL Build

  1. Clone this repository:

  2. Open project in Unity

  3. Configure Edit > Project Settings > Player > WebGL:

    • Company Name: VibeWithWyn
    • Product Name: Slime Dash
    • WebGL Memory Size: 512 MB
    • Compression Format: Brotli
    • Enable Decompression Fallback: โœ…
  4. File > Build Profiles โ†’ Select Web โ†’ Build

  5. Zip the build folder (ensure index.html is at root)

  6. Upload to itch.io or host on Netlify/GitHub Pages

Android Build

  1. Install Android Build Support module
  2. Switch Platform to Android
  3. Configure:
    • Bundle Identifier: com.vibewithwyn.slimedash
    • Minimum API Level: 24
    • Orientation: Landscape
  4. Build โ†’ Save as .apk

๐Ÿค Contributing

Contributions are welcome! Please follow these steps:

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

Development Guidelines

  • Follow existing code style and conventions
  • Add unit tests for new features
  • Update documentation as needed
  • Test on multiple browsers/devices before submitting

๐Ÿ“œ License

Licensed under the MIT License - see LICENSE file for details.

Third-Party Assets

  • TextMesh Pro - ยฉ Unity Technologies (Unity Companion License)
  • EmojiOne - ยฉ EmojiOne (see attribution file)
  • Liberation Sans Font - SIL Open Font License 1.1

๐ŸŽจ Credits

Development

  • Developer: Wendel (vibe-with-wyn)
  • Engine: Unity Technologies
  • Programming: C#

Game Assets

Third-party assets used under their respective licenses. Credits to the owner of all the free game assets that I did use on this game

Tools & Assistance

  • Unity Engine ยฉ Unity Technologies
  • AI Development Assistance: GitHub Copilot
  • Testing Framework: NUnit

๐Ÿ› Issues & Support


๐ŸŒŸ Show Your Support

If you enjoy Slime Dash:

  • โญ Star this repository
  • ๐Ÿด Fork and contribute improvements
  • ๐Ÿ“ข Share with friends and on social media
  • ๐Ÿ’ฌ Rate the game on itch.io
  • ๐ŸŽฎ Follow development updates

๐Ÿ“ˆ Roadmap

Planned Features

  • ๐ŸŽฎ More Levels - 10+ additional stages
  • ๐ŸŽจ New Slime Skins - Unlockable character variants
  • ๐Ÿ† Leaderboards - Global high scores
  • ๐ŸŽต Music System - Background music tracks
  • ๐ŸŒ Localization - Multi-language support

Known Improvements

  • Performance optimization for mobile browsers
  • Additional animation polish
  • Enhanced tutorial/onboarding
  • More sound effects and visual feedback

โš ๏ธ Rapid Development Disclaimer

This game was created rapidly, so it may contain small bugs or inconsistencies. If you encounter issues, please report them via GitHub Issues.


Keep jumping, avoid spikes, and dash to victory! ๐ŸŽฎโœจ

Play Now โ€ข Report Bug โ€ข Star Repo

Made with โค๏ธ by Wendel

About

๐Ÿ˜ โ€” A colorful 2D mobile platformer built with Unity. Guide a brave slime through challenging levels, collect coins, avoid spikes, and unlock new stages. Features checkpoint-based respawning, lives system, and smooth animations.

Topics

Resources

License

Stars

Watchers

Forks

Contributors