Flipper/Applications/ReadMe.md

75 lines
4.2 KiB
Markdown
Raw Normal View History

2022-09-15 06:39:52 +00:00
# Flipper Application Packages (FAPs)
2022-09-15 06:33:25 +00:00
2023-01-01 20:00:33 +00:00
## [(Some links to authors and descriptions here)](https://github.com/UberGuidoZ/Flipper/tree/main/Applications/Custom%20(UL%2C%20RM%2C%20XFW)#readme)
2022-11-05 00:21:19 +00:00
2022-09-15 06:47:04 +00:00
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.
2022-09-15 06:33:25 +00:00
And thanks to some further hard work from [xMasterX](https://github.com/xMasterX) of [Unleashed](https://github.com/DarkFlippers/unleashed-firmware), we now have MORE working applications!
2022-09-15 16:00:55 +00:00
2022-09-18 17:31:17 +00:00
Since the FAP file needs to be compiled to work with the specific firmware you have, I've separated the FAPs into their respective folders.<br>
2022-09-18 17:38:59 +00:00
**NOTE: Files are interchangeable between RM and UL! They are not interchangeable with Official firmware due to API differences.**
2022-09-15 06:39:52 +00:00
## How to use
Download the FAP file(s) of your choice and stick them in a folder names `apps` on the SD card. You can organize them into folders like they are on this repo however you would like! Please, move them around to what makes sense to you, create new folders, etc.
Once you have them loaded, make sure you're on the most current version of your [firmware of choice](https://github.com/UberGuidoZ/Flipper/tree/main/Firmware_Options) (dev branch in most cases), then look for the Applications menu item:
![App_Main](https://user-images.githubusercontent.com/57457139/190332031-d7524a5f-8d02-4ae8-a21d-a2aa487eae9c.png)
Hit the center button to load it and you should see your folders from above:
![App_Folders](https://user-images.githubusercontent.com/57457139/190332247-cb1993ed-f898-4810-9aad-fe8ec134a96f.png)
Now simply navigate to the application you'd like to load and center click it!
![App_Game](https://user-images.githubusercontent.com/57457139/190332433-907e609c-c1d0-490f-b3f7-d30e9dbda50a.png)
To exit and/or load something else, simply use the BACK button.
2022-09-15 16:59:54 +00:00
2022-12-20 18:28:28 +00:00
-----
# Building applications
## Here are some resources on getting started creating and building FAPS.
2023-01-05 23:07:07 +00:00
### Official documentation
2022-12-20 18:28:28 +00:00
https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/AppsOnSDCard.md
2023-01-05 23:07:07 +00:00
### Dev documentation by at-manos
https://flipper.atmanos.com/docs/category/overview
2022-12-20 18:28:28 +00:00
### Flipper plugin tutorial
2023-01-06 06:35:39 +00:00
By DroomOne: https://github.com/DroomOne/Flipper-Plugin-Tutorial
2023-01-05 23:07:07 +00:00
2023-01-06 06:35:39 +00:00
By giolaq: https://blog.giolaq.dev/hello-world-of-flipper-zero <br>
The repo that goes with giolaq's blog: https://github.com/giolaq/helloflipper
2022-12-20 18:28:28 +00:00
2023-01-06 06:35:39 +00:00
By csBlueChip: https://github.com/csBlueChip/FlipperZero_plugin_howto
2022-12-20 18:28:28 +00:00
## Hello world examples
2023-01-06 06:35:39 +00:00
By zmactep: https://github.com/zmactep/flipperzero-hello-world <br>
By ASoldo: https://github.com/ASoldo/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>
2022-12-20 18:28:28 +00:00
2022-09-15 16:59:54 +00:00
-----
2022-12-02 03:23:44 +00:00
## Donation Information
Nothing is ever expected for the hoarding of digital files, creations I have made, or the people I may have helped.
## Ordering from Lab401? [USE THIS LINK FOR 5% OFF!](https://lab401.com/r?id=vsmgoc) (Or code `UberGuidoZ` at checkout.)
2022-09-15 16:59:54 +00:00
I've had so many asking for me to add this.<br>
![Flipper_Blush](https://user-images.githubusercontent.com/57457139/183561666-4424a3cc-679b-4016-a368-24f7e7ad0a88.jpg) ![Flipper_Love](https://user-images.githubusercontent.com/57457139/183561692-381d37bd-264f-4c88-8877-e58d60d9be6e.jpg)
**BTC**: `3AWgaL3FxquakP15ZVDxr8q8xVTc5Q75dS`<br>
**BCH**: `17nWCvf2YPMZ3F3H1seX8T149Z9E3BMKXk`<br>
**ETH**: `0x0f0003fCB0bD9355Ad7B124c30b9F3D860D5E191`<br>
**LTC**: `M8Ujk52U27bkm1ksiWUyteL8b3rRQVMke2`
2023-01-12 08:32:55 +00:00
**PayPal**: `uberguidoz@gmail.com`
2022-09-15 16:59:54 +00:00
So, here it is. All donations of *any* size are humbly appreciated.<br>
![Flipper_Clap](https://user-images.githubusercontent.com/57457139/183561789-2e853ede-8ef7-41e8-a67c-716225177e5d.jpg) ![Flipper_OMG](https://user-images.githubusercontent.com/57457139/183561787-e21bdc1e-b316-4e67-b327-5129503d0313.jpg)
Donations will be used for hardware (and maybe caffeine) to further testing!<br>
2023-01-12 08:32:55 +00:00
![UberGuidoZ](https://cdn.discordapp.com/emojis/1000632669622767686.gif)