cs4241-19a · mmdanke · Sep 28, 2019 · Sep 28, 2019 · Sep 28, 2019 · Sep 28, 2019
diff --git a/README.md b/README.md
@@ -1,72 +1,58 @@
 Assignment 4 - Creative Coding: Interactive Multimedia Experiences
 ===
-
-Due: September 27th, by 11:59 PM.
-
-For this assignment we will focus on client-side development using popular audio/graphics/visualization technologies; the server requirements are minimal. The goal of this assignment is to refine our JavaScript knowledge while exploring the multimedia capabilities of the browser.
-
 Baseline Requirements
 ---
+My application implements the minimal requirements and functionalities:
 
-Your application is required to implement the following functionalities:
+1) Server using express that uses compression and helmet.
 
-- A server created using Express (you can also use an alternative server framework such as Koa) for basic file delivery and middleware. Your middleware stack should include the `compression` and `helmet` [middlewares]((https://expressjs.com/en/resources/middleware.html)) by default. You are not required to use Glitch for this assignment (but using Glitch is fine!); [Heroku](https://www.heroku.com) is another excellent option to explore. The course staff can't be resposible for helping with all other hosting options outside of Glitch, but some of us do have experience with other systems. It also never hurts to ask on Slack, as there's 99 other classmates who might have the experience you're looking for!
-- A client-side interactive experience using at least one of the web technologies frameworks we discussed in class over the past week.
-  - [Three.js](https://threejs.org/): A library for 3D graphics / VR experiences
-  - [D3.js](https://d3js.org): A library that is primarily used for interactive data visualizations
-  - [Canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API): A 2D raster drawing API included in all modern browsers
-  - [SVG](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API): A 2D vector drawing framework that enables shapes to be defined via XML.
-  - [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API): An API for audio synthesis, analysis, processing, and file playback.
-- A user interface for interaction with your project, which must expose at least six parameters for user control. [dat.gui](https://workshop.chromeexperiments.com/examples/gui/#1--Basic-Usage) is highly recommended for this. You might also explore interaction by tracking mouse movement via the `window.onmousemove` event handler in tandem with the `event.clientX` and `event.clientY` properties. Consider using the [Pointer Events API](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) to ensure that that mouse and touch events will both be supported in your app.
-- Your application should display basic documentation for the user interface when the application first loads. This documentation should be dismissable, however, users should be able to redisplay it via either a help buton (this could, for example, be inside a dat.gui interface) or via a keyboard shortcut (commonly the question mark).
-- Your application should feature at least two different ES6 modules that you write ([read about ES6 modules](https://www.sitepoint.com/understanding-es6-modules/)) and include into a main JavaScript file. This means that you will need to author *at least three JavaScript files* (a `app.js` or `main.js` file and two modules). We'll discuss modules in class on Monday 9/23; for this assignment modules should contain at least two functions.
-- You are required to use a linter for your JavaScript. There are plugins for most IDEs, however it will be difficult to run the linter directly in Glitch. If you haven't moved to developing on your personal laptop and then uploading to Glitch when your project is completed, this is the assignment to do so!
-- Your HTML and CSS should validate. There are options/plugins for most IDEs to check validation.
+2) A client-side interactive experience that uses Canvas.
 
-The interactive experience should possess a reasonable level of complexity. Some examples:
-### Three.js
-- A generative algorithm creates simple agents that move through a virtual world. Your interface controls the behavior / appearance of these agents.
-- A simple 3D game
-- An 3D audio visualization of a song of your choosing. User interaction should control aspects of the visualization. 
-### Canvas
-- Implement a generative algorithm such as [Conway's Game of Life](https://bitstorm.org/gameoflife/) (or 1D cellular automata) and provide interactive controls. Note that the Game of Life has been created by 100s of people using <canvas>; we'll be checking to ensure that your implementation is not a copy of these.
-- Design a 2D audio visualizer of a song of your choosing. User interaction should control visual aspects of the experience. 
-### Web Audio API
-- Create a screen-based musical instrument using the Web Audio API. You can use projects such as [Interface.js](http://charlie-roberts.com/interface/) or [Nexus UI](https://nexus-js.github.io/ui/api/#Piano) to provide common musical interface elements, or use dat.GUI in combination with mouse/touch events (use the Pointer Events API). Your GUI should enable users to control aspects of sound synthesis.
-### D3.js
-- Create visualizations using the datasets found at [Awesome JSON Datasets](https://github.com/jdorfman/Awesome-JSON-Datasets). Experiment with providing different visualizations of the same data set, and providing users interactive control over visualization parameters and/or data filtering. Alternatively, create a single visualization with using one of the more complicated techniques shown at [d3js.org](d3js.org) and provide meaningful points of interaction for users.
+3) User Control Parameters:
+   - Keyboard ^ button moves red block user north
+   - Keyboard > button moves red block user east
+   - Keyboard "down" button moves red block user south
+   - Keyboard < button moves red block user west
+   - Bedtime Check Button, when clicked, enables user to see the time to gauge their bedtime.
+   - Goal and How to Move Buttons display an alert that provide users with more instruction on how the game works.
+   - When the initial directions are clicked, they disappear to create more space. They are then replaced by a shorter and inspirational(positive) message.
+   - Enter Brick You Landed On button prompts users to type in what tile they are currently on after they have moved. It then gives the user a message back indicating another action before the user has to roll the die again.
+   - The yellow "HELP!!" field at the bottom of the page lets the user just hover their mouse over it to get easy directions.
+   
+4) My application initially displays basic documentation for the user interface when the application first loads. It can disappear once clicked on as explained in the user control parameters above^
 
-Deliverables
----
-
-Do the following to complete this assignment:
+5) My application has index.html, main.js, second.js, and third.js It implements ES6 modules through import and export.
 
-1. Implement your project with the above requirements.
-3. Test your project to make sure that when someone goes to your main page on Glitch/Heroku/etc., it displays correctly.
-4. Ensure that your project has the proper naming scheme `a4-yourname` so we can find it.
-5. Fork this repository and modify the README to the specifications below. *NOTE: If you don't use Glitch for hosting (where we can see the files) then you must include all project files that you author in your repo for this assignment*.
-6. Create and submit a Pull Request to the original repo. Name the pull request using the following template: `a4-gitname-firstname-lastname`.
+6) My application uses the ES Linter through Webstorm.
 
-Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
----
+7) My HTML and CSS validates through Webstorm and Glitch.
+---------------------------------------------------------------------------------------------------------------------------------------
+## Application Name: Zoo Adventure
 
-## Your Web Application Title
+the hosting link: https://glitch.com/~a4-manasi-danke
 
-your hosting link e.g. http://a4-charlieroberts.glitch.me
+### Zoo Adventure is an online and interactive board game that a user can play online and on the go. The user is able to move the piece with their keyboard and also interact with the buttons and instructions provided. They can play this game on the go as a mess-free way to relax before bedtime.
 
-Include a very brief summary of your project here. Images are encouraged, along with concise, high-level text. Be sure to include:
+- Goal of the Application: 
+  - The user has to navigate through the game by rolling a die, moving the red block piece to the correct tile, and the executing the movement for the tile they have landed on by pressing the button. They have to make it to the end of the path to the picnic basket before their bed time. Time button is provided so the user can keep track of the time while using the application without exiting it.
 
-- the goal of the application
-- challenges you faced in realizing the application
-- a brief description of the JS linter you used and what rules it follows (we'll be looking at your JS files for consistency)
+- Challenges:
+   - My canvas(board game layout) disappeared each time I tried to implement ES6 modules. I have included the code in my files such as the import and export statements, but there may be a bug with just canvas. Right now I have made sure that the interface allows the user to interact with it, but my ES6 code is present in my files.
+   - Other things to note: I originally had a visualization with dat.gui and three js, but that unexpectedly stopped working properly yesterday so I had to place a large part of my energy and soul into creating this new project in time.
+- Linter:
+   - I used ES Lint via Webstorm, and it alligns my starting and closing tags. It enforces the consistent use of either function declarations and expressions.
 
 ## Technical Achievements
-- **Tech Achievement 1**: I wrote my own custom GLSL shaders to use as a material for my Three.js objects.
-- **Tech Achievement 2**: My audiovisualizer uses both FFT and amplitude analysis to drive visualization.
-- **Tech Achievement 3**: I optimized the efficiency of my reaction-diffusion algorithm by...
-- **Tech Achievement 4**: I visualized the dataset X using three different visualization technqiues provided by D3, andprovided
+- **Tech Achievement 1**: I implemented Javascript functions using the Date and Math libraries(getting time and selecting a random number between 1 and 6(included) for the die roll)
+- **Tech Achievement 2**: I implemeted more than 6 ways that the user can interact with the board game interface and had to write multiple respective functions.
 
 ### Design/Evaluation Achievements
-- **Design Achievement 1**: I ensured that my application would run on both desktops / mobile devices by changing X
-- **Design Achievement 2**: I followed best practices for accessibility, including providing alt attributes for images and using semantic HTML. There are no `<div>` or `<span>` elements in my document.
-- **Design Achievement 3**: We tested the application with n=X users, finding that...
+- **Design Achievement 1**: The application is minimalistic is color so that all the attention can be focused on the colorful board game. The other user interface buttons are alligned neatly and are out of the way of the gameboard.
+- **Design Achievement 2**:The application is very convenient to use. The user can simulate rolling a die and even getting a response for the tile they land on without 3d objects such as dice and cards! The game is mess free! In addition, the user can play the game at their own pace and does not have to wait for another player.
+- **Design Achievement 3**: The application is relaxing and requires repetitive actions. It is great for users to play when they are winding down, relaxing, and trying to fall asleep. The user can even check the time within the application to make sure that it is not past their bedtime.
+
+## Other Resources:
+- https://i.pinimg.com/originals/db/29/31/db2931e5414bdaf6fe15ba8df10e2cde.jpg
+- w3 schools- especially for the movement of the red block on the canvas
+- codepen
+- canvas and javascript documentation online