add a default font #8445

mockersf · 2023-04-19T22:20:26Z

Objective

Have a default font

Solution

Add a font based on FiraMono containing only ASCII characters and use it as the default font
It is behind a feature default_font enabled by default
I also updated examples to use it, but not UI examples to still show how to use a custom font

Changelog

If you display text without using the default handle provided by TextStyle, the text will be displayed

IceSentry · 2023-04-19T22:31:54Z

Is there any kind of licensing concerns when distributing a font like that?

alice-i-cecile

I think this is an important enough UX win that I'm fine to eat the cost of having this on by default.

Feature flag means that in real projects this is actually zero cost. This is by far the simplest solution to this problem, and will make prototyping and examples much quicker.

alice-i-cecile · 2023-04-19T22:50:10Z

The font appears to already be listed in https://github.com/bevyengine/bevy/blob/main/CREDITS.md. The license for them does not appear to impose any relevant restrictions, either to us or to downstream users.

UkoeHB · 2023-04-20T00:35:16Z

Can you configure the default font for your entire app?

alice-i-cecile · 2023-04-20T01:42:32Z

No: this is baked into the source code of Bevy (when using the provided feature flag). Better theming support is also important, but this feature is strictly intended for easy debugging and teaching.

nicopap · 2023-04-20T06:45:01Z

mockersf · 2023-04-20T07:05:03Z

Can you configure the default font for your entire app?

Yes, if you set the default font handle to another font, it will be used by default in your app. But then that doesn't depend on this PR, this already works...

Something like:

use bevy::prelude::*;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_systems(Startup, setup)
        .add_systems(
            Update,
            set_default_font.run_if(resource_exists::<FontHandle>()),
        )
        .run();
}

#[derive(Resource)]
struct FontHandle(Handle<Font>);

fn set_default_font(
    mut commands: Commands,
    mut fonts: ResMut<Assets<Font>>,
    font_handle: Res<FontHandle>,
) {
    if let Some(font) = fonts.remove(&font_handle.0) {
        fonts.set_untracked(TextStyle::default().font, font);
        commands.remove_resource::<FontHandle>();
    }
}

fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
    let font = asset_server.load("fonts/FiraSans-Bold.ttf");
    commands.insert_resource(FontHandle(font));
}

crates/bevy_text/src/text.rs

cart

Generally in favor of this. Glad you could slim the fira font down so much!

crates/bevy_text/src/lib.rs

cart · 2023-04-20T20:27:35Z

crates/bevy_text/src/lib.rs

@@ -67,6 +73,10 @@ pub enum YAxisOrientation {
    BottomToTop,
 }

+#[cfg(feature = "default_font")]
+pub const DEFAULT_FONT_HANDLE: HandleUntyped =


I agree with @UkoeHB: I think this should not be behind a feature flag so other people can set the default font (without needing to include the fira default font). I think "default fonts" should be supported without flags and the current default_font feature should be default_font_fira_sans or something similar.

nicoburns · 2023-04-20T20:36:54Z

What was the motivation behind choosing a monospace font as the default? Don't most people typically want to use proportional fonts?

cart · 2023-04-20T20:43:29Z

Debug UIs: more likely to prefer monospace (but could probably get away with proportional)
Short text labels in game: probably proportional
Long form text: almost certainly proportional

I suspect "real game uis" will most often want proportional, but "real game uis" will also probably want their own fonts.
I think we might actually want proportional here. If the rationale is "provide a good font for debug uis" we should do a side-by-side comparison.

alice-i-cecile · 2023-04-20T21:37:01Z

Oh right: proportional fonts will have additional bugs, so at least internally we probably want to use a proportional one for testing.

mockersf · 2023-04-20T21:48:57Z

What was the motivation behind choosing a monospace font as the default? Don't most people typically want to use proportional fonts?

For a placeholder / debug font, it seemed more natural to me

cart · 2023-04-21T21:27:47Z

I think proportional will probably have my vote, but I also dont think we need to make that call now. Once comments are resolved I see no reason not to merge this. We can always swap out later.

nicoburns · 2023-04-21T21:29:22Z

I think proportional will probably have my vote, but I also dont think we need to make that call now. Once comments are resolved I see no reason not to merge this. We can always swap out later.

