Implemented Feature:

Basic character movement (w/a/s/d): world_system.cpp, on_key(), line 465-502

Basic collision detection (player with walls/floors): world_system.cpp, handle_collisions method, line 407-428, when the collision is detected between player and the wall, it will set the player velocity to 0, and set the position backward by 30 units with respect to the velocity direction when this collision happens.

Sprite with key element (player, security guards/camera, door, fire alarm):

player: world_system.cpp, restart_game, line 256-260, line 351 create student(player) with a given location.

fire alarm: world_system.cpp, restart_game, line 265-266, create a fire alarm in the upper right corner of the map.

door/wall: world_system.cpp, restart_game, line 268-349, a few loops are being used to create a wall conditionally. In this loop, if the space has not been used, then this space is left for doors.

security guard: world_system.cpp, restart_game, line 354, create guard with a given location

Basic level map with static walls:world_system.cpp, restart_game, line 264-349: we used square wall and for loops to create walls for rooms at all corners of the map

Camera Control (Up/Down/Left/Right): render_system.hpp, line 79, define translation matrix.

render_system.hpp, line 124-126, use translation matrix to create view

textured.vs.glsl, line 19-20, use translation matrix in texture to update view position.

World_system.cpp, onkey(), line 506-525, use up/down/left/right to control the camera.

Audio Feedback: audio file is added in data/audio, and there are 2 sound effects. fire_alarm.wav will play once the user reaches the fire alarm destination, wall_collision.wav will play once the user collides with the wall. Declaration of image file is in line 67, 68 of world_system.hpp, audio is loaded at line 113, 114 of world_system.hpp, checking for null pointer at line 116 to 122 of world_system.hpp, file data is freed in line 39-42 of world_system.hpp.

Set simple path for security guards: world_system.cpp, step, line 222-230: we set a walkTimer for the guard to change the direction of his motion for a fixed time period.

Graceful Termination: Once the user reaches the fire alarm, a text box will show up and says "You Win" to indicate termination, textbox is created at line 435 of world_system.cpp, create textbox is defined in line 127-151 of world_system.cpp. Also once the user reach destination, user won't be able to move anymore and keyboard control will be disabled, this is done by line 432-434 in world_system.cpp, line 43 in physics_system.cpp and line 460-462 of world_system.cpp. The textbox displayed come from the image in data/textures, which is loaded in line 37 of render_system.hpp

Milestone 2

sprite sheet animation: used sprite sheet to implement player and guard animation. component.cpp line 123-298: used time and direction to update sprite's current texture. component.hpp line 9-64: define character direction, and switch direction function. component.hpp line 251-302: define character's texture. Render_system.hpp line 37-89, define texture path for sprites. world_system.hpp line 263-281,639,651,663,675: switch sprite walking direction.

Playability: data/levels: Create a txt file for each level. W: wall, S: student, G: guard, T: trap, C:camera, L:light, E: Exit. world_system.cpp, showLevelContent, line 411-458, based on the current level, it will read in the corresponding txt file line by line and push the characters into a vector. It will then render each entity based on the position in the txt file.

Simple_path: ai_system.cpp, calcChaseVectorV1, line 66-129, calculate the chase vector by BFS. Until the guard reaches the player position, the guard chases the player around by following the path with shortest manhattan distance, and avoid walls if there is a wall in his neighboring position. ai_system.cpp, PosIsValid, line 15-18, return validity of an index position ai_system.cpp, Distance, line 21-24, calculate manhattan distance between points a and b ai_system.cpp, hasWallAtNeighbor, line 50-63, return true if there is a wall at the neighboring range of pos

Movement Interpolation: world_system.cpp, approach, line 889-901, for given current velocity of the entity and the goal velocity, interpolate the in-between velocities bases on time dt. Return goal velocity if the entity reaches it. world_system.cpp, on_key, line 632-680, set the goal velocity of the player instead of directly set its velocity. world_system.cpp, step, line 165-169, update the current velocity of the player and the guard.

Game logic response to user input: Added image files in data folder for buttons of each level, different image represent a locked level and unlocked level. In http://cpsc-427-dev/template/data/textures/ Textbox have a new component called Clickable, which has a it's location and the correspounding button action. In cpsc-427-dev/template/src/components.hpp line 190-204, also in cpsc-427-dev/template/src/tiny_ecs_registry.hpp 30-70, In cpsc-427-dev/template/src/world_init.cpp line 190-219, world_system.cpp line 355-361 Create new class GameState and GameLevel, GameState records a state, it's either "LEVEL_SELECTION" represent we should display the menu, "LEVEL_SELECTED" represent we shuold display the selected level, "TUTORIAL_PAGE" represent we should display the tutorial page. Each GameState stores the current state and stores an reference to the GameLevel. Game_state.hpp and game_state.cpp. New listener redirect for mouse clicks, when user clicks a the mouse, we check if it's clicking on a specific button. In world_system.cpp line 500-573, handle_collision function And the handler for the event will check the button's action and change the program state. In world_system.cpp, line 758-888.

