Mirrors/unleashed-firmware
2
0
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware synced 2024-12-12 06:02:28 +00:00
Code Issues Projects Releases Packages Wiki Activity
unleashed-firmware/assets/ReadMe.md

1.5 KiB
Raw Blame History

Requirements

  • Python3
  • ImageMagic
  • Make

Compiling

make all

Compiling with Docker-Compose

docker-compose exec dev make -C assets clean
docker-compose exec dev make -C assets 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.