Lib.rs

› bones_framework › Features

Cargo Features

[dependencies]
bones_framework = { version = "0.4.0", default-features = false, features = ["ui", "localization", "logging", "audio", "scripting", "net-debug", "audio_ogg", "audio_mp3", "audio_flac", "audio_wav", "image_png", "image_jpeg", "image_webp", "image_tiff", "image_gif", "image_ico", "image_bmp", "debug-network-slowdown", "tracing-tracy", "document-features"] }
default = audio, audio_ogg, image_png, localization, logging, scripting, ui

These default features are set whenever bones_framework is added without default-features = false somewhere in the dependency tree.

ui default net-debug?

Cargo feature supported in bones_framework.

Enable the ui module, powered by egui.

Enables egui ^0.23 and ttf-parser ^0.24

egui:

Gui

Affects bones_framework::debug, render::ui…

localization default

Enable the localization module, powered by fluent.

Enables fluent ^0.15, fluent-langneg ^0.13, intl-memoizer, sys-locale, and unic-langid

fluent:

Localization

Affects bones_framework::localization…

logging default tracing-tracy?

Enables tracing-appender, tracing-subscriber, and tracing-wasm

Affects bones_framework::logging…

audio default

Enable the audio system.

Enables kira

Audio

Affects bones_framework::audio…

scripting default

Enable the scripting system.

Enables bones_scripting

net-debug = ui

Enable networking debug window + frame prediction history.

Affects networking::debug…

audio_ogg default

Audio formats

These features enable different audio formats

Enable OGG audio loader.

Enables ogg of kira

audio_mp3

Enable MP3 audio loader.

Enables mp3 of kira

audio_flac

Enable the FLAC audio loader.

Enables flac of kira

audio_wav

Enable the WAV audio loader.

Enables wav of kira

image_png default

Image Formats

These features enable different image formats.

If there is an image format that you need that is not in the list, you may check the supported formats list. If the format you need is in the list, please open an issue and we can add a feature for it.

Enable PNG image loader.

Enables png of image ^0.24

Sprite

image_jpeg

Enable JPEG image loader.

Enables jpeg of image ^0.24

image_webp

Enable WEBP image loader.

Enables webp of image ^0.24

image_tiff

Enable TIFF image loader.

Enables tiff of image ^0.24

image_gif

Enable GIF image loader.

Enables gif of image ^0.24

image_ico

Enable ICO image loader.

Enables ico of image ^0.24

image_bmp

Enable BMP image loader.

Enables bmp of image ^0.24

debug-network-slowdown

Debuging Features

Simulate dramatic network latency by inserting random sleeps into the networking code. This is extremely cheap and hacky but may be useful.

tracing-tracy = logging

Enables tracy tracing subscriber to capture tracing spans for profiling with Tracy.

Note that bones is primarily instrumented with puffin scopes, tracy only captures tracing spans. This flag only enables span capture in logging plugin, bevy/trace_tracy may be used to enable tracy.

Enables tracing-tracy

document-features

Enables document-features

API docs