UD-S24-CISC374 · ACTrexler · Mar 21, 2024 · Mar 21, 2024 · Mar 21, 2024 · Mar 21, 2024
diff --git a/.github/.keep b/.github/.keep
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -5,8 +5,6 @@ on:
     # Runs on pushes targeting the default branch
     push:
         branches: [main]
-    pull_request:
-        branches: [main]
 
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:

diff --git a/README.md b/README.md
@@ -1 +1,68 @@
-REPLACE THIS WITH A DESCRIPTION OF YOUR GAME (in the README.md file).
+# Boolean Bonanza
+
+# Team Color
+
+cyan
+
+# Developers
+
+-   Alex Trexler ([email protected])
+-   Michael Murphy ([email protected])
+-   Clay Wilfong ([email protected])
+
+# Blurb
+
+Boolean Bonanza is a dynamic puzzle game where players are presented with a grid of squares labeled with boolean values and operators such as True, False, And, Or and Not. The goal of the game is to click and move these blocks throughout the rows and columns of the grid to craft a boolean statement that evaluates to True. After successfully making a row or column that evaluates to True, the row or column will be cleared from the grid and the player will add points to their score. Boolean Bonanza is designed to offer a fun way to learn boolean logic.
+
+# Basic Instructions
+
+Starting the Game
+
+-   Select one of the three options on the menu:
+    -   Tutorial (An interactive walkthrough of the game)
+    -   Play 3 x 3 (A game mode that presents a 3 x 3 grid of boolean blocks and operators)
+    -   Play 5 x 5 (A game mode that presents a 5 x 5 grid of boolean blocks and operators)
+
+Gameplay Instructions
+
+-   Interact with the grid by clicking on one of the blocks. (The block will be tinted indicating you have clicked on it)
+-   Click on another block to swap its position with your already selected block.
+-   Maneuver the blocks in this manner to make a row or column that demonstrates a boolean statement that evaluates to True such as:
+    -   T AND T
+    -   F OR T
+    -   T AND T OR F
+
+Scoring / Time
+
+-   After making a row or column that evaluates to True, the row or column will disappear and add points to the player's score.
+-   The player must make as many True boolean statements as they can before the time limit in the corner of the screen runs out and ends the game
+
+# Screenshot
+
+![screenshot](https://github.com/UD-S24-CISC374/final-project-cyan/blob/main/docs/large.png?raw=true)
+
+# Gameplay Video
+
+https://www.youtube.com/embed/qgengQMsyD0?si=A9qvKEe1d8bq5z-h
+
+# Educational Game Design Document
+
+Link to our [egdd](https://github.com/UD-S24-CISC374/final-project-cyan/blob/main/docs/egdd.md)
+
+# Credits
+
+Boolean block textures: Alex Trexler
+
+Block break sound: Cork by Blender Foundation (submitted by Lamoot) https://opengameart.org/content/cork
+
+Gameplay background music: Contemplation by Bart https://opengameart.org/content/contemplation
+
+Button press sound: Cloud Click by Mobeyee Sounds https://mobeyee.com
+
+Main menu music: Puzzle Menu by caret7 https://opengameart.org/content/puzzle-menu
+
+Block Break Animations: AlotofImpacts - 5 Frame Impacts by JoesAlotofthings https://opengameart.org/users/joesalotofthings
+
+
+
+
diff --git a/assets/audio/effects/click.mp3 b/assets/audio/effects/click.mp3
diff --git a/assets/audio/effects/cork.mp3 b/assets/audio/effects/cork.mp3
diff --git a/assets/audio/music/contemplation.mp3 b/assets/audio/music/contemplation.mp3
diff --git a/assets/audio/music/puzzlemenu.ogg b/assets/audio/music/puzzlemenu.ogg
diff --git a/assets/backgrounds/3x3backplate.png b/assets/backgrounds/3x3backplate.png
diff --git a/assets/backgrounds/5x5backplate.png b/assets/backgrounds/5x5backplate.png
diff --git a/assets/blocks/And.png b/assets/blocks/And.png
diff --git a/assets/blocks/False.png b/assets/blocks/False.png
diff --git a/assets/blocks/Not.png b/assets/blocks/Not.png
diff --git a/assets/blocks/Or.png b/assets/blocks/Or.png
diff --git a/assets/blocks/True.png b/assets/blocks/True.png
diff --git a/assets/effects/effects/ImpactMetal8DkBlue .png b/assets/effects/effects/ImpactMetal8DkBlue .png
diff --git a/assets/effects/effects/ImpactMetal8Green .png b/assets/effects/effects/ImpactMetal8Green .png
diff --git a/assets/effects/effects/ImpactMetal8Purple .png b/assets/effects/effects/ImpactMetal8Purple .png
diff --git a/assets/effects/effects/ImpactMetal8Red .png b/assets/effects/effects/ImpactMetal8Red .png
diff --git a/assets/effects/effects/ImpactMetal8Yellow .png b/assets/effects/effects/ImpactMetal8Yellow .png
diff --git a/assets/effects/effects/PhysicalImpact01DkBlue 2.png b/assets/effects/effects/PhysicalImpact01DkBlue 2.png
diff --git a/assets/effects/effects/PhysicalImpact01DkBlue 3.png b/assets/effects/effects/PhysicalImpact01DkBlue 3.png
diff --git a/assets/effects/effects/PhysicalImpact01Green 2.png b/assets/effects/effects/PhysicalImpact01Green 2.png
diff --git a/assets/effects/effects/PhysicalImpact01Green 3.png b/assets/effects/effects/PhysicalImpact01Green 3.png
diff --git a/assets/effects/effects/PhysicalImpact01Purple 2.png b/assets/effects/effects/PhysicalImpact01Purple 2.png
diff --git a/assets/effects/effects/PhysicalImpact01Purple 3.png b/assets/effects/effects/PhysicalImpact01Purple 3.png
diff --git a/assets/effects/effects/PhysicalImpact01Red 2.png b/assets/effects/effects/PhysicalImpact01Red 2.png
diff --git a/assets/effects/effects/PhysicalImpact01Red 3.png b/assets/effects/effects/PhysicalImpact01Red 3.png
diff --git a/assets/effects/effects/PhysicalImpact01Yellow 2.png b/assets/effects/effects/PhysicalImpact01Yellow 2.png
diff --git a/assets/effects/effects/PhysicalImpact01Yellow 3.png b/assets/effects/effects/PhysicalImpact01Yellow 3.png
diff --git a/assets/effects/effects/blue.png b/assets/effects/effects/blue.png
diff --git a/assets/effects/effects/green.png b/assets/effects/effects/green.png
diff --git a/assets/effects/effects/purple.png b/assets/effects/effects/purple.png
diff --git a/assets/effects/effects/red.png b/assets/effects/effects/red.png
diff --git a/assets/effects/effects/yellow.png b/assets/effects/effects/yellow.png
diff --git a/assets/favicon.ico b/assets/favicon.ico
diff --git a/assets/img/phaser-logo.png b/assets/img/phaser-logo.png
diff --git a/assets/menu/MainMenuButton.png b/assets/menu/MainMenuButton.png
diff --git a/assets/menu/PauseButton.png b/assets/menu/PauseButton.png
diff --git a/assets/menu/PlayAgainButton.png b/assets/menu/PlayAgainButton.png
diff --git a/assets/menu/ResumeButton.png b/assets/menu/ResumeButton.png
diff --git a/assets/menu/menuBackplate.png b/assets/menu/menuBackplate.png
diff --git a/assets/menu/play3Button.png b/assets/menu/play3Button.png
diff --git a/assets/menu/play5Button.png b/assets/menu/play5Button.png
diff --git a/assets/menu/tutorialButton.png b/assets/menu/tutorialButton.png
diff --git a/assets/tutorial/instruction1.png b/assets/tutorial/instruction1.png
diff --git a/assets/tutorial/instruction2.png b/assets/tutorial/instruction2.png
diff --git a/assets/tutorial/instruction3.png b/assets/tutorial/instruction3.png
diff --git a/assets/tutorial/instruction4.png b/assets/tutorial/instruction4.png
diff --git a/assets/tutorial/instruction5.png b/assets/tutorial/instruction5.png
diff --git a/docs/credits.txt b/docs/credits.txt
@@ -0,0 +1,8 @@
+Credits for Boolean Bonanza
+
+Boolean block textures: Alex Trexler
+Block break sound: Cork by Blender Foundation (submitted by Lamoot) https://opengameart.org/content/cork
+Gameplay background music: Contemplation by Bart https://opengameart.org/content/contemplation
+Button press sound: Cloud Click by Mobeyee Sounds https://mobeyee.com
+Main menu music: Puzzle Menu by caret7 https://opengameart.org/content/puzzle-menu
+Block Break Animations: AlotofImpacts - 5 Frame Impacts by JoesAlotofthings https://opengameart.org/users/joesalotofthings
diff --git a/docs/egdd.md b/docs/egdd.md
diff --git a/docs/large.png b/docs/large.png
diff --git a/docs/small.png b/docs/small.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
-    "name": "final-project",
-    "version": "4.0.0",
-    "description": "Phaser 3 Final Project",
-    "homepage": "https://github.com/UD-S24-CISC374/final-project-template#readme",
+    "name": "Boolean Bonanza",
+    "version": "1.0.0",
+    "description": "Team Cyan Phaser 3 Final Project",
+    "homepage": "https://github.com/UD-S24-CISC374/final-project-cyan",
     "main": "index.js",
     "scripts": {
         "start": "webpack serve --config webpack/webpack.dev.js",
@@ -24,12 +24,12 @@
         "starter"
     ],
     "author": {
-        "name": "Austin Cory Bart",
+        "name": "Alex Trexler, Michael Murphy, and Clay Wilfong",
         "url": "https://github.com/acbart"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/UD-S24-CISC374/final-project-template.git"
+        "url": "https://github.com/UD-S24-CISC374/final-project-cyan"
     },
     "engines": {
         "node": ">=12"

diff --git a/pwa/icons/icons-192.png b/pwa/icons/icons-192.png
diff --git a/pwa/icons/icons-512.png b/pwa/icons/icons-512.png
diff --git a/pwa/manifest.json b/pwa/manifest.json
@@ -1,6 +1,6 @@
 {
-    "short_name": "Phaser Game",
-    "name": "My Cool Phaser 3 Game",
+    "short_name": "Boolean Bonanza",
+    "name": "Boolean Bonanza",
     "icons": [
         {
             "src": "./icons/icons-192.png",

diff --git a/src/config.ts b/src/config.ts
@@ -1,13 +1,18 @@
 import Phaser from "phaser";
-import MainScene from "./scenes/mainScene";
 import PreloadScene from "./scenes/preloadScene";
+import MenuScene from "./scenes/menuScene";
+import FiveByFiveLevel from "./scenes/fiveByFiveLevel";
+import PostLevelScene from "./scenes/postLevelScene";
+import ThreeByThreeLevel from "./scenes/threeByThreeLevel";
+import TutorialLevel from "./scenes/tutorial";
+import AdvancedTutorial from "./scenes/advancedTutorial";
 
 const DEFAULT_WIDTH = 1280;
 const DEFAULT_HEIGHT = 720;
 
 export const CONFIG = {
-    title: "My Untitled Phaser 3 Game",
-    version: "0.0.1",
+    title: "Boolean Bonanza",
+    version: "0.1.1",
     type: Phaser.AUTO,
     backgroundColor: "#ffffff",
     scale: {
@@ -17,7 +22,15 @@ export const CONFIG = {
         width: DEFAULT_WIDTH,
         height: DEFAULT_HEIGHT,
     },
-    scene: [PreloadScene, MainScene],
+    scene: [
+        PreloadScene,
+        MenuScene,
+        FiveByFiveLevel,
+        PostLevelScene,
+        ThreeByThreeLevel,
+        TutorialLevel,
+        AdvancedTutorial,
+    ],
     physics: {
         default: "arcade",
         arcade: {