Homebrew: Language

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0


Building a Language

Basic skeleton

To start, copy the following code block and fill the empty "" values.

Language code block
"language":[
    {
        "name": "",
        "source": "",
        "page": 0,
        "entries": [
            ""
        ]
    }
]
  • "name" β€” name of the language
  • "source" β€” make sure it is the same as the "json" key in the _meta.
  • "page" β€” page of the document the hazard appears at (leave at 0 if not applicable).
  • "entries" β€” consists of text strings ("") separated by commas.

More options

Make sure you are adding these blocks in the same level as the "name", "source", etc.

Type

Choose between "standard", "exotic" or "secret". Other types will render correctly, but will not appear as filter options.

"type": "standard"

Script

"script": "Draconic"

Typical Speakers

 "typicalSpeakers": [
    "Southern Human Villages",
    "Swamp Elves"
]

Dialects

Having different dialects does not change how a language is presented on the website, but lets you search that language by its dialect name.

"dialects": [
    "Githyanki",
    "Githzerai"
]

Adding an image

"fluff": {
    "images": [
        {
            "type": "image",
            "href": {
                "type": "external",
                "url": "www.example.com/image.jpg"
            }
        }
    ]
}

Fonts

To link a font already present on the website, you need to know its internal structure. If you cannot figure it out, you best ask at the discord server at #brew conversion, as well as the procedure to add your own fonts.

"fonts": [
    "fonts/languages/PHB/Infernal/Infernal.ttf"
]

Reference Tag

How to link to entries within the "entries":

{@language <name_of_Language>|<json_source>|<optional_display_text>}
Example:
{@language Dambrathan|SCAG}
{@language Dambrathan|SCAG|and optional link text added with another pipe}


Field List Sources

If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.

Field Name Data Type Description Required
name String The Name for the language True
entries Array of Strings Other Names False
source String json (_meta's json value) True
page Integer The Page number it apepars upon True
srd Boolean Is this language part of the SRD False
typicalSpeakers Array of Strings what groups or creatures use this language False
script String name of the alphabet False
type String what kind of language is it?
"standard"; "exotic"; "secret"
False
additionalSources Integer what additional sources it appears within False
fonts array of String addresses for the language's associated fonts False



πŸ—„οΈ Reference Files:
πŸ›’οΈ Requirements Specs (Schemata)
[[ |🧾 Blank Template]]
πŸ“– Sample JSON
πŸ’Ύ No other Functional Examples exist
πŸ“š Repository of Other Examples


Homebrew Support


Known Issues
Looks like its perfect... (Did we miss anything?)


NAME OF THE ISSUE
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Work Around  : Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


FAQ
Nothing's here (Do you have any suggestions?)
Best Practices
None as yet (Do you have any suggestions?)



Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.