Havainnekuva CTR:llä renderöidystä tekstistä.
Teksti on keskitetty, ja siinä on montaa eri väriä.

CTR - Custom Text Renderer

Yleistä

Vapaa-ajan projekti

CTR on sapluunaprojekti Game Editor -ohjelmalle. Sen tarkoitus on helpottaa tekstielementtien käyttöä peleissä.

Vanhahkon Game Editorin sisäänrakennettu tekstitoiminnallisuus on puutteellista. Tekstiä ei voi tasata oikealle eikä keskittää, ja jokainen yksittäinen tekstikokonaisuus on yksivärinen. Ongelmia aiheuttaa myös se, että Game Editor ei pysty laskemaan tekstin leveyttä ja korkeutta oikein. Myös automaattinen rivitys puuttuu.

CTR ratkaisee nämä ongelmat tekemällä oikeastaan kaiken alusta asti itse. CTR ei käytä Game Editorin sisäänrakennettua tekstijärjestelmää ollenkaan, vaan jokainen merkki on oma peliobjektinsa, ja kirjaimet ovat oikeasti kuvia, eivätkä fontteja. Tämä tietysti aiheuttaa omat rajoitteensa mm. välistyksen ym. kanssa, mutta saavutetut edut korvaavat mielestäni nämä puutteet moninkertaisesti.

Font Tool

Koska CTR tukee vain kuvamuodossa olevia fontteja, sen mukana tulee työkalu nimeltä Font Tool, jolla voi helposti luoda kuvafontin mistä tahansa tavallisesta fontista. Myös Font Tool on tehty Game Editorissa.

Käyttäjä syöttää kuvamuotoon käännettävän fontin nimen (fontin täytyy olla asennettuna tietokoneelle) ja kirjasimen koon Font Tooliin. Annettujen tietojen perusteella työkalu luo .svg-tiedoston, jossa on kaikki normaalit ASCII-merkit aseteltuna siten, että koko kirjasinjoukko on helppo viedä (exportata) Inkscapesta spritesheetinä, jossa kaikki merkit ovat pystyrivissä.

Font Tool.

Kuvamuotoisen fontin luonnin jälkeen se voidaan tuoda Font Tooliin fontin asetusten säätämiseksi. Säädettäviä asetuksia ovat kirjainten välistys, sanojen välistys (välilyönnin koko), rivivälistys sekä sisennyksen koko. Asetuksia säädettäessä esikatseluteksti näyttää tulokset reaaliajassa. Kun käyttäjä on tyytyväinen tuloksiin, fontin data ja asetukset voidaan viedä työkalusta kahdessa formaatissa: code ja data.

Code-formaatti luo .c-tiedoston, jossa on fontin asetuksilla ja sen merkkien leveyksillä (pikseleinä) alustettu Font-struct (CTR:n oma datatyyppi).

Data-formaatti puolestaan luo binäärimuotoisen tiedoston .fdf-tiedostopäätteellä. Tiedosto sisältää kaiken vastaavan datan kuin code formaatin tiedosto.

Code-formaatissa olevaa dataa käytetään kopioimalla tiedoston sisältö Game Editoriin. Data-formaatissa viety fonttidata taas luetaan CTR:n API-funktiolla readFontDataFile.

CTR:n ominaisuuksia

Tekstin tasaus vasemmalle / oikealle sekä tekstin keskitys
Automaattinen rivitys
Mahdollisuus muuttaa tekstin väriä missä tahansa kohtaa tekstiä
Tekstin sovittaminen annetun kokoiseen alueeseen (tarvittaessa rullaus)

Alla CTR:n ominaisuuksien esittelyvideo.

Back

Illustration of text rendered with CTR.
The text has been centered and it's rendered in multiple colors.

CTR - Custom Text Renderer

Overview

Hobby project

CTR on GitHub

CTR is a template project for Game Editor. Its purpose is to make easier to use text elements in games.

The built-in text elements in Game Editor are quite lacking in features. They can't be aligned right or centered and each text element can only feature a single color. Game Editor also fails to calculate the width and height of text elements correctly. The built-in text elements also don't support automatic line wrapping.

CTR solves these problems by basically redoing everything from the ground up. CTR doesn't utilize the built-in text elements of Game Editor at all. In CTR, each character is an individual game object (a clone), and the letters are actually just sprites, not glyphs of a font. This does place some limits on the accuracy of things such as kerning but I think the advantages gained significantly outweigh the disadvantages of the approach.

Font Tool

As CTR uses image fonts it comes shipped with a custom made tool for creating image fonts out of any font. The tool is built in Game Editor too.

The user inputs the name and size of the font they want to convert (it has to be a font available on the machine). The tool will then generate an .svg file containing the basic ASCII character set composed in such a way that it is very simple to export the collection of characters from Inkscape as a single spritesheet where the characters are arranged in a vertical column.

Font Tool.

After generating the image font it can be imported back into the Font Tool for adjusting the settings of the font (letter spacing, word spacing, line spacing and indentation). The settings can be adjusted with a preview text showing the results in realtime. When the user is content with the results they can export the font data in one of 2 formats: code or data.

The code format produces a .c file with a Font struct (a custom data type used by CTR) initialized with the settings to be used with the font as well as the width of each of the characters in pixels.

The data format produces a binary file with the extension .fdf containing the settings to be used with the font as well as the width of each of the characters in pixels.

The code format is used by copying the contents of the file into Game Editor and the data file is used by loading the data with CTR API function readFontDataFile.

Some features of CTR

Text alignment to left / right as well as text centering
Automatic line wrapping
Support for altering the letter color at any point even in the middle of text
Fitting text to an area of given size (with scrolling if required)

Below is a short showcase video of the features and usage of CTR.