| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:orx:config:settings_structure:orxtext [2017/05/29 21:50 (7 years ago)] – external edit 127.0.0.1 | en:orx:config:settings_structure:orxtext [2023/08/25 01:09 (8 months ago)] (current) – [Details] sausage |
|---|
| |
| <code ini>[TextTemplate] | <code ini>[TextTemplate] |
| | String = "string to display" |
| Font = FontTemplate | Font = FontTemplate |
| String = <string></code> | </code> |
| |
| === Font === | === Font === |
| |
| <code ini>[FontTemplate] | <code ini> |
| Texture = path/to/ImageFile | [FontTemplate] |
| TextureOrigin = <vector> | Texture = path/to/ImageFile.ext |
| TextureSize = <vector> | TextureOrigin = <vector> |
| CharacterList = <string> | TextureSize = <vector> |
| CharacterSpacing = <vector> | KeepInCache = <bool> |
| CharacterSize = <vector> | CharacterList = "ordered list of character" |
| CharacterHeight = <float> | CharacterSize = <vector> |
| CharacterWidthList= <float> # <float> ...</code> | CharacterHeight = <float> |
| | CharacterWidthList = <float> |
| | CharacterSpacing = <vector> |
| | </code> |
| |
| ==== Details ==== | ==== Details ==== |
| |
| Here's a list of available properties for an ''orxTEXT'' structure: | Here's a list of available properties for an ''orxTEXT'' structure: |
| * ''Font'': Specifies a font to use for this text. If no value is specified, orx's default font ((Dina, an open source font by Jørgen 'Jibs' Ibsen)) will be used. **NB: If its value begins with a dollar ('$'), the rest of the value will be used as a key for the [[en:orx:config:settings_main:main#Locale localization module|localization module]].** | |
| * ''String'': Defines the content of this orxTEXT as plain text. **NB: If its value begins with a dollar ('$'), the rest of the value will be used as a key for the [[en:orx:config:settings_main:main#Locale localization module|localization module]].** See below for an example of multiline text. | * ''String'': Defines the content of this orxTEXT as plain text. If this string begins with the character '$', it will be used as a locale key instead of as a plain text. It will then be automatically updated upon a new language selection. |
| | * ''Font'': Specifies a font to use for this text. If none is provided or 'default' is used, orx's default font will be used. If it begins with the character '$', it will be used as a [[en:orx:config:settings_main:main#Locale localization module|locale key]] instead of as a plain section name. It will then be automatically updated upon a new language selection. See below for an example of multiline text. |
| |
| Here's a small example. | Here's a small example. |
| |
| Here's a list of available properties for an ''orxFONT'' structure: | Here's a list of available properties for an ''orxFONT'' structure: |
| * ''Texture'': Specifies which bitmap file to use as texture for our font object. | |
| * ''TextureOrigin'': Specifies the top left origin of the first defined character in the bitmap file, in pixels (Z coordinate being ignored). By default its value is (0, 0, 0) which means the texture for the font object will begin at the top left of the bitmap file. Note: TextureSize must also be supplied for this to take effect. | * ''TextureOrigin'': Specifies the top left origin of the first defined character in the bitmap file, in pixels (Z coordinate being ignored). By default its value is (0, 0, 0) which means the texture for the font object will begin at the top left of the bitmap file. Note: TextureSize must also be supplied for this to take effect. |
| * ''TextureSize'': Specifies the size, in pixels, of the bitmap file where characters are defined (Z coordinate being ignored). By default it will use the whole bitmap, ie. its value will be the size of the bitmap. | * ''TextureSize'': Specifies the size, in pixels, of the bitmap file where characters are defined (Z coordinate being ignored). By default it will use the whole bitmap, ie. its value will be the size of the bitmap. |
| * ''CharacterList'': Specifies all the characters that are defined in the bitmap file, ie. all the characters with a glyph in the texture file will have to be specified in order of appearance. The string can be encoded in strict ANSI or UTF-8. **ISO-Latin-1 is __not__ supported!** To avoid special characters to be handled by orx's config parser ((such as '#', ';', '"', '~', '$', ...)), the string is likely to be defined as a block using the block marker ('"'). **In order to specify '"' itself in the string, this character needs to be doubled and not in the first position!** | * ''KeepInCache'': If true, the associated texture will always stay in cache. Defaults to false. |
| * ''CharacterSpacing'': A vector specifying the empty spaces between characters, in pixels (Z coordinate being ignored). | * ''CharacterList'': Specifies all the characters that are defined in the bitmap file, ie. all the characters with a glyph in the texture file will have to be specified in order of appearance. The string can be encoded in strict ANSI/ASCII or UTF-8. **ISO-Latin-1 is __not__ supported!** To avoid special characters to be handled by orx's config parser ((such as '#', ';', '"', '~', '$', ...)), the string is likely to be defined as a block using the block marker ('"'). **In order to specify '"' itself in the string, this character needs to be doubled and not in the first position!** |
| * ''CharacterSize'': A vector specifying the size of a character, in pixels (Z coordinate being ignored). **If this property is defined, orx assumes the font is monospaced (ie. fixed width, all the characters need to be organized in a grid manner). See the command line tool [[#orxFontGen]] to see how to create custom bitmap fonts from a given TrueType font file.** | * ''CharacterSize'': A vector specifying the size of a character, in pixels (Z coordinate being ignored). **If this property is defined, orx assumes the font is monospaced (ie. fixed width, all the characters need to be organized in a grid manner). See the command line tool [[#orxFontGen]] to see how to create custom bitmap fonts from a given TrueType font file.** If defined, CharacterHeight & CharacterWidthList will be ignored. |
| * ''CharacterHeight'': This is only used for variable width fonts, ie. when ''CharacterSize'' is **not** defined. In this case, this property has to be a strictly positive value that will be the font character's height. | * ''CharacterHeight'': This is only used for non-monospaced fonts, ie. when CharacterSize isn't defined. This property has to be a strictly positive value that will be the font character's height. |
| * ''CharacterWidthList'': Only used for variable width fonts, ie. when ''CharacterSize'' is **not** defined. In this case, this contains a list of widths for every character defined in ''CharacterList'' in the same order. | * ''CharacterWidthList'': This is only used for non-monospaced fonts, ie. when CharacterSize isn't defined. There should be exactly one value per character defined in CharacterList in the same order. |
| | * ''CharacterSpacing'': Empty space between characters, z is ignored. Defaults to (0, 0, 0). |
| An example of how to use custom fonts can be found in the [[tutorials:locale|localization]] tutorial ((at the end of 10_Locale.ini)). | |
| |
| | An example of how to use custom fonts can be found in the [[en:tutorials:localization:locale|localization]] tutorial ((at the end of 10_Locale.ini)). |
| |
| ===== orxFontGen ===== | ===== orxFontGen ===== |
| |
| orxFontGen is a command line tool that creates orx-formatted custom bitmap fonts (both .png texture and .ini config file).\\ | orxFontGen is a command-line tool that ships with Orx which allows you create bitmap fonts which can be define with the configuration detailed above. It can be found in the orx/tools/orxFontGen/bin folder. Available to compile for Windows, Linux and Mac. To learn how to use it follow the [[en:tutorials:text-fonts:orxfontgen|orxFontGen tutorial]]. |
| It gathers the needed characters from the given text files and print them, at the requested size, from a TrueType font file. | |
| | |
| orxFontGen is available for all supported development platforms. ((Windows, Linux, Mac OS X)) | |
| | |
| It is based on the open source [[http://www.freetype.org/|FreeType library]]. | |
| | |
| orxFontGen accepts a number of command line parameters: | |
| * [MANDATORY] a list of input text files to gather the needed characters | |
| * [MANDATORY] a TrueType font file ((usually .ttf)) | |
| * [MANDATORY] a size for characters to print, in pixels | |
| * [OPTIONAL] a name for the custom font to output | |
| * [OPTIONAL] the option to output monospace (ie. fixed width) characters no matter how the font was designed | |
| * [OPTIONAL] when creating a non-monospace font, the advance option tells it to pack them as tight as possible or to use the metrics defined in the font (aka advance) | |
| * [OPTIONAL] use the ascending value to determine the baseline (this value doesn't mean the same thing for all fonts, unfortunately) | |
| * [OPTIONAL] an internal padding size for characters | |
| | |
| Here's its syntax: | |
| | |
| <code dos>orxfontgen -t TextFile [+ ...] -f FontFile -s Size [-o OutputName] [-m] [-a] [-asc] [-p Padding]</code> | |
| | |
| You can display its help with | |
| | |
| <code dos>orxfontgen -h</code> | |
| | |
| For any parameter, help can be diplayed using its long name: | |
| | |
| <code dos>orxfontgen -h ParameterLongName</code> | |
| | |
| Let's now see the parameters in details. | |
| | |
| ==== Input text file list ==== | |
| | |
| **-t / ''-''''-''textlist** | |
| | |
| The text file list is mandatory. At least one file has to be provided and multiple files have to be separated by spaces. Unfortunately names of input text files can't include spaces for now.\\ | |
| These files contains all the texts you want to display using this custom bitmal font: the needed characters will be extracted from them. They should be encoded either in plain ASCII or in UTF-8. | |
| | |
| Syntax: | |
| | |
| <code dos>-t TextFile1 [TextFile2 ... TextFileN]</code> | |
| | |
| If input files are encrypted with a user-provided key, you need to pass it to orxcrypt using its [[#Encryption key|encryption key parameter]]. | |
| | |
| ==== TrueType font file ==== | |
| | |
| **-f / ''-''''-''font** | |
| | |
| The TrueType font file parameter is mandatory. It defines the TrueType font file ((usually .ttf)) to use for creating the custom bitmap font. | |
| | |
| Syntax: | |
| | |
| <code dos>-f FontFile</code> | |
| | |
| ==== Size ==== | |
| | |
| **-s / ''-''''-''size** | |
| | |
| The size parameter is mandatory. It defines the size, in pixels, for the printed characters in the custom bitmap font. | |
| | |
| Syntax: | |
| | |
| <code dos>-s Size</code> | |
| | |
| ==== Output name ==== | |
| | |
| **-o / ''-''''-''output** | |
| | |
| The output parameter is optional. If none is provided, the custom bitmap font will be stored in orxFont.png/orxFont.ini. | |
| | |
| ==== Monospace ==== | |
| | |
| **-m / ''-''''-''monospace** | |
| | |
| This parameter is optional. If defined the font will be treated as a fixed width font, ie. all the characters will have the same size.\\ | |
| Otherwise, by default, the tool will output a variable width font. | |
| | |
| ==== Advance ==== | |
| | |
| **-a / ''-''''-''advance** | |
| | |
| This parameter is optional and only used if ''-m/--monospace'' is not defined. If defined the characters will use as width the metrics defined in the font.\\ | |
| Otherwise, by default, the characters will be packed as tight as possible (usually preferable). | |
| | |
| ==== Ascending ==== | |
| | |
| **-asc / ''-''''-''ascending** | |
| | |
| This parameter is optional. It will use the ascending value stored in the font to determine the baseline. Unfortunately the standard isn't always respected and this value might mean different things for different fonts. Only try it if your characters don't look correctly aligned vertically.\\ | |
| Otherwise, by default, the max character height will be used to determine the baseline, which should work in most cases. | |
| | |
| ==== Padding ==== | |
| | |
| **-p / ''-''''-''padding** | |
| |
| This parameter is optional. It defines the extra space, in pixel, to put around a character glyph and that will become part of the character itself after export. | |
| |
| ==== Latest config settings for the Development Version ==== | ==== Latest config settings for the Development Version ==== |
| {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}} | {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}} |
| |
