Project 1

README.md

@@ -1,96 +1,141 @@
-# Project Name (Start editing here)
 <!---
 Read Me Contents
 -->
 
-# ![](https://ga-dash.s3.amazonaws.com/production/assets/logo-9f88ae6c9c3871690e33280fcf557f33.png) Project #1: The Game
+# <img src="/assets/images/game.png" height ="50"> Project #1: Follow the pattern
 
-### Overview
+### Brief summary of the game :
 
-Let's start out with something fun - **a game!**
+A simple game which goal is for player to repeat the pattern showed by the ‘instructor’.
+With each round a new step is added to the pattern making, the game much more difficult with every round. Player with the fastest correct sequence and points will win.
 
-Everyone will get a chance to **be creative**, and work through some really **tough programming challenges** – since you've already gotten your feet wet with Tic Tac Toe, it's up to you to come up with a fun and interesting game to build.
+## Game logic
 
-**You will be working individually for this project**, but we'll be guiding you along the process and helping as you go. Show us what you've got!
+![](/assets/images/flowchart2.png)
 
+Updated the game logic from having two players to take turns to follow the sequence and having timer as the win condition to two players representing different keys competing on who finishes the sequence first. The faster player scores a point and the player with the higher points after 5 rounds will win.
+## Finished product
 
----
+![](/assets/images/finishedproduct.png)
 
-### Technical Requirements
+#### Play it here! : https://cqdotcom.github.io/project-1/
 
-Your app must:
+### How to win / How to play?
 
