Fall2020_CSC403_Project

Features

Animations and Music

• Starting the game displays a loading screen.
• The welcome screen displays gif animations and plays music.

Leaderboard

• Fastest times are kept on a leaderboard which can be displayed from the welcome screen.

Respawning

• After defeating an enemy it will respawn, stronger than before.

Boss Fight

• After winning a certain amount of battles, you get to fight a boss to lock in your final time.

Inventory

• Mr. Peanut has the ability to pick up loot from enemies he has fought against. The inventory allows Mr. Peanut to pick up three items that can increase health, melee damage, and magic damage.

Skills

• Mr. Peanut has different skills which he can train to a higher level (Melee/Ranged/Magic).
• Higher levels equate to more damage dealt by a certain skill.

Items

• Enemies drop items which can be equipped to enhance skills.
• Item inventory can be opened with "i".

Sneaking

• Enemies have an awareness effect. Sneaking helps you get the jump on them.

Controls

• Arrow Keys - Move
• i - Open Inventory
• k - Crouch
• j - Uncrouch

How to start?

1. Clone.
2. Open .sln in Visual Studio 2019+.
3. Click Build -> Build Solution.
4. Output .exe and partnering .dll will be in <ProjectPath>/Fall2020_CSC403_Project/Project/Fall2020_CSC403_Project/bin/Debug/.
5. All resources will be packed into the .exe for portability.

Known Bugs

• If the player stands where the enemy dies and the enemy respawns, The FrmBattle.cs Form continously opens.

File Structure

Fall2020_CSC403_Project

Forms and resources.

FrmBattle.cs

• Class FrmBattle
  • Method
    • btnAttack_Click - added increases playerScore by 1 if enemy is defeated.

FrmInventory.cs

• Class FrmInventory
  • Properties
    • SelectedItem - The item the player has selected from the inventory.
    • Player - The instance of the player who opened the inventory.
  • Methods
    • button1Cclick - Equips the item selected by the user and upgrades one of the stats based on the selected item.
    • health_Click - Selects the health item in the inventory.
    • magic_Click - Selects the magic item in the inventory.
    • melee_Click - Selects the melee item in the inventory.
    • AddLoot - Adds the loot to the inventory.
    • OnFormClosing - Overwrites the original OnFormClosing methods and prevents it from closing the inventory

FrmLevel.cs

• Class FrmLevel
  • Properties
    • FrmInventory - The player's inventory
    • close - Boolean for checking if the user has opened the inventory
    • spawn - Boolean to see if boss is spawned
    • once - Boolean to only spawn boss once
    • fTime - Calculates final time
  • Method
    • Open - Opens the inventory for the player
    • CheetoLoot_Click - Adds the health item to the inventory
    • KoolLoot_Click - Adds the melee item to the inventory
    • FinalBossLoot_Click - Adds the magic item to the inventory
    • health_update_Tick - Displays the health of the player
    • melee_update_Tick - Displays the melee damage of the player
    • ranged_update_Tick - Displays the ranged damage of the player
    • magic_update_Tick - Displays the magic damage of the player
    • tmrDisplayBoss_Tick - Checks every game tick if player reached score for boss to appear. if player wins, passes the final time to the VictoryScreen Form. If player loses then displays GameOver Form.
    • inGameScore_update_Tick - displays and updates player's current score.

GameInstructions.cs

• Class GameInstructions
  • Method
    • Confirm_click - Closes GameInstructions Form upon pressing button.\

GameOver.cs

• Class GameOver
  • Method
    • gameOver_click - Closes all forms upon pressing Quit Game button.

IntroAnnimation.cs

• class IntroAnnimation
  • Properties
    • SoundPlayer - IntroAnnimation music
  • Methods
    • timer1_tick - Increases progressbar of increments of 2
    • IntroAnnimation_Load - Begins timer for progress bar
    • OnFormClosed - Stops intro annimation music

WelcomeScreen.cs

• class WelcomeScreen
  • Properties
    • mysound - variable containg .wav file for epic music
    • opened - bool to check if form is closed or not
    • Anim - IntroAnnimation form
    • lb - Leaderboard form
  • Methods
    • WelcomeScreen_Load - Plays epic music
    • leaderboardButton_Click - Opens the leaderboard form
    • playButton_Click - Opens GameInstructions and game
    • quitButton_Click - Quits application
    • OnFormClosed - Closes all the forms

Leaderboard.cs

• class Leaderboard
  • Methods
    • Leaderboard_Load - Finds the top 3 scores in the score.txt file
    • back_Click - Returns to WelcomeScreen

