mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2024-12-24 22:07:14 +03:00
ecab4d53d2
* Add doxygen and doxygen-awesome css, cleanup docs files * Ignore more libraries and remove leftover local variables * Create an actual intro page * .md files linting * Add doxygen action * Fix Doxygen path * Fix doxyfile path * Try to upload * Change docs branch * Add submudules checkout * Disable doxygen on PR * Mention the firmware docs in the readme * More dev docs mentions in the readme * Fix runner group, add tags * Test dev in PR * Disable running on PR * Fix a typo in the doxyfile * Try upload to S3 * Fix local path * Fix S3 ACL * Add delete flag, unifying dev and tags * Update ignored directories * More ignored directories * Even more ignored directories * Fix submodule * Change S3 uploader * Change S3 uploader version * Fix aws sync flags * Fix ACL * Disable ACL * Improve ignores, add WiFi devboard docs * TEMP: generate dev docs * TEMP: generate 0.89.0 docs * Disabling PR trigger * Enable submodules and test build * Enable test build * Disable test build * Change docs directory structure * Fix accidentally committed submodule * Fix submodules * Update links to the developer documentation * Markdown linting * Update workflow, enable test build * Fix doxygen dir path * Update Doxyfile-awesome.cfg * Change paths * Fix upload docs path * Disable pull_request debug trigger * Disable tags building * Remove autolinks and namespaces * Establish basic documentation structure * Add missing changes * Improve stylesheet, move some files * Improve examples * Improve the main page * Improve application dev docs * Improve system programming docs * Improve development tools docs * Improve other docs * Improve application examples * Fix formatting * Fix PVS-studio warnings * Improve visuals * Fix doxygen syntax warnings * Fix broken links * Update doxygen action Co-authored-by: DrunkBatya <drunkbatya.js@gmail.com> Co-authored-by: あく <alleteam@gmail.com> Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com> Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Firmware Assets {#firmware_assets}
|
|
|
|
## Requirements
|
|
|
|
- Python3
|
|
- Python3 packages: Pillow & heatshrink2
|
|
|
|
## Compiling
|
|
|
|
```bash
|
|
./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
|
|
- `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.
|
|
- `slideshow` - One-time slideshows for desktop
|