Introduction¶
In this section you'll be able to find more information on how to use our Grammar Engine as an author, content-creator, or translator utilizing the library to format output texts.
If you're looking for more information on how to add the Grammar Engine to your project and utilize it from an implementor's standpoint, please refer to the section for developers.
Before You Start¶
It's really easy, trust us!
We'd like to take a moment to remind you that most regular use cases for the Grammar Engine don't require any additional tagging or markup.
In most languages you'll be able to use natural language with placeholders only.
While this library provides you with a powerful tool to craft dynamic texts into immersive experiences no matter the actual languages, it's important to note that the Grammar Engine is still limited based on which information is passed to it and how it's actually called. If you're an implementor, looking for more information on how to utilize the library, have a look at our developer section.
If you're working directly with us and run into problems, feel free to contact us. We'll be happy to help you. If you're an end-user, player, or modder and actually using our library while modifying a game or any other product utilizing our Grammar Engine, please try to contact the original publisher or developer first.
General Concept¶
Our Grammar Engine allows you to create template texts with embedded placeholders. Later on, these will be filled with provided variables, applying proper grammatical rules to make everything fit together. In addition, it's possible to combine nouns and several affixes to form new words or variables that can be used again.
Name Generator¶
The included name generator is capable of merging several name fragments, such as nouns, adjectives or any other affixes to form new and properly spelled terms.
These may be combined and mixed in any way you see fit. Translators are capable of translating these any way they feel fits perfectly, even allowing them to reorder them or change them completely. For example, it's totally possible to translate an adjective and ensure the result is a compound word.
Continue reading about the Name Generator to get more information regarding the available tags used to control this behavior and known limitations.
Text Templating¶
The main portion of our Grammar Engine utilizes templated placeholder text and fills said placeholder with provided or pre-determined placeholder texts, once again applying all necessary grammatical rules as defined by the active language and the provided strings themselves.
Given the proper setup, you're also able to at any time change parts of a text based on certain circumstances, such as a player character's gender or based on the amount of or gender of an object you're interacting with.
Continue reading about templates or variables to learn more about the possibilities and how to properly use them.