Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 4.33 KB

README.md

File metadata and controls

119 lines (76 loc) · 4.33 KB
Raw

Scuba Sweep - Flutter Game

image info

Welcome to Scuba Sweep, a captivating underwater adventure game built with Flutter

Our project draws inspiration from our deep concern for the environment, particularly the dire issue of plastic pollution in our oceans. Witnessing the suffering of innocent sea creatures like turtles and fish due to plastic waste deeply saddens us. Consequently, we are driven by a strong desire to showcase actionable steps we can take to make a positive difference. The game was built for DEVPOST Global Gamers Challenge - Flutter

What it does

Scuba Sweep aims to shed light on the pressing issue of ocean plastic pollution. Players immerse themselves in the role of a diver navigating through the ocean depths, tasked with collecting different types of plastic debris encountered along the way. Amidst this mission, they must also navigate past hazardous sea creatures, adding an element of challenge and urgency to the gameplay experience.

How we built it

The game is crafted using Flutter, with Flame serving as the game engine and Riverpod for state management. Players have the freedom to select their own nickname to personalize their score tracking experience.

As the game begins, the diver component is introduced, automatically ascending and responsive to left or right movements via drag controls. Gradually, plastic and enemy components are introduced, each featuring distinct movements tailored to their creature type, heightening the challenge for players.

Additionally, divers can collect booster components like the shell pearl, providing a temporary shield, offering protection against enemy encounters. The game concludes when the player component collides with enemies, signaling the end of the gameplay session.

Prerequisites

Foundation is built with Flutter Presetup tool that we developed internaly to help kickstart new projects.

  • Flutter version 3.16.2

  • [Use fvm for flutter versioning if default flutter version is not right]

  • if fvm flutter is not setup in your working environment (vs code/ android studio) use prefix fvm when running command fvm flutter build ...

  • vs code settings.json for fvm usage automatically based by project

"dart.flutterSdkPath": ".fvm/flutter_sdk",
// Remove .fvm files from search
"search.exclude": {
    "**/.fvm": true
},
// Remove from file watching
"files.watcherExclude": {
    "**/.fvm": true
},

Getting Started

This project uses Flutter flavor, with two flavors:

  • dev
  • prod

Populate lib/main_{flavor}.dart file to update params for specific environments

  • Running flavors

    To run dev env debug:

    flutter run --flavor dev -t lib/main_dev.dart

    To run prod env debug:

    flutter run --flavor prod -t lib/main_prod.dart

Building application

Build per flavors, for android firebase build apk and for play store appbundle

Android

  • Dev APK:
fvm flutter build apk --split-per-abi --flavor dev -t lib/main_dev.dart
  • Prod AppBundle:
fvm flutter build appbundle --flavor prod -t lib/main_prod.dart

IOs

  • Dev ipa:
fvm flutter build ipa --flavor dev -t lib/main_dev.dart
  • Prod ipa:
fvm flutter build ipa --flavor prod -t lib/main_prod.dart

Generate Icons

To assets folder add icons named by env launcher-icon-dev.png, launcher-icon-prod.png and then run:

fvm flutter pub get && fvm flutter pub run flutter_launcher_icons:main -f flutter_launcher_icons*

Generate freezed files

fvm flutter pub run build_runner build --delete-conflicting-outputs

Download Apk Files

Apk File from releases directory