VictoryScreen.cs

• Class VictoryScreen
  • Properties
    • t - TimeSpan variable that is set to the final time.
  • Method
    • displayTime_Tick - Retrieves the final time spent on the FrmLevel and displays it on VictoryScreen Form.
    • gameQuit_Click - When the gameQuit button is clicked it closes all Forms.

MyGameLibrary

Library of character and item information.

BattleCharacter.cs

• class BattleCharacter
  • Properties
    • Health - Current health of the character. Wraps over Skill class object.
    • MaxHealth - Max health of the character. Wraps over Skill class object.
    • Skills - Dictionary of character Skill objects.
  • Methods
    • BattleCharacter - Skills are initialized to a default.
    • Damage - Damage character, die if necessary.
    • Heal - Heal character a certain amount.
    • FullyHeal - Fully heal character.
    • GetHealth - Get current character health.
    • AddSkill - Add a skill type to the Skills dictionary.
    • HighestSkillLevel - Get the highest skill level of character.
    • AttackStrength - Get the highest possible hit for a character's skill type.
    • SetSkill - Unused; sets a skill's level.
    • EquipmentBonus - Virtual, unused; get's the item bonus for a character's skill type.
    • Die - Virtual; Death mechanics.

Character.cs

• Class Character
  • Properties
    • playerScore - Keeps track of score points earned after defeating a enemy.

Collider.cs

• Class Collider
  • Methods
    • noticeRadius - Get collider position's notice radius.
    • notices - Detects if this collider position notices a player.

Defs.cs

• Enums
  • EnemyType - Types of enemy classes.
  • AttackType - Types of attack methods.
• class Defs
  • Properties
    • SKILL_MELEE - "Melee"
    • SKILL_RANGED - "Ranged"
    • SKILL_MAGIC - "Magic"
    • SKILL_HP - "Health"
    • RESPAWN_TIME - 10.0
  • Methods
    • AttackTypeToString - static; converts AttackType enum into SKILL_* value.
• class Helpers
  • Properties
    • _r - Random number generator.
  • Methods
    • Random - Get pre-seeded random number.

Enemy.cs

• class Enemy
  • Properties
    • Respawner - Reference to enemy's respawner object.
  • Methods
    • Enemy - Set enemy type and randomize skills and max health.
    • Die - Die and handle respawner.

Game.cs

• No new methods or properties added

Item.cs

• class Item
  • Properties
    • Img - The image of the item
    • Type - Type of the item
  • Methods
    • Item - Initializes the item

NPC.cs

• No new methods or properties added

Player.cs

• class Player
  • Properties
    • noticeThreshold - Player notice threshold.
  • Methods
    • addItemToInventory - Add an item to the player's inventory.
    • removeItemToInventory - Remove an item to the player's inventory.
    • EquipmentBonus - Virtual and unused; get's the item bonus for a character's skill type.
    • GainExperience - Gain experience in a certain skill.
    • useItemFromInventory - Use an item in the player's inventory.
    • sneak - Begin sneaking.

Respawner.cs

• class Respawner
  • Properties
    • RespawnTime - Delta time for detecting respawning.
    • Position - Position of the respawner.
    • Enemy - Enemy assigned to this respawner.
    • Collider - Collider for the respawner; moved from Enemy class to here.
    • PictureBox - PictureBox of the respawner.
    • Color - Color of the PictureBox.
    • IsActive - Detects if the respawner can be collided with.
  • Methods
    • Respawner - Initializes enemy and collider.
    • SetRespawn - Hide picture and disable collisions.
    • Respawn - Reenable picture visibility and collisions.
    • Update - Check and see if it is time to respawn enemy.
    • SetColor - Set enemy's picture color.

Skill.cs

• class Skill
  • Properties
    • Name - Name of the skill
    • Level - Current skill base level.
    • CurrentLevel - Currently set skill level.
    • MaxLevel - Maximum possible level of a skill (99).
    • Experience - Current experience this skill has.
    • MaxExperience - Experience needed to level up a skill to the next level.
    • Bonus - Item bonus.
  • Methods
    • Skill - Construct a skill object.
    • CalcExp - Static; calculates the experience needed to set for a required level.
    • AddExperience - Add experience to a skill, leveling up if necessary.
    • LevelUp - Level up a skill.
    • SetLevel - Manually set a skill's level.
    • SetCurrentLevel - set the current level of a skill, used for Health.

Vector2.cs

• No new methods or properties added

Contributing

Please open a Pull Request with documented features.