liz/flipperzero-firmware
liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d147190d61
flipperzero-firmware/assets
History
Mewa 55b4ff8e0c
Documentation: fixed outdated naming (#1518) 
* Documentation: fixed outdated naming: changed outdated naming in assets/dolphin/ReadMe. `essential -> blocking`
* Updated naming convencion in assets/ReadMe file and assets/dolphin/ReadMe file

Co-authored-by: あく <alleteam@gmail.com>
2022-08-06 00:12:13 +09:00
..
dolphin Documentation: fixed outdated naming (#1518) 2022-08-06 00:12:13 +09:00
icons Assets: unused assets removed (#1514) 2022-08-02 14:24:42 +03:00
protobuf@cc5918dc48 RPC App: state message and GUI update (#1423) 2022-07-25 23:16:45 +09:00
resources ci: check for uncommited changes after build (#1461) 2022-08-02 22:29:16 +09:00
slideshow [FL-2692, FL-2604, FL-2632] New first start sequence (#1456) 2022-07-26 21:44:03 +09:00
unit_tests [FL-2601] Move Infrared unit test data to assets (#1396) 2022-07-17 18:21:56 +09:00
.gitignore [FL-2269] Core2 OTA (#1144) 2022-04-27 18:53:48 +03:00
ReadMe.md Documentation: fixed outdated naming (#1518) 2022-08-06 00:12:13 +09:00
SConscript ci: check for uncommited changes after build (#1461) 2022-08-02 22:29:16 +09:00

ReadMe.md

Requirements

  • Python3
  • Python3 packages: Pillow & heatshrink2

Compiling

./fbt icons proto dolphin_internal dolphin_blocking dolphin_ext resources

Compiling with Docker-Compose

docker-compose exec dev ./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.