UD-S24-CISC374 · github-classroom · Mar 20, 2024 · Mar 20, 2024 · Mar 20, 2024 · Apr 2, 2024
diff --git a/README.md b/README.md
@@ -1 +1,46 @@
-REPLACE THIS WITH A DESCRIPTION OF YOUR GAME (in the README.md file).
+# Game Name
+
+Boolean Bonanza
+
+# Team Color
+
+Teal
+
+# Developers
+
+-   Angelo Ramos (angelora@udel.edu)
+-   Patrick Tiamson (pattiam@udel.edu)
+
+# Blurb
+
+Dive into the exciting world of programming with our interactive puzzle game designed to make learning fun! Master the essential coding skill of boolean expressions as you solve engaging challenges that stimulate your mind. Perfect for beginners and experienced coders alike, our game transforms complex concepts into easy-to-understand, enjoyable puzzles. Whether you're looking to boost your programming skills or just love a good brain teaser, this game is your gateway to coding mastery. Ready to code and play your way to success? Join us and turn learning into an adventure!
+
+# Basic Instructions
+
+### Objective
+
+-   Evaluate boolean expressions to `true` to complete objectives
+
+### Controls
+
+-   **Arrow Keys (Up, down, left, right) or WASD Keys**: Swap and move tiles around the board
+-   **R Key**: Select a row
+-   **C Key**: Select a column
+-   **ENTER Key**: Confirm your choice
+
+# Screenshot
+
+![Screenshot of gameplay in action](docs/large.png)
+
+# Gameplay Video
+
+https://drive.google.com/file/d/1C1m25t_aci_TQ4Rk8dyEPvJn0G0vVa6e/view
+
+# Educational Game Design Document
+
+Link to our [EGDD](https://ud-s24-cisc374.github.io/final-project-teal/docs/egdd)
+
+# Credits
+
+-   <a href="https://www.vecteezy.com/vector-art/145740-children-drawing-vector">Children Drawing Vector Vectors by Vecteezy</a>
+-   <a href="https://www.vecteezy.com/vector-art/6561612-icon-in-hand-draw-style-drawing-with-wax-crayons-children-s-creativity">Icon in hand draw style. Drawing with wax crayons, children&#39;s creativity Vectors by Vecteezy</a>
diff --git a/assets/favicon.ico b/assets/favicon.ico
diff --git a/assets/img/crumbled-paper-background.png b/assets/img/crumbled-paper-background.png
diff --git a/assets/img/fail.png b/assets/img/fail.png
diff --git a/assets/img/game-over.png b/assets/img/game-over.png
diff --git a/assets/img/level-complete.png b/assets/img/level-complete.png
diff --git a/assets/img/looseleaf.jpeg b/assets/img/looseleaf.jpeg
diff --git a/assets/img/soundSprites/sliderHandle.png b/assets/img/soundSprites/sliderHandle.png
diff --git a/assets/img/soundSprites/soundHigh.png b/assets/img/soundSprites/soundHigh.png
diff --git a/assets/img/soundSprites/soundLow.png b/assets/img/soundSprites/soundLow.png
diff --git a/assets/img/soundSprites/soundMedium.png b/assets/img/soundSprites/soundMedium.png
diff --git a/assets/img/soundSprites/soundMute.png b/assets/img/soundSprites/soundMute.png
diff --git a/assets/img/title-screen-boolean-bonanza.png b/assets/img/title-screen-boolean-bonanza.png
diff --git a/assets/index.html b/assets/index.html
@@ -1,53 +1,89 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no, viewport-fit=cover"
-    />
-    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
-
-    <meta name="theme-color" content="#000000" />
-
-    <link rel="manifest" href="./manifest.json" />
-
-    <meta name="mobile-web-app-capable" content="yes" />
-    <meta name="apple-mobile-web-app-capable" content="yes" />
-    <meta name="application-name" content="<%= htmlWebpackPlugin.options.gameName %>" />
-    <meta name="apple-mobile-web-app-title" content="<%= htmlWebpackPlugin.options.gameName %>" />
-    <meta name="msapplication-starturl" content="./" />
-
-    <link rel="icon" type="image/png" sizes="192x192" href="./icons/icons-192.png" />
-    <link rel="apple-touch-icon" type="image/png" sizes="192x192" href="./icons/icons-192.png" />
-
-    <link rel="icon" type="image/png" sizes="512x512" href="./icons/icons-512.png" />
-    <link rel="apple-touch-icon" type="image/png" sizes="512x512" href="./icons/icons-512.png" />
-
-    <link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
-
-    <title><%= htmlWebpackPlugin.options.gameName %></title>
-    <style>
-      html,
-      body {
-        height: 100%;
-        margin: 0;
-        background-color: #000000;
-      }
-    </style>
+    <head>
+        <meta charset="UTF-8" />
+        <meta
+            name="viewport"
+            content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no, viewport-fit=cover"
+        />
+        <meta http-equiv="X-UA-Compatible" content="ie=edge" />
+
+        <meta name="theme-color" content="#000000" />
+
+        <link rel="manifest" href="./manifest.json" />
+
+        <meta name="mobile-web-app-capable" content="yes" />
+        <meta name="apple-mobile-web-app-capable" content="yes" />
+        <meta
+            name="application-name"
+            content="<%= htmlWebpackPlugin.options.gameName %>"
+        />
+        <meta
+            name="apple-mobile-web-app-title"
+            content="<%= htmlWebpackPlugin.options.gameName %>"
+        />
+        <meta name="msapplication-starturl" content="./" />
+
+        <link
+            rel="icon"
+            type="image/png"
+            sizes="192x192"
+            href="./icons/icons-192.png"
+        />
+        <link
+            rel="apple-touch-icon"
+            type="image/png"
+            sizes="192x192"
+            href="./icons/icons-192.png"
+        />
+
+        <link
+            rel="icon"
+            type="image/png"
+            sizes="512x512"
+            href="./icons/icons-512.png"
+        />
+        <link
+            rel="apple-touch-icon"
+            type="image/png"
+            sizes="512x512"
+            href="./icons/icons-512.png"
+        />
+
+        <link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
+
+        <link rel="preconnect" href="https://fonts.googleapis.com" />
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+        <link
+            href="https://fonts.googleapis.com/css2?family=Architects+Daughter&display=swap"
+            rel="stylesheet"
+        />
+
+        <title><%= htmlWebpackPlugin.options.gameName %></title>
+        <style>
+            html,
+            body {
+                height: 100%;
+                margin: 0;
+                background-color: #000000;
+            }
+        </style>
 
-    <noscript>Please enable javascript to continue using this application.</noscript>
+        <noscript
+            >Please enable javascript to continue using this
+            application.</noscript
+        >
 
-    <!-- installs the serviceWorker -->
-    <!-- <script>
+        <!-- installs the serviceWorker -->
+        <!-- <script>
       if ('serviceWorker' in navigator) {
         window.addEventListener('load', () => {
           navigator.serviceWorker.register('./sw.js')
         })
       }
     </script> -->
-  </head>
-  <body>
-    <div id="phaser-game"></div>
-  </body>
+    </head>
+    <body>
+        <div id="phaser-game"></div>
+    </body>
 </html>
diff --git a/assets/music/bg-music-1.wav b/assets/music/bg-music-1.wav
diff --git a/assets/sfx/click-1.wav b/assets/sfx/click-1.wav
diff --git a/assets/sfx/crumple-paper-1.wav b/assets/sfx/crumple-paper-1.wav
diff --git a/assets/sfx/incorrect-1.wav b/assets/sfx/incorrect-1.wav
diff --git a/assets/sfx/pop-1.wav b/assets/sfx/pop-1.wav
diff --git a/assets/sfx/pop-click-1.wav b/assets/sfx/pop-click-1.wav
diff --git a/assets/sfx/slide-1.wav b/assets/sfx/slide-1.wav
diff --git a/assets/sfx/slide-2.wav b/assets/sfx/slide-2.wav
diff --git a/assets/sfx/sweep-1.wav b/assets/sfx/sweep-1.wav
diff --git a/assets/sketches/sketch-1.png b/assets/sketches/sketch-1.png
diff --git a/assets/sketches/sketch-10.png b/assets/sketches/sketch-10.png
diff --git a/assets/sketches/sketch-11.png b/assets/sketches/sketch-11.png
diff --git a/assets/sketches/sketch-12.png b/assets/sketches/sketch-12.png
diff --git a/assets/sketches/sketch-2.png b/assets/sketches/sketch-2.png
diff --git a/assets/sketches/sketch-3.png b/assets/sketches/sketch-3.png
diff --git a/assets/sketches/sketch-4.png b/assets/sketches/sketch-4.png
diff --git a/assets/sketches/sketch-5.png b/assets/sketches/sketch-5.png
diff --git a/assets/sketches/sketch-6.png b/assets/sketches/sketch-6.png
diff --git a/assets/sketches/sketch-7.png b/assets/sketches/sketch-7.png
diff --git a/assets/sketches/sketch-8.png b/assets/sketches/sketch-8.png
diff --git a/assets/sketches/sketch-9.png b/assets/sketches/sketch-9.png
diff --git a/assets/story-img1.png b/assets/story-img1.png
diff --git a/assets/story-img2.png b/assets/story-img2.png
diff --git a/assets/story-img3.png b/assets/story-img3.png
diff --git a/assets/story-img4.png b/assets/story-img4.png
diff --git a/assets/story-img5.png b/assets/story-img5.png
diff --git a/assets/tiles/andTile.png b/assets/tiles/andTile.png
diff --git a/assets/tiles/andTileSelect.png b/assets/tiles/andTileSelect.png
diff --git a/assets/tiles/falseTile.png b/assets/tiles/falseTile.png
diff --git a/assets/tiles/falseTileSelect.png b/assets/tiles/falseTileSelect.png
diff --git a/assets/tiles/leftParenTile.png b/assets/tiles/leftParenTile.png
diff --git a/assets/tiles/leftParenTileSelect.png b/assets/tiles/leftParenTileSelect.png
diff --git a/assets/tiles/notTile.png b/assets/tiles/notTile.png
diff --git a/assets/tiles/notTileSelect.png b/assets/tiles/notTileSelect.png
diff --git a/assets/tiles/orTile.png b/assets/tiles/orTile.png
diff --git a/assets/tiles/orTileSelect.png b/assets/tiles/orTileSelect.png
diff --git a/assets/tiles/rightParenTile.png b/assets/tiles/rightParenTile.png
diff --git a/assets/tiles/rightParenTileSelect.png b/assets/tiles/rightParenTileSelect.png
diff --git a/assets/tiles/trueTile.png b/assets/tiles/trueTile.png
diff --git a/assets/tiles/trueTileSelect.png b/assets/tiles/trueTileSelect.png
diff --git a/assets/tiles/xorTile.png b/assets/tiles/xorTile.png
diff --git a/assets/tiles/xorTileSelect.png b/assets/tiles/xorTileSelect.png
diff --git a/assets/victorySketches/victorySketch1.png b/assets/victorySketches/victorySketch1.png
diff --git a/assets/victorySketches/victorySketch10.png b/assets/victorySketches/victorySketch10.png
diff --git a/assets/victorySketches/victorySketch11.png b/assets/victorySketches/victorySketch11.png
diff --git a/assets/victorySketches/victorySketch12.png b/assets/victorySketches/victorySketch12.png
diff --git a/assets/victorySketches/victorySketch13.png b/assets/victorySketches/victorySketch13.png
diff --git a/assets/victorySketches/victorySketch14.png b/assets/victorySketches/victorySketch14.png
diff --git a/assets/victorySketches/victorySketch15.png b/assets/victorySketches/victorySketch15.png
diff --git a/assets/victorySketches/victorySketch16.png b/assets/victorySketches/victorySketch16.png
diff --git a/assets/victorySketches/victorySketch17.png b/assets/victorySketches/victorySketch17.png
diff --git a/assets/victorySketches/victorySketch18.png b/assets/victorySketches/victorySketch18.png
diff --git a/assets/victorySketches/victorySketch19.png b/assets/victorySketches/victorySketch19.png
diff --git a/assets/victorySketches/victorySketch2.png b/assets/victorySketches/victorySketch2.png
diff --git a/assets/victorySketches/victorySketch20.png b/assets/victorySketches/victorySketch20.png
diff --git a/assets/victorySketches/victorySketch21.png b/assets/victorySketches/victorySketch21.png
diff --git a/assets/victorySketches/victorySketch22.png b/assets/victorySketches/victorySketch22.png
diff --git a/assets/victorySketches/victorySketch23.png b/assets/victorySketches/victorySketch23.png
diff --git a/assets/victorySketches/victorySketch24.png b/assets/victorySketches/victorySketch24.png
diff --git a/assets/victorySketches/victorySketch25.png b/assets/victorySketches/victorySketch25.png
diff --git a/assets/victorySketches/victorySketch26.png b/assets/victorySketches/victorySketch26.png
diff --git a/assets/victorySketches/victorySketch3.png b/assets/victorySketches/victorySketch3.png
diff --git a/assets/victorySketches/victorySketch4.png b/assets/victorySketches/victorySketch4.png
diff --git a/assets/victorySketches/victorySketch5.png b/assets/victorySketches/victorySketch5.png
diff --git a/assets/victorySketches/victorySketch6.png b/assets/victorySketches/victorySketch6.png
diff --git a/assets/victorySketches/victorySketch7.png b/assets/victorySketches/victorySketch7.png
diff --git a/assets/victorySketches/victorySketch8.png b/assets/victorySketches/victorySketch8.png
diff --git a/assets/victorySketches/victorySketch9.png b/assets/victorySketches/victorySketch9.png
diff --git a/docs/egdd.md b/docs/egdd.md
@@ -1 +1,190 @@
-REPLACE THIS TEXT WITH YOUR EGDD MARKDOWN.
+# Boolean Bonanza
+
+## Elevator Pitch
+
+Picture a game where players dive into the exciting world of programming through interactive puzzles, focusing specifically on mastering boolean expressions, empowering learners with essential coding skills in a fun and engaging way!
+
+## Influences (Brief)
+
+- Candy Crush:
+  - Medium: Mobile Game
+  - Explanation: Candy crush is a simple match-3 puzzle game where you swap candies to match three or more of the same color. The game has similiar gameplay as candy crush.
+- Yoshi's Cookie:
+  - Medium: Game
+  - Explanation: The game will have similar gameplay to Yoshi's cookie where you have to match rows
+
+## Core Gameplay Mechanics (Brief)
+
+- Click on tiles to swap between two tiles
+- Having a row or column that has a true boolean will give you points and also delete the tiles
+- Each level has a goal that you have to reach to advance to the next stage
+- Each level gets more difficult with new boolean logic
+- If a player doesn't complete the level in a certain amount of time then they fail and have to retry
+
+# Learning Aspects
+
+## Learning Domains
+
+Introduction to boolean expressions
+
+## Target Audiences
+
+* Students studying computer science or programming at a beginner level
+* Anyone seeking to understand basic programming concepts
+
+## Target Contexts
+
+* This would be used in introductory computer science classes teaching boolean expressions
+
+## Learning Objectives
+
+*Remember, Learning Objectives are NOT simply topics. They are statements of observable behavior that a learner can do after the learning experience. You cannot observe someone "understanding" or "knowing" something.*
+
+- By the end of the lesson, players will be able to identify true or false boolean expressions
+- By the end of the lesson, players will be able to apply boolean logic to solve simple programming problems
+- By the end of the lesson, players will be able to construct boolean expressions involving logical operators AND, OR, NOT, and XOR
+
+## Prerequisite Knowledge
+
+*What do they need to know prior to trying this game?*
+
+- Players should be familiar with boolean data type
+- Players should know simple logic operators (AND, OR, NOT)
+- Players should have a basic understanding of boolean algebra
+
+## Assessment Measures
+
+A short pre-test and matching post-test should be designed to assess student learning
+
+- Given a boolean expression, identify if the expression evaluates to true or false
+- Construct a boolean expression using certain logical operators
+
+# What sets this project apart?
+
+- Unlike most games, this one is designed to specifically teach fundamental programming concepts
+- Players interact with boolean expressions through gameplay, reinforcing their understanding
+
+# Player Interaction Patterns and Modes
+
+## Player Interaction Pattern
+
+This is a one person game. The player clicks on two tiles to swap them
+
+## Player Modes
+
+- Single-player: You repeatedly advance through levels until you reach the end
+
+# Gameplay Objectives
+
+- Create true boolean expressions:
+    - Description: Complete level-specific goals by creating rows or columns of true boolean expressions. Score more points by getting more rows/columns.
+    - Alignment: Reinforces understanding of boolean expressions and operators.
+- Unlock new and more challenging levels:
+    - Description: Progress through increasingly challenging levels, introducing new boolean logic.
+    - Alignment: Provides opportunities to apply and expand knowledge of boolean concepts.
+
+
+# Procedures/Actions
+
+- Players swap tiles to create rows or columns of true boolean expressions.
+- Each level presents specific goals to achieve within a time limit.
+
+# Rules
+
+- Players can swap adjacent tiles to create matches.
+- Complete a level by getting the desired score within specified constraints like time limits or move/swap limits 
+- Different tiles represent true, false, and logical operators
+
+# Objects/Entities
+- Tiles
+- Animations/Particles
+- Music/SFX
+- Navigation Menus
+
+## Core Gameplay Mechanics (Detailed)
+
+- Swap Tiles: Players swap tiles to create rows or columns of true boolean expressions, with different tiles representing true, false, and logical operators. An animation will occur on swipe and effects will pop up when the row/column is complete.
+- Level Up: Each level presents specific goals to achieve using boolean expressions, introducing new logic and challenges. Each level is randomly generated but offers new challenges such as different boolean operators. There will be more rows and columns as the player progresses
+- Time Limit: Time limit adds urgency, encouraging quick thinking and decision-making. 
+
+
+## Feedback
+
+Short Term Feedback:
+- "Ding" noises on correct swipes
+- Score Indicator (text) showcase how well they are doing in the game
+
+Long Term Feedback:
+- Leveling System Will Indicate Long Term Progress
+- Visuals that indicate What Level You are (Progress Bar)
+
+# Story and Gameplay
+
+## Presentation of Rules
+
+- An animamtion of a cursor swapping two tiles to show how the swap tiles
+- Tutorial that shows how to make completed row/col on a small board (3x3)
+- Highlight the on-screen timer during the tutorial mode
+- Visual and audio cues indicate successful matches and progress towards level goals.
+
+## Presentation of Content
+
+- Introduce a small interactice tutorial when a new logical operator is added to the level.
+- Possible tutorial menu to relearn boolean concepts
+
+## Story (Brief)
+
+Boolean Bonanza challenges players with progressively difficult puzzles, immersing them in the world of boolean expressions. The graphics are fun similar to Candy Crush.
+
+## Storyboarding
+
+[![image1](/assets/story-img1.png "image1")](https://docs.google.com/presentation/d/1ByYG8yYKBdqLnavDl0nlWLJHGGYMCE1L/edit?usp=sharing&ouid=112997788902853184335&rtpof=true&sd=true)
+
+[![image2](/assets/story-img2.png "image2")](https://docs.google.com/presentation/d/1ByYG8yYKBdqLnavDl0nlWLJHGGYMCE1L/edit?usp=sharing&ouid=112997788902853184335&rtpof=true&sd=true)
+
+[![image3](/assets/story-img3.png "image3")](https://docs.google.com/presentation/d/1ByYG8yYKBdqLnavDl0nlWLJHGGYMCE1L/edit?usp=sharing&ouid=112997788902853184335&rtpof=true&sd=true)
+
+[![image4](/assets/story-img4.png "image4")](https://docs.google.com/presentation/d/1ByYG8yYKBdqLnavDl0nlWLJHGGYMCE1L/edit?usp=sharing&ouid=112997788902853184335&rtpof=true&sd=true)
+
+[![image5](/assets/story-img5.png "image5")](https://docs.google.com/presentation/d/1ByYG8yYKBdqLnavDl0nlWLJHGGYMCE1L/edit?usp=sharing&ouid=112997788902853184335&rtpof=true&sd=true)
+
+# Assets Needed
+
+## Aethestics
+
+- Vibrant visuals with a playful, educational atmosphere.
+- Engaging sound effects and music enhancing the gaming experience.
+
+## Graphical
+
+- Characters List
+  - No "characters"
+  - Tiles representing true, false, and logical operators
+- Textures:
+  - Playful cube textures for the tile
+  - Fun colors similar to Candy Crush
+- Environment Art/Textures:
+  - Menu graphics
+  - Level Map graphics 
+  - Background art during levels
+
+
+## Audio
+
+- Music List (Ambient sound)
+  - In Game Music: Ambient music to accompany gameplay, increases pace as time runs out
+  - Main menu music: Fun, 8-bit style music when player is in main menu/choosing a level
+
+*Game Interactions are things that trigger SFX, like character movement, hitting a spiky enemy, collecting a coin.*
+
+- Sound List (SFX)
+  - Swapping Tiles: the sound of tiles rubbing against each other
+  - Scoring Points: coin collection sound
+  - Completed Rows/Column: Mini Checkmark noise (like the duolingo sound)
+  - Clicking/Hovering over Menu Items: Short click noises for auditory feedback
+
+
+# Metadata
+
+* Template created by Austin Cory Bart <acbart@udel.edu>, Mark Sheriff, Alec Markarian, and Benjamin Stanley.
+* Version 0.0.3
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",
+    "name": "boolean-bonanza",
     "version": "4.0.0",
-    "description": "Phaser 3 Final Project",
-    "homepage": "https://github.com/UD-S24-CISC374/final-project-template#readme",
+    "description": "Boolean Bonanza Game",
+    "homepage": "https://github.com/UD-S24-CISC374/final-project-teal#readme",
     "main": "index.js",
     "scripts": {
         "start": "webpack serve --config webpack/webpack.dev.js",

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