-* **Render a game in the browser**
-* **Any number of players** will be okay, switch turns will be great 
-* **Design logic for winning** & **visually display which player won**
-* **Include separate HTML / CSS / JavaScript files**
-* Stick with **KISS (Keep It Simple Stupid)** and **DRY (Don't Repeat Yourself)** principles
-* Use **Javascript** for **DOM manipulation**, jQuery is not compulsory
-* **Deploy your game online**, where the rest of the world can access it
-* Use **semantic markup** for HTML and CSS (adhere to best practices)
-* **No canvas** project will be accepted, only HTML5 + CSS3 + JS please
+1. 5 seconds timer will start upon player clicking the start button
 
----
+2. Player 1 will use the '1,2,3,4' keys to follow the pattern '1,2,3,4' whereas Player 2 will use the 'left,up,right,down' keys for the '1,2,3,4' pattern for extra challenge.
 
-### Necessary Deliverables
+3. Follow the pattern from the numbers below or the dance instructor's move. Key input starts as soon as the timer is up.
 
-* A **working game, built by you**, hosted somewhere on the internet
-* A **link to your hosted working game** in the URL section of your GitHub repo
-* A **git repository hosted on GitHub**, with a link to your hosted game, and frequent commits dating back to the very beginning of the project
-* **A ``readme.md`` file** with explanations of the technologies used, the approach taken, installation instructions, unsolved problems, etc.
+4. Starting with 4 moves and doubling the number of moves every round(Up to round 5)
 
----
+5. Player who finishes the pattern first will get 1 point.
 
-### Suggested Ways to Get Started
+6. Player with the most points  after round 5 wins!
 
-* **Break the project down into different components** (data, presentation, views, style, DOM manipulation) and brainstorm each component individually. Use whiteboards!
-* **Use your Development Tools** (console.log, inspector, alert statements, etc) to debug and solve problems
-* Work through the lessons in class & ask questions when you need to! Think about adding relevant code to your game each night, instead of, you know... _procrastinating_.
-* **Commit early, commit often.** Don’t be afraid to break something because you can always go back in time to a previous version.
-* **Consult documentation resources** (MDN, jQuery, etc.) at home to better understand what you’ll be getting into.
-* **Don’t be afraid to write code that you know you will have to remove later.** Create temporary elements (buttons, links, etc) that trigger events if real data is not available. For example, if you’re trying to figure out how to change some text when the game is over but you haven’t solved the win/lose game logic, you can create a button to simulate that until then.
 
----
+## Stage of the game development
 
-### Potential Project Ideas
+### Setting up the divs
+![](/assets/images/divsofgame.png)
+Creating many different divs for different purposes.
+### The key code of keys
+Keys chosen
 
-##### Blackjack
-Make a one player game where people down on their luck can lose all their money by guessing which card the computer will deal next!
+Player 1 | Player 2 | *keycode for Player 1* | *keycode for Player 2*
+--- | --- | --- | ---
+`Number Keys` | `Arrow Keys` | `keycode` | `keycode`
+1,2,3,4 | left,up,right,down | 49,50,51,52 | 37,38,39,40
 
-##### Self-scoring Trivia
-Test your wits & knowledge with whatever-the-heck you know about (so you can actually win). Guess answers, have the computer tell you how right you are!
+Credit http://keycode.info/
+### Matching array with the keys
+Setting the number of moves in an array for the dance instructor
 
----
+`var instructorMoves = [37,38,39,40]`
 
-### Useful Resources
+By doing it this way, I can directly compare it with Player 2's **keycode** combinations(the arrow keys) using ..
 
-* **[MDN Javascript Docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript)** _(a great reference for all things Vanilla Javascript)_
-* **[jQuery Docs](http://api.jquery.com)** _(if you're using jQuery)_
-* **[GitHub Pages](https://pages.github.com)** _(for hosting your game)_
-* **[How to write readme - Markdown CheatSheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)** _(for editing this readme)_ 
-* **[How to write a good readme for github repo!](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)** _(to make it better)_
+`var strOfKeys1 = e.which` and `if(strOfKeys === randSequence)`
 
----
+As for Player 1, I can subtract the given array of numbers to match with my number keys' **keycode**.
 
-### Project Feedback + Evaluation
+`var strOfKeys = e.which - 12`
 
-* __Project Workflow__: Did you complete the user stories, wireframes, task tracking, and/or ERDs, as specified above? Did you use source control as expected for the phase of the program you’re in (detailed above)?
+### Checking for match & iterating position
 
-* __Technical Requirements__: Did you deliver a project that met all the technical requirements? Given what the class has covered so far, did you build something that was reasonably complex?
+```javascript
+if(strOfKeys === randSequence[counter1]) {
+  counter1++
+  if(counter1 === 4 && rounds === 1) {
+    $(".playerOneAlert2").html("O").show().delay(2000).fadeOut(1000)
+    $(".playerOneAlert2").css({"color" : "green", "font-size" : "50px"})
+    counter1 = 0
+    rounds++
+    scoreP1++
+    $playerOne.text(`Score: ${scoreP1}`)
+    new Audio('./assets/audio/cheer.mp3').play()
+    timerWithAddRounds()
+  }
+```
 
-* __Creativity__: Did you add a personal spin or creative element into your project submission? Did you deliver something of value to the end user (not just a login button and an index page)?
+```javascript
+else if (strOfKeys !== randSequence[counter1] && whichPlayer === 1) {
+   $(".playerOneAlert2").html("X").show().delay(400).fadeOut(400)
+   $(".playerOneAlert2").css({"color" : "red", "font-size" : "50px"})
+   new Audio('./assets/audio/boo.mp3').play()
+   counter1 = 0
+}
+```
 
-* __Code Quality__: Did you follow code style guidance and best practices covered in class, such as spacing, modularity, and semantic naming? Did you comment your code as your instructors have in class?
+### Randomising and adding new rounds
+Using a function with an argument of `arr` and a for loop inside the function to jumble up the position.
 
-* __Deployment__: Did you deploy your application to a public url using GitHub Pages?
+```javascript
+function shuffleArray(arr) {
+  for (var i = arr.length - 1; i > 0; i--){
+    var shuffle = Math.floor(Math.random() * (i + 1))
+    ;[arr[i], arr[shuffle]] = [arr[shuffle], arr[i]]
+  }
+  return arr
+}
+```
 
-* __Total__: Your instructors will give you a total score on your project between:
+Adding new rounds.
 
-    Score | Expectations
-    ----- | ------------
-    **0** | _Incomplete._
-    **1** | _Does not meet expectations._
-    **2** | _Meets expectations, good job!_
-    **3** | _Exceeds expectations, you wonderful creature, you!_
+```javascript
+function addTurn(){
+    instructorMoves = instructorMoves.concat(instructorMoves)
+    randSequence = shuffleArray(instructorMoves)
+    return randSequence;
+  }
+```
 
- This will serve as a helpful overall gauge of whether you met the project goals, but __the more important scores are the individual ones__ above, which can help you identify where to focus your efforts for the next project!
+## Challenges
+
+
+* Making the music instructor move together with the number sequence.
+ <img src="/assets/images/instructor_1.png" height ="50"><img src="/assets/images/instructor_2.png" height ="50"><img src="/assets/images/instructor_3.png" height ="50"><img src="/assets/images/instructor_4.png" height ="50">    
+
+* Matching with the randomised array and comparing which player finishes the pattern first.
+
+* Making the image of instructor's moves appear together with the pattern on the screen.
+
+## Possible future improvements
+
+
+1. Adding more rounds
+
+2. Increase the difficulty by hiding the number patterns in some rounds to let the players just follow the dance pattern.
+
+3. More keys to control on more dance moves other than '1,2,3,4'
+
+## Credit
+
+TA - Alex & Shumin
+
+Google
+
+Stackoverflow
+
+MDN