Add a default font #1790

jihiggins · 2021-03-31T17:53:28Z

Adds a default font under a new "bevy_default_assets" feature flag. Used FiraSans-Bold since it's used in most of the examples as the default font. Resolves #1017

alice-i-cecile

This is a really clean implementation of a simple idea. Should speed up prototyping nicely and streamline the beginner experience.

The only thing I think should be discussed more is what we want to use for the default font. Something with nice variants, like Recursive would be handy for being able to quickly test various font weights / styles.

jakobhellermann · 2021-03-31T18:00:57Z

The way this is implemented it will require the user to have the font in their assets directory, right?
I think either the font should be bundled or we should load the system fonts (#1325).

If we bundle the font we also need to make sure the size increase isn't to big and there are no licensing issues.

alice-i-cecile · 2021-03-31T18:05:15Z

Can we mitigate the file size issue by using the feature gate on default assets like this PR does?

jihiggins · 2021-03-31T19:54:25Z

The way this is implemented it will require the user to have the font in their assets directory, right?
I think either the font should be bundled or we should load the system fonts (#1325).

If we bundle the font we also need to make sure the size increase isn't to big and there are no licensing issues.

right now it's just be part of the crate source basically, it's using the include_bytes macro. i think that means if the feature gate is disabled it won't be in the compiled exe

i assumed there were no licensing issues because it's already in the repo, but i didn't actually check 👀

This is a really clean implementation of a simple idea. Should speed up prototyping nicely and streamline the beginner experience.

The only thing I think should be discussed more is what we want to use for the default font. Something with nice variants, like Recursive would be handy for being able to quickly test various font weights / styles.

ya, although if we don't change the font in the examples, could also have more than one included font? also, i didn't change the areas that used firasans-medium just to make sure there's an example of loading a new font asset

edit:

i think this is the license https://github.com/bBoxType/FiraSans/blob/master/OFL.txt
seems fine?

re: which font to use, one option is just stick w/ this since it's already used throughout the examples, and open another issue / rfc to decide on a font / set of fonts?

DJMcNab

Good idea - I think we should have this.

DJMcNab · 2021-04-08T14:34:12Z

crates/bevy_text/src/text.rs

+    use bevy_app::AppBuilder;
+    use bevy_asset::Assets;
+
+    pub(crate) fn load_default_font(app: &mut AppBuilder) {


Why is this not a startup system?

DJMcNab · 2021-04-08T14:36:36Z

examples/ui/text_debug.rs

-fn infotext_system(mut commands: Commands, asset_server: Res<AssetServer>) {
-    let font = asset_server.load("fonts/FiraSans-Bold.ttf");
+fn infotext_system(mut commands: Commands) {
+    let font = DEFAULT_FONT_HANDLE.typed();


I think this variable is no longer needed.

if you want to change something back to that font youd need it

Can replace its TextStyle with a style using ..TextStyle::Default?

i guess? i don't really see why it matters / quad_handle works the same way, why not just leave it exposed

I guess it's just that the mechanism is weird, especially the .typed() thing

I'm not saying not to leave it exposed, I'm more suggesting not to use it in the example.

ah, fair point

DJMcNab · 2021-04-08T14:44:26Z

crates/bevy_text/src/text.rs

+        let world = app.world_mut();
+        let world_cell = world.cell();
+        let mut fonts = world_cell.get_resource_mut::<Assets<Font>>().unwrap();
+        let font_bytes = include_bytes!("assets/fonts/FiraSans-Bold.ttf");


This adds ~500KB to the size of the bevy_text package (currently lib.rs thinks it is 1.5MB, so an additional 1/3).

In theory, we should have this in a different crate, however because the amount of metadata needed for creating a crate anyway, it might not be worthwhile, if 95% of people leave the default font in.

maybe a default assets crate? if other fonts / binary assets get added, could go in the same one?

cart · 2021-04-13T03:01:47Z

I'm not yet completely sold on this implementation. This creates a situation where all Bevy apps come packaged with a default font, unless they specifically opt out. I expect that "cargo features" generally aren't something most people will think about when publishing their game, so this will likely result in some high percentage of Bevy apps including extra font bytes (90 percent? 99 percent?). Imo we should be as lean as possible by default.

Some alternatives to discuss:

Bundle this into the (yet to be implemented) Bevy Editor instead, with some gui tool that makes it easy to add "default" fonts to a project's asset folder
Make this a separate crate (not provided by the default bevy distribution) and provide a plugin that can be easily dropped in to apps. The plugin could set the "default" font asset, which should make Bundles with font assets work by default.
Choose some hyper-minimalist font that takes up no space.

bjorn3 · 2021-04-13T05:50:34Z

Load font from the system the same way most programs do.

mockersf · 2021-04-13T07:06:31Z

Load font from the system the same way most programs do.

font-kit would let us do that, but currently has many dependencies/parts we don't need
see servo/font-kit#180

cart · 2021-05-06T02:51:19Z

Closing this out as I think the other options (1-4) are all preferable.

jihiggins added 2 commits March 31, 2021 14:40

Add a default font and a bevy_default_assets feature flag

fe7f011

Update examples to use default font where possible

a216ee7

alice-i-cecile added A-Assets Load files from disk to use for things like images, models, and sounds A-UI Graphical user interfaces, styles, layouts, and widgets C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Mar 31, 2021

alice-i-cecile approved these changes Mar 31, 2021

View reviewed changes

jihiggins force-pushed the default_font branch 4 times, most recently from 6b6bb33 to 0acc9c0 Compare March 31, 2021 20:16

Various CI fixes

1a9d9ac

jihiggins force-pushed the default_font branch from 0acc9c0 to 1a9d9ac Compare March 31, 2021 20:34

DJMcNab reviewed Apr 8, 2021

View reviewed changes

cart closed this May 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a default font #1790

Add a default font #1790

jihiggins commented Mar 31, 2021

alice-i-cecile left a comment

jakobhellermann commented Mar 31, 2021

alice-i-cecile commented Mar 31, 2021

jihiggins commented Mar 31, 2021 •

edited

Loading

DJMcNab left a comment

DJMcNab Apr 8, 2021

DJMcNab Apr 8, 2021

jihiggins Apr 8, 2021

DJMcNab Apr 8, 2021

jihiggins Apr 8, 2021

DJMcNab Apr 8, 2021

jihiggins Apr 8, 2021

DJMcNab Apr 8, 2021

jihiggins Apr 8, 2021

cart commented Apr 13, 2021

bjorn3 commented Apr 13, 2021

mockersf commented Apr 13, 2021 •

edited

Loading

cart commented May 6, 2021

Add a default font #1790

Add a default font #1790

Conversation

jihiggins commented Mar 31, 2021

alice-i-cecile left a comment

Choose a reason for hiding this comment

jakobhellermann commented Mar 31, 2021

alice-i-cecile commented Mar 31, 2021

jihiggins commented Mar 31, 2021 • edited Loading

DJMcNab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cart commented Apr 13, 2021

bjorn3 commented Apr 13, 2021

mockersf commented Apr 13, 2021 • edited Loading

cart commented May 6, 2021

jihiggins commented Mar 31, 2021 •

edited

Loading

mockersf commented Apr 13, 2021 •

edited

Loading