Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In-depth documentation on loading custom fonts #1171

Open
pushfoo opened this issue Apr 5, 2022 · 3 comments
Open

In-depth documentation on loading custom fonts #1171

pushfoo opened this issue Apr 5, 2022 · 3 comments

Comments

@pushfoo
Copy link
Member

pushfoo commented Apr 5, 2022

Documentation request:

What documentation needs to change?

A number of text-related locations need to link to a new tutorial covering:

  1. Why you should ship fonts with your game
  2. Suggestions for where to find fonts, good licenses, and how to comply with them
  3. Common hang-ups, such as figuring out the correct name of a font
  4. Suggestions for a good directory structure
  5. A finished example, with directory structure

Where is it located?

Existing doc that needs to link the new tutorial can be found here:

Function / Object Location in Source
arcade.Text arcade/text_pyglet.py, Line 17
arcade.load_font arcade/text_pyglet.py, Line 121
arcade.gui.UILabel arcade/gui/widgets.py, Line 724
arcade.gui.UITextArea arcade/gui/widgets.py, Line 894

What is wrong with it? How can it be improved?

While helping a user, it seemed like they thought you could only use fonts shipped with arcade, and didn't understand that you can use arbitrary TTF fonts.

Also, I was confused while helping them because some font viewers (Gnome) include font weights when displaying names ("Grand Hotel, Regular" instead of "Grand Hotel" as expected by arcade.Text). Ordinary users will probably have a lot of trouble trouble with this.

In my experience, asset licensing has also been a consistent hangup when dealing with game jams or hackathons. It would be helpful if we gave users the following:

  1. a recommended place where users can find permissively licensed fonts
  2. information on how to comply with licenses such as the SIL Open Font License

This will prevent them from getting disqualified from restrictive game jams such as pyweek and give them more flexibility than anything we ship with arcade to address #1135 or #1011 .

@pvcraven
Copy link
Member

pvcraven commented Apr 6, 2022

This is where having a 'manual' to house longer discussions would be nice.

@pushfoo
Copy link
Member Author

pushfoo commented Aug 15, 2022

Users are still having issues with the font file's name vs the font file. It may be worth bundling a tool to help with this.

@einarf
Copy link
Member

einarf commented Jul 12, 2024

We should link to the pyglet documentation as much as possible. Spending time documenting it in pyglet is a better use of everyone's time. We can mention it in a section about text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants