Skip to content

Commit

Permalink
Add basic documentation (#54)
Browse files Browse the repository at this point in the history
This adds basic documentation.
  • Loading branch information
Ronit-j authored Oct 19, 2022
1 parent 27bc6a8 commit 9df5ddd
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Analytics/Design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Analytics

## Methodology

![Letter Hunt](./../Misc/data/Analytics_Design.png)

### Step 1 - UnityWebRequest
Collect data during the game. When the player dies / level ends, send the data using a UnityWebRequest API’s POST request to MongoDB Realm endpoint.

### Step 2 - MongoDB Realm App Service
Create an App Service function to serve an end-point (this service has access to the Atlas cluster created to store the data). The function gets the data from the received request, creates an object, and sends it to the MongoDB Atlas cluster.





### Step 3 - MongoDB Atlas
This cluster stores the data received from the App Service function.

### Step 4 - Python Matplotlib
The data is exported as a JSON or CSV file. The Python Matplotlib package is used to generate charts and to analyze the data. The packages like Numpy, Pandas, etc are used to support this process.
Binary file added Misc/data/Analytics_Design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/data/FinalPrototype.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/data/L_tterH_nt-logos.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Letter Hunt
![Letter Hunt](./Misc/data/L_tterH_nt-logos.jpeg)

Collect characters with strategy while avoiding enemies.

![Final Protoype](./Misc/data/Finalprototype.png)

## Youtube Tutorial Video: https://youtu.be/6dwwZVI5uX4

## Try the game here: https://play.unity.com/p/letterhuntbuild/edit

### Game Introduction
#### 1.1 Idea
A platformer spelling game with enemies and power-ups.
#### 1.2 Game Element
A set of letters placed on the map to be collected to form the word.
Shooting weapon with appropriate ammunition.
Power-ups
Enemies
#### 1.3 General Description
The game involves collecting the letters displayed around on the map/arena that helps form the word required to pass the current level within the given amount of time. You will have a weapon and appropriate ammunition and will also have to ensure you don't get killed by the enemies present. The game starts with the player requiring to form a 3 letter word and the level of complexity increases as the game progresses. There are various power-ups provided so as to make the levels more interesting for the player. Each level needs to be completed with a certain strategy in mind so as to come out victorious.
#### 1.4 Goal
Successfully form the word required for that level without getting killed in the given time limit. Once all the levels are cleared, you complete the game, which means, You Won!



## Game Mechanics:
The player can move on the screen using WASD or the arrow keys. The player can jump using the up arrow or W key.
The player can also shoot using the spacebar and aim using the mouse.
Letters are randomly generated throughout the level. The main goal is to move around the screen and collect letters to form the target word.
While doing this, enemies will follow the player. The player is responsible for avoiding the enemies. Each contact with the enemy reduces the health of the player.
The player can shoot and kill the enemies.
The game also has 3 power ups that are spawned randomly throughout the level-

### Highlight Letters

This powerup highlights the correct letters for a few seconds. This can help the player to locate the right letters to form the target word.


### Destroy enemies

This powerup kills all the enemies on the screen at that moment. This gives the player a few seconds to freely collect the letters without worrying about the enemies.


### Increase time

This powerup adds 5 seconds to the level.

The level will end under the following conditions -
The player is able to guess the right target word. In this situation the player will move to the next level.
The player runs out of time
The player completely exhausts his health and dies.

0 comments on commit 9df5ddd

Please sign in to comment.