UD-S24-CISC374 · jhcooper · Mar 19, 2024 · Mar 19, 2024 · Mar 19, 2024 · Mar 19, 2024
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
-REPLACE THIS WITH A DESCRIPTION OF YOUR GAME (in the README.md file).
+# Cyber Spy - Learn to Hack, Hack to Learn
+
+Welcome to *Cyber Spy*, an educational puzzle adventure that immerses you in the thrilling world of cyber espionage while teaching you the fundamentals of bash commands and terminal navigation. Designed for incoming freshmen pursuing a computer science degree or anyone eager to master the command line, this game combines a compelling narrative with engaging gameplay to make learning an exhilarating experience.
+
+## About Cyber Spy
+
+In *Cyber Spy*, players step into the shoes of a hacker, accompanied by a trusty companion, Alfred, on a mission to dismantle a corrupt organization. Through a series of time-sensitive missions, players will navigate through a terminal interface, employing basic to advanced bash commands to infiltrate enemy facilities, gather intelligence, and thwart the organization's nefarious plans.
+
+Inspired by the engaging puzzles of *Hacknet*, the adventurous spirit of *Super Mario World*, and the thrilling espionage of *Mission Impossible*, *Cyber Spy* offers a unique educational experience that teaches as it entertains.
diff --git a/assets/.DS_Store b/assets/.DS_Store
diff --git a/assets/AlfredDeathMusic.mp3 b/assets/AlfredDeathMusic.mp3
diff --git a/assets/AlfredIcon.png b/assets/AlfredIcon.png
diff --git a/assets/ClosedBook.png b/assets/ClosedBook.png
diff --git a/assets/CyberSpyTitleScreen.png b/assets/CyberSpyTitleScreen.png
diff --git a/assets/HoveredBook.png b/assets/HoveredBook.png
diff --git a/assets/Level1Background.png b/assets/Level1Background.png
diff --git a/assets/LevelSelectBackground.png b/assets/LevelSelectBackground.png
diff --git a/assets/OpenBook.png b/assets/OpenBook.png
diff --git a/assets/PinPadText.png b/assets/PinPadText.png
diff --git a/assets/PromptBox.png b/assets/PromptBox.png
diff --git a/assets/SpyIcon.png b/assets/SpyIcon.png
diff --git a/assets/Storyboard.jpg b/assets/Storyboard.jpg
diff --git a/assets/alfred.png b/assets/alfred.png
diff --git a/assets/arrow.png b/assets/arrow.png
diff --git a/assets/backwardsDoor.png b/assets/backwardsDoor.png
diff --git a/assets/bomb.png b/assets/bomb.png
diff --git a/assets/cdBackDing.mp3 b/assets/cdBackDing.mp3
diff --git a/assets/cdDing.mp3 b/assets/cdDing.mp3
diff --git a/assets/closed_metal_door.png b/assets/closed_metal_door.png
diff --git a/assets/ding.mp3 b/assets/ding.mp3
diff --git a/assets/dude.png b/assets/dude.png
diff --git a/assets/dudes.png b/assets/dudes.png
diff --git a/assets/dudes1.png b/assets/dudes1.png
diff --git a/assets/evil.jpg b/assets/evil.jpg
diff --git a/assets/fonts/JetBrains.ttf b/assets/fonts/JetBrains.ttf
diff --git a/assets/forest.jpg b/assets/forest.jpg
diff --git a/assets/img/phaser-logo.png b/assets/img/phaser-logo.png
diff --git a/assets/lasdfsa.mp3 b/assets/lasdfsa.mp3
diff --git a/assets/lockedDoor.png b/assets/lockedDoor.png
diff --git a/assets/lsDing.mp3 b/assets/lsDing.mp3
diff --git a/assets/manDing.mp3 b/assets/manDing.mp3
diff --git a/assets/matrix.png b/assets/matrix.png
diff --git a/assets/menuMusic.mp3 b/assets/menuMusic.mp3
diff --git a/assets/metalDoor.png b/assets/metalDoor.png
diff --git a/assets/num0.png b/assets/num0.png
diff --git a/assets/num1.png b/assets/num1.png
diff --git a/assets/num2.png b/assets/num2.png
diff --git a/assets/num3.png b/assets/num3.png
diff --git a/assets/num4.png b/assets/num4.png
diff --git a/assets/num5.png b/assets/num5.png
diff --git a/assets/num6.png b/assets/num6.png
diff --git a/assets/num7.png b/assets/num7.png
diff --git a/assets/num8.png b/assets/num8.png
diff --git a/assets/num9.png b/assets/num9.png
diff --git a/assets/open_metal_door.png b/assets/open_metal_door.png
diff --git a/assets/padCheck.png b/assets/padCheck.png
diff --git a/assets/padx.png b/assets/padx.png
diff --git a/assets/pin.png b/assets/pin.png
diff --git a/assets/platform.png b/assets/platform.png
diff --git a/assets/radar.gif b/assets/radar.gif
diff --git a/assets/shield.png b/assets/shield.png
diff --git a/assets/sky.png b/assets/sky.png
diff --git a/assets/space.png b/assets/space.png
diff --git a/assets/star.png b/assets/star.png
diff --git a/assets/styles.css b/assets/styles.css
@@ -0,0 +1,8 @@
+@font-face {
+    font-family: "jetbrains";
+    src: url("/assets/fonts/JetBrains.ttf") format("truetype");
+}
+
+body {
+    font-family: "jetbrains";
+}
diff --git a/assets/wallDoor.png b/assets/wallDoor.png
diff --git a/docs/egdd.md b/docs/egdd.md
@@ -1 +1,185 @@
-REPLACE THIS TEXT WITH YOUR EGDD MARKDOWN.
+# Cyber Spy
+
+## Elevator Pitch
+
+Cyber Spy is an educational puzzle game with a dramatic storyline attached. Cyber Spy will introduce players to basic bash commands through a time based environment. The story follows a hacker, and his companion Alfred, through several missions to dethrone a corrupt organization. Players should be able to traverse through the terminal efficiently with the knowledge gained after completing this game.
+
+## Influences (Brief)
+
+- Super Mario World:
+  - Medium: Game
+  - Explanation: *We plan to mimic the style of super mario world and the pixel art. The movement in between levels will resemble the movement of a platformer like mario*
+- Hacknet (https://en.wikipedia.org/wiki/Hacknet):
+  - Medium: Game
+  - Explanation: Much like our planned game, Hacknet is a hacking-based puzzle game in which the majority of gameplay comes in the form of typing commands in a Unix-like terminal. The main goal in Hacknet is to ‘hack’ into other computer systems, steal imaginary files, and acquire superuser privileges. It incorporates gameplay aspects like memory management (you can only run a certain amount of programs before you run out of memory) and a timer later on in the game to make doing so more difficult. We plan on taking inspiration from the terminal design, as well as aspects like the timer.
+- Mission Impossible
+  - Medium: Movie
+  - Explanation: We plan on creating a mission based game where the user must break into a facility (directory) using terminal commands. There will also be a time constraint. There will also be a butler/narrator character, much like the tech team in Mission impossible, that will guide you through your mission, providing hints and instructions as needed.
+
+## Core Gameplay Mechanics (Brief)
+
+- Typing commands into terminal to perform actions
+- 2D Navigation Throughout the facility
+- Item Collection within your inventory
+- Display success screen after completing a mission
+- Display defeat screen after failing a mission
+
+# Learning Aspects
+
+## Learning Domains
+
+Introduction Systems Programming
+Machine Organization and Assembly Language
+Introduction to Software Engineering
+
+## Target Audiences
+
+Incoming freshmen in college pursuing a computer science degree. Specifically students learning how to use bash commands.
+
+## Target Contexts
+
+This could be used as an introductory assignment for CISC210. Students looking to practice their skills in the terminal can also play this game in their free time.
+
+## Learning Objectives
+
+After playing Cyber Spy, students should be able to traverse the terminal using the command line efficiently.
+
+- By the end of the game, students should be able to access files using terminal commands
+- By the end of the game, students should be able to modify the contents a file using basic nano commands
+- By the end of the game, students should be able to navigate through different directories
+- By the end of the game, students should be able to move/remove files across different directories using terminal commands.
+- By the end of the game, students should be able to create and write to new directories and files.
+
+## Prerequisite Knowledge
+
+- Players should know how to type a minimum of 30 wpm
+- Players should know that commands can cause their computer to perform actions
+
+## Assessment Measures
+
+A short pre-test, and matching post-test.
+
+Given a directory name, utilize bash commands to access it.
+Given a file name, utilize bash commands to delete it.
+Given a file and directory name, utilize bash commands to move it to another given directory.
+
+# What sets this project apart?
+
+- Most coding assessments that introduce students to the terminal don't intend to be entertaining, but our game will have fun graphics, an engaging story, and thrilling gameplay.
+- The game will be educational yet still have aspects of a fun video game integrated seamlessly into it.
+
+# Player Interaction Patterns and Modes
+
+## Player Interaction Pattern
+
+This is a single player game. The player will interact with the via typing keyboard inputs, moving with arrows, and clicking on menu buttons when needed.
+
+## Player Modes
+
+- Single-player: You repeatedly complete missions to advance through the story.
+
+# Gameplay Objectives
+
+- Reach the end of the mission:
+    - Description: Do what the prompt at the top of the screen requests
+    - Alignment: This aligns with our learning objective because it forces players to hone the skills they've learned and will help them memorize commands after repeated use.
+- Complete all missions to finish the game:
+    - Description: Traverse through each mission by accomplishing their respective goals
+    - Alignment: Each mission will establish a new topic for the player to learn. Each topic will build upon each other, and by the end players will know what each command does and when to use them.
+
+# Procedures/Actions
+
+You can type when a command line is shown, and enter these commands. In between missions you can move around using arrow keys, and press a button to start mission.
+
+# Rules
+
+- If the player enters an invalid command, they will get an error and hint
+- If the player enters a valid command, it will work and they will advance through the current mission
+- They will have a toolset of commands available to them to reference and utilize
+- The list of commands that they will learn through the missions are as follows:
+ls
+cd
+rm
+touch
+cat
+mv
+cp
+
+# Objects/Entities
+
+- There is a text input for users to type into
+- There is a command line that user input is displayed when entered
+- There is a prompt
+- There is a main character to control in between missions
+- There is a companion character that will speak to you during missions
+- There is a timer during missions
+
+## Core Gameplay Mechanics (Detailed)
+
+- Typing commands into your “terminal”*: *The majority of game interaction will take place by the player typing commands into their terminal. Assuming the user types the correct command sequence, they will be moved to their next task. The player will initially start with a limited number of basic commands such as ‘ls’, then as they progress further, unlock new commands through their companion. E.g., “use ‘cd’ to access a new directory, or in this case your backpack, with ‘cd backpack’”.
+- Picking up tools*: *A large part of the education in Cyber Spy will take place because of an increase in difficulty as a player progresses through levels. This increase will be due to the player picking up tools along the way in the form of new commands. Some of these commands will be highlighted/vibrating in levels for the player to collect, while others will be transferred directly to the players backpack via their companion. It is then up to the player to decide when the right time to use a given tool is.
+- Navigation through 2D levels*: *The high-level goal of this game is to navigate your player sprite through several rooms of an advanced technology facility and destroy the internal corruption taking place there. You will navigate your player using terminal commands, and with the help of your companion to explain what new tools do as you collect them.
+
+
+## Feedback
+
+If a command is wrong, your companion will tell you it is wrong and give you a hint in the right direction. Text on the screen shows if a command worked or did not work. 
+
+# Story and Gameplay
+
+## Presentation of Rules
+
+Players have a virtual assistant like Alfred is to Batman. Alfred will introduce your mission, tasks, and give you your tools (ls, cd, touch, etc.) as they become needed.
+
+## Presentation of Content
+
+Players will slowly be given tools as mentioned before, and expected to use them at least one time before being given a different tool by alfred, e.g. Alfred: “You’re gonna need a wrench to break that glass. Use 'ls' to view your backpack items, including the wrench I just gave you.”
+
+## Story (Brief)
+
+Our story will follow a hacker and his trusty companion through a series of missions to dethrone a corrupt organization. They will do this using a variety of commands to access the opposition's files, and take down their servers. All while attempting to be stealthy and quick enough to finish these missions before the time runs out. Will your coding abilities be able to save the world? Or will you fold under pressure? Who can be trusted? Cyber Spy will answer all of your questions.
+
+## Storyboarding
+![alttext](../assets/Storyboard.jpg)
+
+# Assets Needed
+
+## Aethestics
+
+This game should feel high pressure, but rewarding. It should encourage players to code fast and also avoid mistakes. The aesthetics of the game will be dark, dramatic, and retro.
+
+## Graphical
+
+- Characters List
+  - Agent User
+  - Companion (Woz/Alfred)
+- Textures:
+  - Level entrances
+- Environment Art/Textures:
+  - Coding background
+  - Level select background
+  - Unique backgrounds for special directories
+
+
+## Audio
+
+- Music List (Ambient sound)
+  - General gameplay: 8 bit, eerie stealth music like the music from Batman Begins GBA: https://www.youtube.com/watch?v=MIppc7zfqis&list=PLO4jlmGoc6uAy9S9J3SPXv-UrHBm9Bgz9&index=2
+  - General gameplay: 8 bit, action music like the music from Batman Begins GBA:
+https://www.youtube.com/watch?v=Px-bsXoXdhc&list=PLO4jlmGoc6uAy9S9J3SPXv-UrHBm9Bgz9&index=1
+
+*Game Interactions are things that trigger SFX, like character movement, hitting a spiky enemy, collecting a coin.*
+
+- Sound List (SFX)
+  - Entering a line of code: pleasant ping noise found online
+  - Typing sounds: recorded by us or found on YouTube
+  - Error: Buzz/dud sound
+  - Dialogue: digital noises made to queue while speaking occurs, but all dialogue will be text written on the screen
+
+
+# Metadata
+
+* Template created by Austin Cory Bart <[email protected]>, Mark Sheriff, Alec Markarian, and Benjamin Stanley.
+* Version 0.0.3
+
+