Enhance .gitignore and update ReadMe files for clarity and additional resources

This commit is contained in:
peter9811 2025-03-01 17:59:35 +10:00
parent 1e10e5c233
commit 0f14fde1a8
4 changed files with 130 additions and 52 deletions

65
.gitignore vendored
View File

@ -1,2 +1,65 @@
# VSCodium # VSCodium & VS Code
.history .history
.vscode/
*.code-workspace
# IDE files
.idea/
*.sublime-*
*.swp
*.swo
# Node.js
node_modules/
npm-debug.log
yarn-debug.log
yarn-error.log
package-lock.json
yarn.lock
.npm/
.pnp/
.pnp.js
# Python
__pycache__/
*.py[cod]
*$py.class
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
venv/
.env
# Build output
dist/
build/
out/
# Logs
logs
*.log
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Project specific
# Add your project-specific ignores here

View File

@ -1,12 +1,14 @@
# Flipper Application Files (FAPs) for custom firmwares # Flipper Application Files (FAPs) for custom firmwares
* [RogueMaster](https://github.com/RogueMaster/flipperzero-firmware-wPlugins) * [RogueMaster](https://github.com/RogueMaster/flipperzero-firmware-wPlugins)
* [Unleashed](https://github.com/DarkFlippers/unleashed-firmware) * [Unleashed](https://github.com/DarkFlippers/unleashed-firmware)
[Download all files here](https://uberguidoz.github.io/DownGit/#/home?url=https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Custom%20(UL%2C%20RM%2C%20XFW)) (may not include [bundled apps](https://github.com/DarkFlippers/unleashed-firmware#community-apps-included)) or [source here](https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Official/DEV_FW/source). Mirror from xMasterX [here](https://github.com/xMasterX/unleashed-extra-pack). [Download all files here](https://uberguidoz.github.io/DownGit/#/home?url=https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Custom%20(UL%2C%20RM%2C%20XFW)) (may not include [bundled apps](https://github.com/DarkFlippers/unleashed-firmware#community-apps-included)) or [source here](https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Official/DEV_FW/source). Mirror from xMasterX [here](https://github.com/xMasterX/unleashed-extra-pack).
--- ---
*****Unofficial FAP Store is here! [You gotta check it out at FlipC.org](https://flipc.org/)*****<br> *****Unofficial FAP Store is here! [You gotta check it out at FlipC.org](https://flipc.org/)*****<br>
From [Aleksey Korolev](https://github.com/playmean) comes a quick and easy way to install FAP files. From [Aleksey Korolev](https://github.com/playmean) comes a quick and easy way to install FAP files
--- ---
Thank you [RogueMaster](https://github.com/RogueMaster) and [xMasterX](https://github.com/xMasterX) for compiling and maintaining many of these files. I have decided to not include the "integrated/bundled" FAP files that come with a fresh install of Unleashed. If you need to grab a copy of them for whatever reason, you can do so right from the Unleashed repo. Thank you [RogueMaster](https://github.com/RogueMaster) and [xMasterX](https://github.com/xMasterX) for compiling and maintaining many of these files. I have decided to not include the "integrated/bundled" FAP files that come with a fresh install of Unleashed. If you need to grab a copy of them for whatever reason, you can do so right from the Unleashed repo.
@ -15,43 +17,51 @@ Thank you [RogueMaster](https://github.com/RogueMaster) and [xMasterX](https://g
* Scroll down and download the linked ZIP file from the Assets drop down, under the big install from web link. * Scroll down and download the linked ZIP file from the Assets drop down, under the big install from web link.
* Within that ZIP, you'll find `resources.tar` - open/extract that too and look in the `apps` folder. * Within that ZIP, you'll find `resources.tar` - open/extract that too and look in the `apps` folder.
## Thank you to the authors! ## Thank you to the authors
The Flipper and its community wouldn't be as rich as it is without your contributions and support. Thank you for all you have done. [MORE HERE](https://github.com/DarkFlippers/unleashed-firmware#community-apps-included) The Flipper and its community wouldn't be as rich as it is without your contributions and support. Thank you for all you have done. [MORE HERE](https://github.com/DarkFlippers/unleashed-firmware#community-apps-included)
## Games ## Games
- [2048 (By OlegSchwann)](https://github.com/OlegSchwann/flipperzero-firmware/tree/hackaton/game_2048/applications/game-2048) [(Score By DevMilanIan)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/pull/186)
- [Dice Roller Including SEX/WAR/8BALL/WEED DICE (By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/420/applications/plugins/dice/dice.c) * [2048 (By OlegSchwann)](https://github.com/OlegSchwann/flipperzero-firmware/tree/hackaton/game_2048/applications/game-2048) [(Score By DevMilanIan)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/pull/186)
- [Game of Life (Updated to work by tgxn) (By itsyourbedtime)](https://github.com/tgxn/flipperzero-firmware/blob/dev/applications/game_of_life/game_of_life.c)
- [Mandelbrot Set (By Possibly-Matt)](https://github.com/Possibly-Matt/flipperzero-firmware-wPlugins) * [Dice Roller Including SEX/WAR/8BALL/WEED DICE (By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/420/applications/plugins/dice/dice.c)
- [Minesweeper (By panki27)](https://github.com/panki27/minesweeper) * [Game of Life (Updated to work by tgxn) (By itsyourbedtime)](https://github.com/tgxn/flipperzero-firmware/blob/dev/applications/game_of_life/game_of_life.c)
- [Monty Hall (By DevMilanIan)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/pull/203) * [Mandelbrot Set (By Possibly-Matt)](https://github.com/Possibly-Matt/flipperzero-firmware-wPlugins)
- [TAMA P1 (By GMMan)](https://github.com/GMMan/flipperzero-tamagotch-p1) requires [this rom](https://tinyurl.com/tamap1) IN `tama_p1` on SD as `rom.bin` to make it work. * [Minesweeper (By panki27)](https://github.com/panki27/minesweeper)
- [Video Poker (By PixlEmly)](https://github.com/PixlEmly/flipperzero-firmware-testing/blob/420/applications/VideoPoker/poker.c) * [Monty Hall (By DevMilanIan)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/pull/203)
- [Scorched Tanks (By jasniec)](https://github.com/jasniec/flipper-scorched-tanks-game) * [TAMA P1 (By GMMan)](https://github.com/GMMan/flipperzero-tamagotch-p1) requires [this rom](https://tinyurl.com/tamap1) IN `tama_p1` on SD as `rom.bin` to make it work.
- [Blackjack (By teeebor)](https://github.com/teeebor/flipper_games) * [Video Poker (By PixlEmly)](https://github.com/PixlEmly/flipperzero-firmware-testing/blob/420/applications/VideoPoker/poker.c)
- [Logic Game 15 (By x27)](https://github.com/x27/flipperzero-game15) * [Scorched Tanks (By jasniec)](https://github.com/jasniec/flipper-scorched-tanks-game)
- [Color Guess (By Leedave)](https://github.com/leedave/Leeds-Flipper-Zero-Applications/tree/main/Games/color_guess) * [Blackjack (By teeebor)](https://github.com/teeebor/flipper_games)
* [Logic Game 15 (By x27)](https://github.com/x27/flipperzero-game15)
* [Color Guess (By Leedave)](https://github.com/leedave/Leeds-Flipper-Zero-Applications/tree/main/Games/color_guess)
## Music ## Music
- [Software Automatic Mouth aka SAM (By ctoth)](https://github.com/ctoth/SAM)
- [Tuning Fork (By besya)](https://github.com/besya/flipperzero-tuning-fork) * [Software Automatic Mouth aka SAM (By ctoth)](https://github.com/ctoth/SAM)
- [BPM Tapper (By panki27)](https://github.com/panki27/bpm-tapper)
- [Ocarina (By invalidna-me)](https://github.com/invalidna-me/flipperzero-ocarina) * [Tuning Fork (By besya)](https://github.com/besya/flipperzero-tuning-fork)
- Music Beeper (By qqMajiKpp / Haseo) * [BPM Tapper (By panki27)](https://github.com/panki27/bpm-tapper)
- Morse Code [(by wh00hw)](https://github.com/wh00hw/MorseCodeFAP) * [Ocarina (By invalidna-me)](https://github.com/invalidna-me/flipperzero-ocarina)
* Music Beeper (By qqMajiKpp / Haseo)
* Morse Code [(by wh00hw)](https://github.com/wh00hw/MorseCodeFAP)
## GPIO ## GPIO
- [IFTTT Virtual Button for ESP8266 (By Ferrazzi)](https://github.com/Ferrazzi/FlipperZero_IFTTT_Virtual_Button)
- [Wifi Deauth v2 for ESP8266 (By Timmotools)](https://github.com/Timmotools/flipperzero_esp8266_deautherv2) * [IFTTT Virtual Button for ESP8266 (By Ferrazzi)](https://github.com/Ferrazzi/FlipperZero_IFTTT_Virtual_Button)
* [Wifi Deauth v2 for ESP8266 (By Timmotools)](https://github.com/Timmotools/flipperzero_esp8266_deautherv2)
## Tools / Misc ## Tools / Misc
- [Paint (By n-o-T-I-n-s-a-n-e)](https://github.com/n-o-T-I-n-s-a-n-e)
- [Mouse Jiggler (By Jacob-Tate)](https://github.com/Jacob-Tate/flipperzero-firmware/blob/dev/applications/mouse_jiggler/mouse_jiggler.c) ([Original By MuddleBox](https://github.com/MuddledBox/)) * [Paint (By n-o-T-I-n-s-a-n-e)](https://github.com/n-o-T-I-n-s-a-n-e)
- [Calculator (By n-o-T-I-n-s-a-n-e)](https://github.com/n-o-T-I-n-s-a-n-e)
- [Ceasar Cipher (By panki27)](https://github.com/panki27/caesar-cipher) * [Mouse Jiggler (By Jacob-Tate)](https://github.com/Jacob-Tate/flipperzero-firmware/blob/dev/applications/mouse_jiggler/mouse_jiggler.c) ([Original By MuddleBox](https://github.com/MuddledBox/))
- [Pomodoro Timer (By sbrin)](https://github.com/sbrin/flipperzero_pomodoro) * [Calculator (By n-o-T-I-n-s-a-n-e)](https://github.com/n-o-T-I-n-s-a-n-e)
- [Cross Remote (By Leedave)](https://github.com/leedave/Leeds-Flipper-Zero-Applications/tree/main/Tools/xremote) (features in development) * [Ceasar Cipher (By panki27)](https://github.com/panki27/caesar-cipher)
* [Pomodoro Timer (By sbrin)](https://github.com/sbrin/flipperzero_pomodoro)
* [Cross Remote (By Leedave)](https://github.com/leedave/Leeds-Flipper-Zero-Applications/tree/main/Tools/xremote) (features in development)
----- -----

View File

@ -1,21 +1,19 @@
# Flipper Application Files (FAPs) # Flipper Application Files (FAPs)
## Compare your firmware API version with API version in releases to avoid compatibility issues ## Compare your firmware API version with API version in releases to avoid compatibility issues
#### [Download .zip file by using this link, unpack, and copy only specific apps folders or specific apps onto your microSD into apps folder](https://github.com/xMasterX/all-the-plugins/releases/latest) #### [Download .zip file by using this link, unpack, and copy only specific apps folders or specific apps onto your microSD into apps folder](https://github.com/xMasterX/all-the-plugins/releases/latest)
--- ---
Apps contains changes needed to compile them on latest firmware, fixes has been done by @xMasterX Apps contains changes needed to compile them on latest firmware, fixes has been done by @xMasterX
## Thank you to the authors
## Thank you to the authors!
The Flipper and its community wouldn't be as rich as it is without your contributions and support. Thank you for all you have done. The Flipper and its community wouldn't be as rich as it is without your contributions and support. Thank you for all you have done.
### Apps checked & updated at `27 Jul 06:07 GMT +3` ### Apps checked & updated at `27 Jul 06:07 GMT +3`
# Default pack # Default pack
<details> <details>
@ -26,7 +24,7 @@ The Flipper and its community wouldn't be as rich as it is without your contribu
<img src="https://img.shields.io/badge/None-%23FF0000?style=flat-square"> - not in the catalog <img src="https://img.shields.io/badge/None-%23FF0000?style=flat-square"> - not in the catalog
</details> </details>
### The default package includes all applications from [official](https://github.com/flipperdevices/flipperzero-good-faps) developers: ### The default package includes all applications from [official](https://github.com/flipperdevices/flipperzero-good-faps) developers
| Name | <div style="width:100px">Category</div> | Remark | <div style="width:70px">Catalog</div> | | Name | <div style="width:100px">Category</div> | Remark | <div style="width:70px">Catalog</div> |
|---|:---:|---|:---:| |---|:---:|---|:---:|
@ -48,7 +46,7 @@ The Flipper and its community wouldn't be as rich as it is without your contribu
| Air Arkanoid | ![Games Badge] | [by DrZlo13](https://github.com/flipperdevices/flipperzero-good-faps/pull/141/files) | [![Official Badge]](https://lab.flipper.net/apps/air_arkanoid) | | Air Arkanoid | ![Games Badge] | [by DrZlo13](https://github.com/flipperdevices/flipperzero-good-faps/pull/141/files) | [![Official Badge]](https://lab.flipper.net/apps/air_arkanoid) |
| Music Player | ![Media Badge] | | [![Official Badge]](https://lab.flipper.net/apps/music_player) | | Music Player | ![Media Badge] | | [![Official Badge]](https://lab.flipper.net/apps/music_player) |
### Community and Unleashed Apps in default pack: ### Community and Unleashed Apps in default pack
| Name | <div style="width:100px">Category</div> | Author | Remark | <div style="width:70px">Catalog</div> | | Name | <div style="width:100px">Category</div> | Author | Remark | <div style="width:70px">Catalog</div> |
|---|:---:|---|---|:---:| |---|:---:|---|---|:---:|
@ -112,7 +110,9 @@ The Flipper and its community wouldn't be as rich as it is without your contribu
| JetPack Joyride | ![Games Badge] | [by timstrasser](https://github.com/timstrasser) | | [![Author Badge]](https://lab.flipper.net/apps/jetpack_game) | | JetPack Joyride | ![Games Badge] | [by timstrasser](https://github.com/timstrasser) | | [![Author Badge]](https://lab.flipper.net/apps/jetpack_game) |
--- ---
# Extra pack # Extra pack
| Name | <div style="width:100px">Category</div> | Original author<br>or Source | Remark | <div style="width:70px">Catalog</div> | | Name | <div style="width:100px">Category</div> | Original author<br>or Source | Remark | <div style="width:70px">Catalog</div> |
|---|:---:|---|---|:---:| |---|:---:|---|---|:---:|
| BT Camera Trigger | ![BT Badge] | [by Nem0oo](https://github.com/Nem0oo/flipper-zero-bluetooth-trigger) | | [![UFW Badge]](https://lab.flipper.net/apps/bt_trigger) | | BT Camera Trigger | ![BT Badge] | [by Nem0oo](https://github.com/Nem0oo/flipper-zero-bluetooth-trigger) | | [![UFW Badge]](https://lab.flipper.net/apps/bt_trigger) |
@ -263,12 +263,12 @@ The Flipper and its community wouldn't be as rich as it is without your contribu
| USB Consumer Control | ![USB Badge] | [by WithSecureLabs](https://github.com/WithSecureLabs/usb-consumer-control/tree/main) | | ![None Badge] | | USB Consumer Control | ![USB Badge] | [by WithSecureLabs](https://github.com/WithSecureLabs/usb-consumer-control/tree/main) | | ![None Badge] |
| HID File Transfer | ![USB Badge] | [by Kavakuo](https://github.com/Kavakuo/HID-File-Transfer) | Get client app in [original repo](https://github.com/Kavakuo/HID-File-Transfer) | ![None Badge] | | HID File Transfer | ![USB Badge] | [by Kavakuo](https://github.com/Kavakuo/HID-File-Transfer) | Get client app in [original repo](https://github.com/Kavakuo/HID-File-Transfer) | ![None Badge] |
#### Catalog links checked at `01 Sep 16:24 GMT +3` #### Catalog links checked at `01 Sep 16:24 GMT +3`
--- ---
Useful source of files for flipper, also has apps pack: Useful source of files for flipper, also has apps pack:
## [UberGuidoZ Playground - Large collection of files - Github](https://github.com/UberGuidoZ/Flipper) ## [UberGuidoZ Playground - Large collection of files - Github](https://github.com/UberGuidoZ/Flipper)
[RFID Badge]: https://custom-icon-badges.demolab.com/badge/-RFID-rgb(255,244,147)?style=for-the-badge&logo=fz-rfid&logoColor=black [RFID Badge]: https://custom-icon-badges.demolab.com/badge/-RFID-rgb(255,244,147)?style=for-the-badge&logo=fz-rfid&logoColor=black

View File

@ -3,8 +3,9 @@
## [Some links to authors and descriptions here](https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Custom%20(UL%2C%20RM%2C%20XFW)#readme) ## [Some links to authors and descriptions here](https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Custom%20(UL%2C%20RM%2C%20XFW)#readme)
--- ---
*****Unofficial FAP Store is here! [You gotta check it out at FlipC.org](https://flipc.org/)*****<br> *****Unofficial FAP Store is here! [You gotta check it out at FlipC.org](https://flipc.org/)*****<br>
From [Aleksey Korolev](https://github.com/playmean) comes a quick and easy way to install FAP files. From [Aleksey Korolev](https://github.com/playmean) comes a quick and easy way to install FAP files
--- ---
The long-awaited addition of loading plugins (applications) from the SD card is here thanks to some hard work by the Official Flipper devteam. Anna/hedger released a FAP pack with some pre-built plugins, ready to go. Check out the [Official documentation](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/AppsOnSDCard.md) for more info. The long-awaited addition of loading plugins (applications) from the SD card is here thanks to some hard work by the Official Flipper devteam. Anna/hedger released a FAP pack with some pre-built plugins, ready to go. Check out the [Official documentation](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/AppsOnSDCard.md) for more info.
@ -33,28 +34,32 @@ Now simply navigate to the application you'd like to load and center click it!
To exit and/or load something else, simply use the BACK button. To exit and/or load something else, simply use the BACK button.
----- -----
# Building applications # Building applications
## Here are some resources on getting started creating and building FAPS.
## Here are some resources on getting started creating and building FAPS
### Official documentation ### Official documentation
https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/AppsOnSDCard.md <https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/AppsOnSDCard.md>
### uFBT - micro Flipper Build Tool ### uFBT - micro Flipper Build Tool
https://github.com/flipperdevices/flipperzero-ufbt <https://github.com/flipperdevices/flipperzero-ufbt>
### Dev documentation by at-manos(outdated) ### Dev documentation by at-manos(outdated)
https://flipper.atmanos.com/docs/category/overview <https://flipper.atmanos.com/docs/category/overview>
### Flipper plugin tutorial ### Flipper plugin tutorial
By DroomOne: https://github.com/DroomOne/Flipper-Plugin-Tutorial<br>
By giolaq: https://blog.giolaq.dev/hello-world-of-flipper-zero (The repo that goes with giolaq's blog: https://github.com/giolaq/helloflipper )<br> By DroomOne: <https://github.com/DroomOne/Flipper-Plugin-Tutorial><br>
By csBlueChip: https://github.com/csBlueChip/FlipperZero_plugin_howto By giolaq: <https://blog.giolaq.dev/hello-world-of-flipper-zero> (The repo that goes with giolaq's blog: <https://github.com/giolaq/helloflipper> )<br>
By csBlueChip: <https://github.com/csBlueChip/FlipperZero_plugin_howto>
## Hello world examples ## Hello world examples
By zmactep: https://github.com/zmactep/flipperzero-hello-world <br>
By ASoldo: https://github.com/ASoldo/hello_world <br> By zmactep: <https://github.com/zmactep/flipperzero-hello-world> <br>
By mervburger: https://github.com/mervburger/flipper_helloworld <br> By ASoldo: <https://github.com/ASoldo/hello_world> <br>
A rust implimentation by baakeydow: https://github.com/baakeydow/flipper0-rust-hello-world <br> By mervburger: <https://github.com/mervburger/flipper_helloworld> <br>
A rust implimentation by baakeydow: <https://github.com/baakeydow/flipper0-rust-hello-world> <br>
----- -----