flipperzero-firmware/assets
Albert Kharisov 84410c83b5
[FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965)
* Desktop: cleanup headers
* Get loader pubsub via record
* [FL-2183] Dolphin refactoring 2022.01
* Restruct animations assets structure
* Rename assets
* Cleanup headers
* Update Recording animation
* Add BadBattery animation
* Provide loader's pubsub via record
* Fix load/unload animations
* Scripts: add flipper format support, initial dolphin packager rework. Assets: internal and external dolphin.
* Sync internal meta.txt and manifest.txt
* Reorder, rename dolphin assets
* Split essential generated assets
* Add ReadMe for dolphin assets
* Separate essential blocking animations
* Scripts: full dolphin validation before packaging
* Assets, Scripts: dolphin external resources packer
* Github: update codeowners
* Scripts: proper slots handling in dolphin animation meta
* Scripts: correct frames enumeration and fix compiled assets.
* [FL-2209] Add Dolphin Deeds points and many more
* Remove excess frame_rate
* Change dolphin assets directory
* Scripts: add internal resource support to dolphin compiler
* Scripts: add internal assets generation, renaming
* Scripts: correct assert, renaming
* Code cleanup, documentation, fixes
* Update Levelup animations
* Rename essential -> blocking
* Fix Unlocked hint
* Scripts: rewrite Templite compiller, replace regexps with token parser, split block types into code and variable blocks. Update dolphin templates.
* Documentation: add key combos description and use information
* Scripts: cleanup templit, more debug info and add dev comment

Co-authored-by: あく <alleteam@gmail.com>
2022-01-29 12:20:41 +03:00
..
compiled [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
dolphin [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
icons [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
protobuf@93b9cf3af7 Add protobuf versioning (#954) 2022-01-12 16:12:40 +03:00
resources [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
.gitignore Assets, Icons, UI toolkit. Part 1. (#202) 2020-10-26 20:00:17 +03:00
assets.mk [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
Makefile [FL-2183] [FL-2209] Dolphin Deeds, Level up, assets generation, refactoring (#965) 2022-01-29 12:20:41 +03:00
ReadMe.md [FL-2188] Fix Desktop crush: stub dolphin stats (#950) 2022-01-10 22:46:20 +03:00

Requirements

  • Python3
  • ImageMagic
  • Make

Compiling

make all

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 for compiled assets.
  • dolphin - Dolphin game assets sources. Goes to compiled and resources folders.
  • icons - Icons sources. Goes to compiled folder.
  • protobuf - Protobuf sources. Goes to compiled folder.
  • resources - Assets that is going to be provisioned to SD card.