Same here on both counts. Proportional seems like a better default to me (but I don't feel super-strongly about this), and in any case this is easy to change later and need not block this PR.

IceSentry · 2023-04-21T21:35:18Z

Personally, I saw this as more of a debug tool and I prefer mono for that.

Maybe have a default_font_mono and default_font_proportional feature? I don't think this is a great solution, but it could work.

mockersf · 2023-04-21T21:46:22Z

Another reason for mono: I may have messed up, but my "small" FiraSans font is 39kB while FiraMono ends up at 19kB

crates/bevy_text/src/text.rs

cart · 2023-04-21T22:07:02Z

Another reason for mono: I may have messed up, but my "small" FiraSans font is 39kB while FiraMono ends up at 19kB

Hmm yeah thats a big difference. Lets stick with mono for now and we can make a call later

superdump · 2023-04-22T10:05:46Z

I saw this and immediately thought ‘great! Now we can implement debug plugins with UI overlays!’

# Objective - Fixes #8484 ## Solution Since #8445 fonts need to register a debug asset, otherwise the `debug_asset_server` feature doesn't work. This adds the debug asset registration

aevyrie · 2023-05-10T19:44:34Z

Also in favor of mono. Whenever I need debug overlays, I need to render numbers, and mono is necessary to make those overlays useful.

Mono: easy text alignment for comparing numeric values, numbers don't jump around, longer text isn't as nice to look at.
Proportional: text alignment is impossible for numeric values, text looks nicer.

I think this makes mono much better fit for purpose.

djeedai · 2023-06-21T19:38:07Z

crates/bevy_internal/Cargo.toml

@@ -97,6 +97,8 @@ bevy_render = ["dep:bevy_render", "bevy_scene?/bevy_render"]
 # Enable assertions to check the validity of parameters passed to glam
 glam_assert = ["bevy_math/glam_assert"]

+default_font = ["bevy_text?/default_font"]


@mockersf is that ? a typo or a special syntax I don't know? 😊

Not a typo! https://doc.rust-lang.org/cargo/reference/features.html#dependency-features

it means "enable default_font feature of optional crate bevy_text only if the crate is enabled from another feature, otherwise just ignore it"

Sweet, I didn't know about that feature, quite useful. Thanks!

add a default font

55424ca

mockersf 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 labels Apr 19, 2023

alice-i-cecile approved these changes Apr 19, 2023

View reviewed changes

nicopap approved these changes Apr 20, 2023

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Apr 20, 2023

IceSentry approved these changes Apr 20, 2023

View reviewed changes

IceSentry mentioned this pull request Apr 20, 2023

add FontRef and DefaultFont #5549

Closed

alice-i-cecile added the X-Controversial There is active debate or serious implications around merging this PR label Apr 20, 2023

UkoeHB suggested changes Apr 20, 2023

View reviewed changes

crates/bevy_text/src/text.rs Outdated Show resolved Hide resolved

cart reviewed Apr 20, 2023

View reviewed changes

mockersf added 2 commits April 21, 2023 23:32

reviews

0b85286

flag not needed anymore

6bc7900

cart reviewed Apr 21, 2023

View reviewed changes

crates/bevy_text/src/text.rs Outdated Show resolved Hide resolved

missed a feature check to remove

be628f2

cart approved these changes Apr 21, 2023

View reviewed changes

cart added this pull request to the merge queue Apr 21, 2023

Merged via the queue into bevyengine:main with commit e0e5f3a Apr 21, 2023

nicopap mentioned this pull request Apr 25, 2023

Fix panic when using debug_asset_server #8485

Merged

ickshonpe mentioned this pull request Jun 16, 2023

impl From<String> and From<&str> for TextSection #8856

Merged

djeedai reviewed Jun 21, 2023

View reviewed changes

This was referenced Jun 28, 2023

News: Release 0.11 (wrong branch ... see #657) bevyengine/bevy-website#656

Closed

News: Release 0.11 bevyengine/bevy-website#657

Merged

rparrett mentioned this pull request Feb 29, 2024

No convenient way to set default assets through the AssetServer #12192

Open

DJMcNab mentioned this pull request Jul 22, 2024

refactor: add default_font, change font api linebender/bevy_vello#66

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add a default font #8445

add a default font #8445

mockersf commented Apr 19, 2023

IceSentry commented Apr 19, 2023

alice-i-cecile left a comment

alice-i-cecile commented Apr 19, 2023

UkoeHB commented Apr 20, 2023

alice-i-cecile commented Apr 20, 2023

nicopap commented Apr 20, 2023 •

edited

Loading

mockersf commented Apr 20, 2023 •

edited

Loading

cart left a comment

cart Apr 20, 2023

nicoburns commented Apr 20, 2023

cart commented Apr 20, 2023

alice-i-cecile commented Apr 20, 2023

mockersf commented Apr 20, 2023

cart commented Apr 21, 2023

nicoburns commented Apr 21, 2023

IceSentry commented Apr 21, 2023

mockersf commented Apr 21, 2023

cart commented Apr 21, 2023

superdump commented Apr 22, 2023

aevyrie commented May 10, 2023 •

edited

Loading

djeedai Jun 21, 2023

mockersf Jun 21, 2023 •

edited

Loading

djeedai Jun 21, 2023

add a default font #8445

add a default font #8445

Conversation

mockersf commented Apr 19, 2023

Objective

Solution

Changelog

IceSentry commented Apr 19, 2023

alice-i-cecile left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Apr 19, 2023

UkoeHB commented Apr 20, 2023

alice-i-cecile commented Apr 20, 2023

nicopap commented Apr 20, 2023 • edited Loading

mockersf commented Apr 20, 2023 • edited Loading

cart left a comment

Choose a reason for hiding this comment

cart Apr 20, 2023

Choose a reason for hiding this comment

nicoburns commented Apr 20, 2023

cart commented Apr 20, 2023

alice-i-cecile commented Apr 20, 2023

mockersf commented Apr 20, 2023

cart commented Apr 21, 2023

nicoburns commented Apr 21, 2023

IceSentry commented Apr 21, 2023

mockersf commented Apr 21, 2023

cart commented Apr 21, 2023

superdump commented Apr 22, 2023

aevyrie commented May 10, 2023 • edited Loading

djeedai Jun 21, 2023

Choose a reason for hiding this comment

mockersf Jun 21, 2023 • edited Loading

Choose a reason for hiding this comment

djeedai Jun 21, 2023

Choose a reason for hiding this comment

nicopap commented Apr 20, 2023 •

edited

Loading

mockersf commented Apr 20, 2023 •

edited

Loading

aevyrie commented May 10, 2023 •

edited

Loading

mockersf Jun 21, 2023 •

edited

Loading