Skip to content

Commit

Permalink
VGM apps descriptions fix (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
nminaylov authored Feb 13, 2024
1 parent 20cba42 commit 128c33a
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 18 deletions.
4 changes: 4 additions & 0 deletions air_arkanoid/.catalog/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 1.1
- Description update
## 1.0
- Initial release
4 changes: 3 additions & 1 deletion air_arkanoid/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Air Arkanoid

This is a simple arkanoid game that shows how use [Flipper Zero Game Engine](https://github.com/flipperdevices/flipperzero-game-engine) to integrate IMU (that is present on Video Game Module, for example) with your game.
This is our simple version of the Arkanoid game that can use the motion-tracking sensor of the Video Game Module or Flipper Zero buttons to control the paddle. To play the game with buttons, disconnect the Video Game Module before running the game.

The Air Arkanoid game also demonstrates how to integrate the motion-tracking sensor of the Video Game Module into your game using the [Flipper Zero Game Engine](https://github.com/flipperdevices/flipperzero-game-engine).
3 changes: 0 additions & 3 deletions air_arkanoid/.catalog/changelog.md

This file was deleted.

2 changes: 2 additions & 0 deletions air_arkanoid/application.fam
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ App(
fap_icon="icon.png",
fap_category="Games",
fap_file_assets="assets",
fap_description="Arkanoid game that supports the Video Game Module motion sensor",
fap_version="1.1",
fap_extbuild=(
ExtFile(
path="${FAP_SRC_DIR}/assets",
Expand Down
4 changes: 4 additions & 0 deletions air_mouse/.catalog/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 1.1
- Description update
## 1.0
- Initial release
11 changes: 9 additions & 2 deletions air_mouse/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
# Air Mouse app for Video Game Module
The Air Mouse app turns Flipper Zero with the module into a computer mouse. Control the pointer on your computer by tilting and rotating your Flipper Zero with the help of the motion-tracking sensor inside the module. Simply connect your Flipper Zero to a computer or smartphone via Bluetooth or USB.
# Air Mouse app for the Video Game Module

The Air Mouse app turns Flipper Zero with the module into a computer mouse. Control the pointer on your computer by tilting and rotating your Flipper Zero with the help of the motion-tracking sensor inside the module. Simply connect your Flipper Zero to a computer or smartphone via Bluetooth or USB.

## Controls

- Left-click: press the OK button.
- Right-click: press the UP button.
- Scrolling: press and hold the LEFT button and tilt your Flipper Zero.
3 changes: 2 additions & 1 deletion air_mouse/application.fam
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
App(
appid="vgm_air_mouse",
name="Air Mouse",
fap_description="Video Game Module Air Mouse",
fap_version="1.1",
fap_description="Turn Flipper Zero with the Video Game Module into an air mouse",
apptype=FlipperAppType.EXTERNAL,
entry_point="air_mouse_app",
stack_size=4 * 1024,
Expand Down
2 changes: 2 additions & 0 deletions video_game_module_tool/.catalog/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
## 1.1
- Description update
## 1.0
- Initial release
17 changes: 8 additions & 9 deletions video_game_module_tool/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# Video Game Module Tool

Standalone firmware updater/installer for the Video Game Module.
This app is a standalone firmware updater/installer for the Video Game Module

## Features

- Install the official VGM firmware directly from Flipper Zero (firmware comes bundled with the application)
- Install custom VGM firmware files in UF2 format from SD card (see limitations)
- Install the official Video Game Module firmware directly from Flipper Zero (firmware comes bundled with the app).
- Install custom Video Game Module firmware files in UF2 format from a microSD card (see limitations).

## Limitations

When creating a custom UF2 firmware image, some limitations are to keep in mind:

- Non-flash blocks are NOT supported
- Block payloads MUST be exactly 256 bytes
- Payload target addresses MUST be 256 byte-aligned with no gaps
- Features such as file containers and extension tags are NOT supported
When creating a custom UF2 firmware image, keep in mind the following limitations:
- Non-flash blocks are NOT supported.
- Block payloads MUST be exactly 256 bytes.
- Payload target addresses MUST be 256 byte-aligned with no gaps.
- Features such as file containers and extension tags are NOT supported.
4 changes: 2 additions & 2 deletions video_game_module_tool/application.fam
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ App(
"dialogs",
],
stack_size=2048,
fap_description="Update Video Game Module's firmware directly from Flipper",
fap_version="1.0",
fap_description="This app is a standalone firmware updater/installer for the Video Game Module",
fap_version="1.1",
fap_icon="vgm_tool.png",
fap_category="Tools",
fap_icon_assets="icons",
Expand Down

0 comments on commit 128c33a

Please sign in to comment.