Docs and some randomness removal (#38)

* feat: remove slowmo timer

- render only one rock

* docs: README

* fix: remove zone randomization

* docs: mod README

Author: 0xRampey

README.md

@@ -1,13 +1,57 @@
 # Comets
 
-## Use
+![Comets Gameplay](comets.gif)
+
+Comets is a fully-onchain space-themed game rollup inspired by the classic Asteroids.
+Navigate through a field of asteroids, blast them into smaller pieces, and watch out for alien ships!
+
+## Controls
+
+- Press `ENTER` button to start the game
+- Rotate: Left/Right arrow keys or A and D
+- Thrust: Up arrow or W
+- Fire: Space bar
+- Hyperspace: CTRL
+
+Every step of your gameplay is recorded and verified on-chain so that your score is unspoofable and your legendary run will be remembered forever!
+
+Play it here: https://comets.stf.xyz/
+
+## Development
+
+Comets is composed of two parts:
+
+- a frontend game client
+- a micro-rollup web server
+
+To run it locally, you need to first spin up the rollup.
 
 ```shell
-# Build Client
-npm run build:client
+cd game
+vim .env
+# set up your rollup config
+# add PRIVATE_KEY=<your-private-key>
+npm i
+# start the rollup server
+npm start
 ```
 
+The server should be running on port 3210 by default.
+
+Now run the Next.js app.
+
 ```shell
-# Start Server
-npm run start:server
+cd client
+vim game/src/api.ts
+# set API_URL=http://localhost:3210
+npm install
+npm run dev
 ```
+
+And voila! You're ready to play on your local machine at http://localhost:3000.
+
+## Deployment
+
+To deploy your own version of Comets on Sepolia, make sure to properly setup your config by following this [step](https://docs.stf.xyz/build/zero-to-one/build-your-first-mru#setting-up-your-config).
+
+Then, follow the remaining guide to deploy your very own Comets rollup.

comets.gif

@@ -186,12 +186,12 @@ export class Rock extends Object2D {
 
 export function createRocks(level: number): Rock[] {
   const rocks = [];
-  const count = Math.min(level + 1, 12);
+  const count = 1;
   const speed = 150;
   const offset = 20;
 
   for (let i = 0; i < count; i++) {
-    const zone = random(1, Math.pow(42, i)) % 4;
+    const zone = random(1, 4);
     const v = Vector.fromAngle(random(1, 360));
     let x: number;
     let y: number;

game/src/core/rocks.ts

@@ -73,10 +73,6 @@ export class World {
   }
 
   update(dt: number, inputs: VirtualInput) {
-    if (this.slowMoTimer) {
-      dt = this.slowMoTimer.adjust(dt);
-    }
-
     if (this.dramaticPauseTimer > 0) {
       this.dramaticPauseTimer--;
       return;
@@ -97,10 +93,6 @@ export class World {
   }
 
   render(screen: Screen, dt: number) {
-    if (this.slowMoTimer) {
-      dt = this.slowMoTimer.adjust(dt);
-    }
-
     if (this.shakeTimer > 0) {
       screen.preShake();
     }
@@ -239,7 +231,6 @@ export class World {
       this.createExplosion(this.ship);
       this.addFlash(5);
       this.ship.destroy();
-      this.setSlowMo(0.25, 8);
     }
   }