Jelajahi Sumber

updated docs

rdefeo 1 tahun lalu
induk
melakukan
02eb52e7ae
2 mengubah file dengan 10 tambahan dan 2 penghapusan
  1. 9 1
      README.md
  2. 1 1
      README_flipperlab.md

+ 9 - 1
README.md

@@ -24,7 +24,7 @@ Get the latest version:
 * Scores! (no high scores yet, just a running tally as you play)
 * Scores! (no high scores yet, just a running tally as you play)
 * Table bumps! (Don't tilt the table!)
 * Table bumps! (Don't tilt the table!)
 * Portals!
 * Portals!
-* Rollover items
+* Rollover items, Turbo boosts
 * Sounds! Blinky lights! Annoying vibrations!
 * Sounds! Blinky lights! Annoying vibrations!
 * Customizable notification settings: sound, LED, vibration
 * Customizable notification settings: sound, LED, vibration
 * Idle timeout to save battery - will exit after ~2 minutes of no key-presses on menu screen
 * Idle timeout to save battery - will exit after ~2 minutes of no key-presses on menu screen
@@ -117,6 +117,14 @@ When the ball passes over/through a rollover object, the symbol will appear. Onl
 
 
 Defines two portals, **a** and **b**. They are bi-drectional. Like rails, their "surface" - or in this case, their "entry surface" - is "on the left" from their respective start to end direction. You can't "enter" a portal from it's reverse side, you will pass through.
 Defines two portals, **a** and **b**. They are bi-drectional. Like rails, their "surface" - or in this case, their "entry surface" - is "on the left" from their respective start to end direction. You can't "enter" a portal from it's reverse side, you will pass through.
 
 
+#### turbos : list of objects (optional)
+* `"position": [ X, Y ]`
+* `"angle": N` : in degrees from 0 to 360
+* `"boost": N` : optional, defaults to `5`
+* `"radius" : N` : optional, defaults to `20`
+
+When the ball hits a turbo boost, it will force the new velocity to be in the direction of `angle`.
+
 #### tilt_detect : boolean
 #### tilt_detect : boolean
 * `"tilt_detect": bool` : optional, defaults to `true`
 * `"tilt_detect": bool` : optional, defaults to `true`
 
 

+ 1 - 1
README_flipperlab.md

@@ -7,7 +7,7 @@ Play pinball on your Flipperzero!
 * Bumpers, flat surfaces, curved surfaces
 * Bumpers, flat surfaces, curved surfaces
 * Table bumps (Don't tilt the table!)
 * Table bumps (Don't tilt the table!)
 * Portals!
 * Portals!
-* Rollover items
+* Rollover items, Turbo boosts
 * Sounds! Blinky lights! Annoying vibrations!
 * Sounds! Blinky lights! Annoying vibrations!
 * Customizable notification settings: sound, LED, vibration
 * Customizable notification settings: sound, LED, vibration
 * Idle timeout
 * Idle timeout