DarkFlippers/unleashed-firmware
1
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2024-12-29 00:09:19 +03:00
Code Issues Projects Releases Wiki Activity
0b806c2360
unleashed-firmware/assets
History
Sergey Gavrilov 809418b9da
[FL-3563] StorageListRequest: size filter (#3018) 
* Protobuf: size filter
* Update protobuf
* Scripts: types for fwflash.py
* RPC: handle fliter for StorageListRequest
* RPC: StorageListRequest tests for filtering
* Fix unit tests configuration
* Assets: sync protobuf with upstream

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-09-01 10:23:37 +09:00
..
dolphin [FL-3480] Add the Sad song animation (#2973) 2023-08-11 01:31:01 +09:00
icons [FL-3580] AC OFF button (#3010) 2023-08-26 01:09:40 +09:00
protobuf@327163d586 [FL-3563] StorageListRequest: size filter (#3018) 2023-09-01 10:23:37 +09:00
resources More apps moved to apps repo (#2978) 2023-08-24 02:50:17 +09:00
slideshow Fixed first start animation typo (#2384) 2023-02-17 17:17:57 +09:00
unit_tests [FL-3461] RPC: md5 in storage list (#2929) 2023-08-09 06:34:54 +09:00
.gitignore [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
ReadMe.md Amap and PVS Studio reports in CI/CD (#1526) 2022-08-23 20:29:26 +09:00
SConscript [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00

ReadMe.md

Requirements

  • Python3
  • Python3 packages: Pillow & heatshrink2

Compiling

./fbt icons proto dolphin_internal dolphin_blocking dolphin_ext resources

Asset naming rules

Images and Animations

NAME_VARIANT_SIZE

  • NAME - mandatory - Asset name in CamelCase. [A-Za-z0-9], special symbols not allowed
  • VARIANT - optional - icon variant: can relate to state or rendering conditions. Examples: active, inactive, inverted.
  • SIZE - mandatory - size in px. Example square 10, 20, 24, etc. Example rectangular: 10x8, 19x5, etc.

Image names will be automatically prefixed with I_, animation names with A_. Icons and Animations will be gathered into icon.h and icon.c.

Dolphin and Games assets

Rules are same as for Images and Animations plus assets are grouped by level and level prepends NAME. Good starting point: https://docs.unrealengine.com/4.27/en-US/ProductionPipelines/AssetNaming/

Important notes

Don't include assets that you are not using, compiler is not going to strip unused assets.

Structure

  • compiled - Output folder made for compiled assets, after building project, in build directory.
  • dolphin - Dolphin game assets sources. Goes to compiled and resources folders in build directory.
  • icons - Icons sources. Goes to compiled folder in build directory.
  • protobuf - Protobuf sources. Goes to compiled folder in build directory.
  • resources - Assets that is going to be provisioned to SD card.
  • slideshow - One-time slideshows for desktop
  • unit_tests - Some pre-defined signals for testing purposes.