Basic user tutorial/help:

• Shiyu: Create button for tutorial on the menu. In http://cpsc-427-dev/template/data/textures/ Create button handler for tutorail, create key handler to get back to main menu from tutorial page, world_system.cpp line 355-361, line 461-463, line 591-600
• Jingyang: Drawed tutorial image

Reloadability: New file added in data folder, /data/game_text_file/unlockedLevel.txt, which stores an integer represent the current number of level unlocked by the user Reload and Save of game state is called i game_state.cpp line1 to the end of file

Game Logic: New NPC character that will have conversation with the user, In cpsc-427-dev/template/src/world_init.cpp line 276 - 306, createNPC for character 'N' on the map in world_system.cpp line 441 New conversation component in components.hpp line 208-216 Conversation component has its own state, as a decision tree in conversation_state.hpp, the entire file. New image for NPC and conversation added in template/data/textures/ User talk to the NPC on collision: handleder in world_system.cpp line 535-548 User interact with NPC with key event in world_system.cpp on_key line 586-603

Asset:

• Trap: World_init.cpp line 221-247: Implement createTrap function to create a new trap with the given position World_system.cpp line 428, based on the design in level.txt file to create traps World_system.cpp line 546-547, handle the collision between the player and the trap. It will show the sound, remove that trap, emplace the player into trappable component so that it will result in the guard chases the player, which trigger the current step function code in AISystem.cpp

• Security Camera: additional enemy. Player will die if player get scan by camera light. World_init.cpp line 133-190: Initialize camera and light entities World_system.cpp line 445-450: Add camera and light to the background Physics_system.cpp line 43-45: Change the direction of the light once after a while

Milestone 3

Project restructure (src/GameLevel):

restructure the project to distinguish the different use of the system in different functional pages (cover page, level selection page, game page, and tutorial page). Moved some key functions such as onKey() and step() for each functional page to its own class to enhance cohesion in the code design. Also introduced a new GameState class to control and keep track of the current level and current progress in the game.

Camera control (following player):

LevelManager.cpp line 112: reset camera matrix Levelplay.cpp Line 223-225, update camera translation matrix according to player’s current position and window width and height in each step.

Cover movie:

LevelCover.cpp entire file: create cover movie and press any key to continue to level selection LevelManager.cpp line 19-21 load cover music LevelManager.cpp line 42 call the constructor of cover

Sandglass:

It’s a new game item. When the player “collides” with the sandglass, it will pick up this item, which will show in the item box. To use this item, click it in the item box. When sandglass is used, it will stop all the enemy(i.e guards and cameras) for 5 seconds. LevelPlay.cpp, line 845, create sandglass LevelPlay.cpp, line 235, 259, when the player picks up the item, the item will be added into the item box. LevelPlay.cpp, inside onMouseButton function, line 479-483, when the user uses mouse to left click the sandglass item, it triggers the if_clicked_sandglass_button function. LevelPlay.cpp line 676~732 if_clicked_sandglass_button function. This is called when the sandglass item is being clicked. We will have a 5s timer and we will have a callback function. During this 5 seconds, all guards and cameras motion will be setted 0. After 5 seconds, their motion will go back to their original motion before the sandglass effect.

Hammer:

New game item(Tool), When the player "collide" with the hammer, it will pick up the hammer and store the hammer in the player's item box. When player want to use the hammer, player can drag the hammer onto the wall the player want to break, and release on the wall to break the wall. GameLevel/LevelPlay.cpp line 916: create hammer in the map, using character "3" GameLevel/LevelPlay.cpp line 396 OnMouseButton function: in line 418-472, we check if any hammer is hovered and check the break the wall in vector shouldBreakWall. If user clicked on hammer we store the hammer in hoverHammer in line 491-495, and track position hammer to break surrounding walls In GameLevel/LevelPlay.cpp line 387-394, we track the movement of the mouse World_init.cpp line 459-494: include physical based particle animation when the user break the wall with a hammer

Mouse Gesture:

Tracker hammer action while the user dragging hammer and menu button selection. Mouse movement is tracked by OnMouseMove function in LevelPlay.cpp line 387-394 to update hammer's position Mouse button click is tracked by OnMouseButton function in LevelSelection.cpp line 60-93

Remote Control:

new item, turns off all security cameras for 5 seconds GameLevel/LevelPlay.cpp line 396 OnMouseButton function: line 485~489 check if user selected remote control from item box GameLevel/LevelPlay.cpp line 734 if_clicked_remote_control_button function: if remote control is selected, shuts off camera by removing all light entities. After 5 seconds, reload the level map and recreate all light entities via callback.

Security Camera:

