ndstextgen

Name	ndstextgen JSON
Version	1.7.3 JSON
	download
home_page	https://github.com/Illidanz/ndstextgen
Summary	Command line tool to render text from NDS .NFTR fonts.
upload_time	2023-10-17 06:56:04
maintainer
docs_url	None
author	Illidan
requires_python	>=3.7
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # NDS Text Generator
Command line tool to render text from NDS .NFTR fonts.  
## Run from pip
`pip install ndstextgen`  
`ndstextgen --help`  
## Run from source
Install pipenv.  
`pipenv sync`  
`pipenv run python ndstextgen --help`  
## Command line usage
`ndstextgen <options> FONT "TEXT"`  
Example: `ndstextgen --color red font.NFTR "Print multiline\nred text."`  
`FONT`: (Required) Filename of the font, .NFTR extension can be omitted.  
`TEXT`: (Required) Text to write. "\\n" can be used for a line break. Can be the name of a UTF-8 file to read the text from.  
`--out <file>`: Output file, set empty to just return the image. Default: text.png  
`--vert <int>`: Vertical spacing between lines. Default: 2  
`--fw <int>`: Use a fixed width instead of the VWF values in the font.  
`--spacing <int>`: Additional horizontal spacing between characters.  
`--color <text>`: Color to apply to the font. Default: black  
`--bg <text>`: Background color. Default: transparent  
`--width <int>`: Set width for the generated image. Default: 256  
`--height <int>`: Set height for the generated image. Default: 256  
`--center`: Center each line.  
`--wwrap`: Automatic wordwrap.  
`--no-crop`: Don't crop the image before saving it.  
`--encoding <str>`: Encoding the font uses. See [Python documentation](https://docs.python.org/3/library/codecs.html#standard-encodings).  
## Script usage
```python
import ndstextgen
image = ndstextgen.gen("font.NFTR", "Print multiline\nred text.", color="red")
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Illidanz/ndstextgen",
    "name": "ndstextgen",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Illidan",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c4/b4/91b375d2a30300636325d011c9d7846337196d25e1147abcbc4c01a3c46e/ndstextgen-1.7.3.tar.gz",
    "platform": null,
    "description": "# NDS Text Generator\nCommand line tool to render text from NDS .NFTR fonts.  \n## Run from pip\n`pip install ndstextgen`  \n`ndstextgen --help`  \n## Run from source\nInstall pipenv.  \n`pipenv sync`  \n`pipenv run python ndstextgen --help`  \n## Command line usage\n`ndstextgen <options> FONT \"TEXT\"`  \nExample: `ndstextgen --color red font.NFTR \"Print multiline\\nred text.\"`  \n`FONT`: (Required) Filename of the font, .NFTR extension can be omitted.  \n`TEXT`: (Required) Text to write. \"\\\\n\" can be used for a line break. Can be the name of a UTF-8 file to read the text from.  \n`--out <file>`: Output file, set empty to just return the image. Default: text.png  \n`--vert <int>`: Vertical spacing between lines. Default: 2  \n`--fw <int>`: Use a fixed width instead of the VWF values in the font.  \n`--spacing <int>`: Additional horizontal spacing between characters.  \n`--color <text>`: Color to apply to the font. Default: black  \n`--bg <text>`: Background color. Default: transparent  \n`--width <int>`: Set width for the generated image. Default: 256  \n`--height <int>`: Set height for the generated image. Default: 256  \n`--center`: Center each line.  \n`--wwrap`: Automatic wordwrap.  \n`--no-crop`: Don't crop the image before saving it.  \n`--encoding <str>`: Encoding the font uses. See [Python documentation](https://docs.python.org/3/library/codecs.html#standard-encodings).  \n## Script usage\n```python\nimport ndstextgen\nimage = ndstextgen.gen(\"font.NFTR\", \"Print multiline\\nred text.\", color=\"red\")\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Command line tool to render text from NDS .NFTR fonts.",
    "version": "1.7.3",
    "project_urls": {
        "Homepage": "https://github.com/Illidanz/ndstextgen"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c4b491b375d2a30300636325d011c9d7846337196d25e1147abcbc4c01a3c46e",
                "md5": "cecff951c8b45ad6b85fc73a3d0607d1",
                "sha256": "a54a158f98cf23b45a1dbebadcc1aacb690064af8bd56a1274f8157addf446d8"
            },
            "downloads": -1,
            "filename": "ndstextgen-1.7.3.tar.gz",
            "has_sig": false,
            "md5_digest": "cecff951c8b45ad6b85fc73a3d0607d1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4552,
            "upload_time": "2023-10-17T06:56:04",
            "upload_time_iso_8601": "2023-10-17T06:56:04.882338Z",
            "url": "https://files.pythonhosted.org/packages/c4/b4/91b375d2a30300636325d011c9d7846337196d25e1147abcbc4c01a3c46e/ndstextgen-1.7.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-17 06:56:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Illidanz",
    "github_project": "ndstextgen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ndstextgen"
}