Added README, fixed bug with component name, added GIF.

daniel-schroeder-dev · Oct 4, 2020 · 3194c3e · 3194c3e
1 parent ce16e58
commit 3194c3e
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,43 @@
+# Jump
+
+Jump is an A-Frame component that allows a player to jump on keypress.
+
+## Installation
+
+Include the component file in the head of your HTML document:
+
+```html
+<script type="text/javascript" src="jump.js"></script>
+```
+
+## Usage
+
+```html
+<a-camera 
+  jump="
+    height: 5; 
+    interval: 2000; 
+    timingFunction;
+  " 
+>
+</a-camera>
+```
+
+## Parameters
+
+| Parameter          | Default | Description |
+|--------------------|---------|-------------|
+| **height**         | 5       | The height your player will jump|
+| **interval**       | 1000    | The total time of the jump (in milliseconds)|
+| **timingFunction** | linear  | The timing function used to control the jump.|
+
+## Example
+
+![](jump.gif)
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
   <body>
     <a-scene>
 
-      <a-camera jump="height: 4; interval: 1000;" wasd-controls="acceleration: 1000">
+      <a-camera jump="height: 8; interval: 2000;" wasd-controls="acceleration: 1000">
         <a-cursor></a-cursor>
       </a-camera>
 

diff --git a/jump.gif b/jump.gif
diff --git a/jump.js b/jump.js
@@ -1,6 +1,6 @@
 const JUMP_KEY = ' ';
 
-AFRAME.registerComponent('jump-refined', {
+AFRAME.registerComponent('jump', {
   schema: {
     height: {
      type: 'number',
@@ -15,7 +15,7 @@ AFRAME.registerComponent('jump-refined', {
   init: function() {
     document.addEventListener('keydown', e => {
       if (e.key != JUMP_KEY) return;
-     
+
       const upInterval = setInterval(() => this.el.object3D.position.y += this.data.height / this.data.interval, 10);
 
       setTimeout(() => {