additional enemy. Player will die if the player gets scanned by camera light. World_init.cpp line 136-206: Add three new directions when initializing camera and light World_system.cpp line 95-110: Update light collision justification algorithm

Full screen toggle:

use f key to toggle between full screen mode and window mode World_system.cpp line 157-167: Add key control for toggling into and out of full screen

Milestone 4

implemented features:

Minimap: It now shows the minimap of the current level on the top-left of the screen. Only the player and the walls are shown with other parts hidden. Render_system.cpp line 284-388 rendering of the minimap which only includes the wall and the position of the player. All other identities are hidden to make the game more interactive.

Point system:

• record and display the number of test papers collected in each level.
• Game_state.cpp line 105-138: Add read and write to files recording points in each level
• highestPoint1.txt - highestPoint6.txt: Add text files to store highest point of each level
• LevelPlay.cpp line 627-638, 664-667, 914-916: Add point update in files and display in the game window
• World_init.cpp line 254-396: Add entities (digits, text message, …) for point display ui

External Library:

• I used nlohmann/json library to save user's Motion component and current state of program in a json file
• Entry point is in game_state.cpp, to save we use the function saveGameState on line 117, to load we use the function loadGameState on line 149
• To change Motion into json form, I created 2 new functions in components.hpp, 1 called to_json (from object to json) and another called from_json (from json to object)

Wind particle system with physics:

• Added a particle picture “wind_particle.png” to texture
• LevelPlay.cpp: step() (starting from line 65) called UpdateWindParticle() (starting from line 953), calculation wind particles’ life cycle, remove dead particles, and add new born particles.
• LevelPlay::Restart() (starting from line 1012), added symbols ^, <, >, v to indicate the wind particle effect with direction in generating game elements. component.hpp: added three component, Wind, WindParticle and Explode. Wind has direction and particle number count, while WindParticle knows about parent wind. Exploded is used for exploding and calculate wind particle’s life system.
• component.cpp: added some useful function for wind:
• WindParticle::WindParticle, to create new wind particle
• bool WindParticle::IsAlive, to determine if a particle is still alive
• vec2 WindParticle::GetPos, get current particle position since particle is always moving.
• bool Wind::InRange, to determine if a object(player/guard) is in the effective range of wind
• void Wind::Influence, use physics to influence an in range object’s motion.
• Direction Wind::GetWindDirByChar, char Wind::GetWindDirChar, to convert the direction of wind with ^,<,>,v symbol.
• Physicsystem.cpp: step() (starting around line 62): calculate particle’s life cycle and remove dead particles and update player’s motion if affected by wind.
• world_init.cpp: added createExplodeds(), createWind(), createWindParticle() to create new entities.
• tiny_ecs_registry.hpp added three new component, wind, exploded, wind, windParticle

View Mask:

• Render_system.hpp line 185 and line 186, add variables bool useMask and vec2 playerPos
• LevelPlay.cpp, line 239, update playerPos in the step function so that it can be used in the render system class. Line 1143, inside the restart function, initialize the useMask value to be true. Otherwise, in levelSelection, it will be false.
• Render_system.cpp line 80 - line 106, use useMask as the conditional variable to apply the view mask effect. Pass the player location, dark radius, light radius to the textured shader.
• Texture.fs.glsl, the textured shader, render the view mask effect. So, if the fragment is within the light radius, render normally. Else if the fragment is outside the dark radius, render it to be dark. If the fragment is between light radius and dark radius, render the color from light to dark gradually.

Bee Item:

• summon a swarm of bees to trap the guard
• GameLevel/LevelPlay.cpp OnMouseButton function: line 514-518 check if user selected bee from item box
• GameLevel/LevelPlay.cpp if_clicked_bee_button function: line 869-928: create a swarm of bees, flying towards the guard’s position, set the guard’s velocity to 0, and restores its velocity when time is up.
• World_init.cpp, createBee function: line 323-351: create a bee entity
• Components.hpp, line 362-383: add the bee component
• Components.cpp, line 532-614: added functions for getting/setting state of the bees
• GetState function, line 547-568: get the current state of the bee: should it go toward the guard, stay or leave
• ModifyMotion function, line 570-609: change the bee’s motion based on its current state, as long as its alive.
• IsAlive function, line 611-614: return true if bee is alive (if the times ince the item is activated is less than the sum of times it flies toward the guard, traps the guard and leaves)
• Tiny_ecs_registry.hpp: add bee component to the registry

User Experience Feedback and Actions Feedback:

• A minimap are suggested by many users to improve user experience and get a overview of the game map.
• User feedback on the navigation: previously the camera control uses the arrow key and moving the player uses wasd key, player feel thats a bit odd and hard to control the camera view.

Action:

• we added a minimap feature in the game play and players now can view the map structure and current location in the map on the top left corner
• we merge the camera control and player movement all to wasd key and now camera follows the player’s location and movement