Lokrez
======
A smash.gg-aware local-results generator for Super Smash Brothers Ultimate.
Usage
-----
----
$> lokrez -t [your-smash.gg-auth-token] top8 [tournament-slug-or-id]
----
The resulting outputs will be in +tournament-slug.lkrz+ (text version) and
+tournament-slug.svg+ (image version).
Use the +--help+ option for further details.
Requirements
------------
=== Modules
- *appdirs* is needed to find the right emplacements for config, cache and data
files according to the OS ;
- *jinja2* is needed for templating ;
- *requests* is needed for HTTP(s) requests ;
- *cairosvg* can be used for some rasterized exports (see corresponding
section)
=== Templates
The *rebootlyonXXX* templates needs the *Impact* font (available by default on
Windows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian).
The *rebootlyon2020* template also need the *Gobold Regular* font, available at
https://www.dafont.com/gobold.font (free for personnal use).
=== Exports
The default and preferred output format is *SVG*.
You can also export to *PNG*, *PDF* and *PS* by using the corresponding
extension in the filename supplied to +--outfile+. Those exports are based on
the *SVG* output.
To export in *PNG*, lokrez will first try to use *Inkscape* command line. If
that fails (inkscape is not installed, or lokrez can't find it in your PATH),
it will try to use the *cairosvg* module (which can create artefacts for some
SVG objects).
To export in *PDF* or *PS*, lokrez will try to use the *cairosvg* module.
=== Images
The SSBU characters images are not included (since this is both copyrighted
work and a lot of heavy bitmaps). The +init+ command is designed to download
them for you and rename them according to lokrez expectations. Use it with
+lokrez init ssbu+. Then you can go make yourself a cup of coffee or two,
because that's about 3G you're going to download.
By default, the images are
For reference, the images names look like :
-----
{charactername}/chara_{formatnumber}_{charactername}_{skinnumber}.png
-----
where:
- +charactername+ is the character name (see <<_SSBU_charaappendix for valid names)
- +formatnumber+ indicates what kind of image it is
* +0+ is a 128x128 head crop
* +1+ is a 512x512 bust crop
* +2+ is the stock icon
* +3+ is a large bust crop
* +4+ is the ingame portrait
* +5+ is the full image
* +6+ is the 512x256 eyes crop
* +7+ is a ?x300 upper bust crop
- +skinnumber+ indicates the character skin (00 being the default)
Annexes
-------
=== SSBU Characters names
These are the string used to name SSBU characters.
- +banjo & kazooie+
- +bayonetta+
- +bowser+
- +bowser jr+
- +byleth+
- +captain falcon+
- +charizard+
- +chrom+
- +cloud+
- +corrin+
- +daisy+
- +dark pit+
- +dark samus+
- +diddy kong+
- +donkey kong+
- +dr mario+
- +duck hunt+
- +falco+
- +fox+
- +ganondorf+
- +greninja+
- +hero+
- +ice climbers+
- +ike+
- +incineroar+
- +inkling+
- +isabelle+
- +ivysaur+
- +jigglypuff+
- +joker+
- +ken+
- +king dedede+
- +king k rool+
- +kirby+
- +link+
- +little mac+
- +lucario+
- +lucas+
- +lucina+
- +luigi+
- +mario+
- +marth+
- +mega man+
- +meta knight+
- +mewtwo+
- +min min+
- +mr game and watch+
- +ness+
- +olimar+
- +pac-man+
- +palutena+
- +peach+
- +pichu+
- +pikachu+
- +piranha plant+
- +pit+
- +pokemon trainer+
- +richter+
- +ridley+
- +rob+
- +robin+
- +rosalina and luma+
- +roy+
- +ryu+
- +samus+
- +sheik+
- +shulk+
- +simon+
- +snake+
- +sonic+
- +squirtle+
- +terry+
- +toon link+
- +villager+
- +wario+
- +wii fit trainer+
- +wolf+
- +yoshi+
- +young link+
- +zelda+
- +zero suit samus+
Raw data
{
"_id": null,
"home_page": "https://git.lertsenem.com/lertsenem/ssbu_lokrez",
"name": "lokrez",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "smash ultimate local results esport smashgg",
"author": "Lertsenem",
"author_email": "lertsenem@lertsenem.com",
"download_url": "https://files.pythonhosted.org/packages/6b/75/a8e77ee550f1092f26ac351fd017f28c6edc040e77d12ad4858bed00fc61/lokrez-4.3.0.tar.gz",
"platform": null,
"description": "Lokrez\n======\n\nA smash.gg-aware local-results generator for Super Smash Brothers Ultimate.\n\nUsage\n-----\n\n----\n$> lokrez -t [your-smash.gg-auth-token] top8 [tournament-slug-or-id]\n----\n\nThe resulting outputs will be in +tournament-slug.lkrz+ (text version) and\n+tournament-slug.svg+ (image version).\n\nUse the +--help+ option for further details.\n\n\nRequirements\n------------\n\n=== Modules\n- *appdirs* is needed to find the right emplacements for config, cache and data\n files according to the OS ;\n- *jinja2* is needed for templating ;\n- *requests* is needed for HTTP(s) requests ;\n- *cairosvg* can be used for some rasterized exports (see corresponding\n section)\n\n=== Templates\nThe *rebootlyonXXX* templates needs the *Impact* font (available by default on\nWindows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian).\n\nThe *rebootlyon2020* template also need the *Gobold Regular* font, available at\nhttps://www.dafont.com/gobold.font (free for personnal use).\n\n=== Exports\nThe default and preferred output format is *SVG*.\n\nYou can also export to *PNG*, *PDF* and *PS* by using the corresponding\nextension in the filename supplied to +--outfile+. Those exports are based on\nthe *SVG* output.\n\nTo export in *PNG*, lokrez will first try to use *Inkscape* command line. If\nthat fails (inkscape is not installed, or lokrez can't find it in your PATH),\nit will try to use the *cairosvg* module (which can create artefacts for some\nSVG objects).\n\nTo export in *PDF* or *PS*, lokrez will try to use the *cairosvg* module.\n\n=== Images\nThe SSBU characters images are not included (since this is both copyrighted\nwork and a lot of heavy bitmaps). The +init+ command is designed to download\nthem for you and rename them according to lokrez expectations. Use it with\n+lokrez init ssbu+. Then you can go make yourself a cup of coffee or two,\nbecause that's about 3G you're going to download.\n\nBy default, the images are\n\nFor reference, the images names look like :\n\n-----\n{charactername}/chara_{formatnumber}_{charactername}_{skinnumber}.png\n-----\n\nwhere:\n- +charactername+ is the character name (see <<_SSBU_charaappendix for valid names)\n- +formatnumber+ indicates what kind of image it is\n * +0+ is a 128x128 head crop\n * +1+ is a 512x512 bust crop\n * +2+ is the stock icon\n * +3+ is a large bust crop\n * +4+ is the ingame portrait\n * +5+ is the full image\n * +6+ is the 512x256 eyes crop\n * +7+ is a ?x300 upper bust crop\n- +skinnumber+ indicates the character skin (00 being the default)\n\nAnnexes\n-------\n\n=== SSBU Characters names\nThese are the string used to name SSBU characters.\n\n- +banjo & kazooie+\n- +bayonetta+\n- +bowser+\n- +bowser jr+\n- +byleth+\n- +captain falcon+\n- +charizard+\n- +chrom+\n- +cloud+\n- +corrin+\n- +daisy+\n- +dark pit+\n- +dark samus+\n- +diddy kong+\n- +donkey kong+\n- +dr mario+\n- +duck hunt+\n- +falco+\n- +fox+\n- +ganondorf+\n- +greninja+\n- +hero+\n- +ice climbers+\n- +ike+\n- +incineroar+\n- +inkling+\n- +isabelle+\n- +ivysaur+\n- +jigglypuff+\n- +joker+\n- +ken+\n- +king dedede+\n- +king k rool+\n- +kirby+\n- +link+\n- +little mac+\n- +lucario+\n- +lucas+\n- +lucina+\n- +luigi+\n- +mario+\n- +marth+\n- +mega man+\n- +meta knight+\n- +mewtwo+\n- +min min+\n- +mr game and watch+\n- +ness+\n- +olimar+\n- +pac-man+\n- +palutena+\n- +peach+\n- +pichu+\n- +pikachu+\n- +piranha plant+\n- +pit+\n- +pokemon trainer+\n- +richter+\n- +ridley+\n- +rob+\n- +robin+\n- +rosalina and luma+\n- +roy+\n- +ryu+\n- +samus+\n- +sheik+\n- +shulk+\n- +simon+\n- +snake+\n- +sonic+\n- +squirtle+\n- +terry+\n- +toon link+\n- +villager+\n- +wario+\n- +wii fit trainer+\n- +wolf+\n- +yoshi+\n- +young link+\n- +zelda+\n- +zero suit samus+\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Smash.gg-connected top8 graphics generator for Super Smash Bros Ultimate tournaments",
"version": "4.3.0",
"project_urls": {
"Homepage": "https://git.lertsenem.com/lertsenem/ssbu_lokrez"
},
"split_keywords": [
"smash",
"ultimate",
"local",
"results",
"esport",
"smashgg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5499dbc7df45a62ac51cf464b4d3179fb6207ec3d8b95b24a93e69d95fb4f23",
"md5": "0886e2cf7267415808bc2251ee4634f2",
"sha256": "fd4d3cccac4c60fcdbf8a689acdc89e3391a34561560c6ef39ba2a724d363925"
},
"downloads": -1,
"filename": "lokrez-4.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0886e2cf7267415808bc2251ee4634f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 12327737,
"upload_time": "2023-07-07T10:40:43",
"upload_time_iso_8601": "2023-07-07T10:40:43.795082Z",
"url": "https://files.pythonhosted.org/packages/d5/49/9dbc7df45a62ac51cf464b4d3179fb6207ec3d8b95b24a93e69d95fb4f23/lokrez-4.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b75a8e77ee550f1092f26ac351fd017f28c6edc040e77d12ad4858bed00fc61",
"md5": "abc5424f398e89ae12060fff87f97f81",
"sha256": "d6b90fc316df7fd093eb4b9c8b80363bb9ce687eb4400e4cd3143cb3c18f5cf0"
},
"downloads": -1,
"filename": "lokrez-4.3.0.tar.gz",
"has_sig": false,
"md5_digest": "abc5424f398e89ae12060fff87f97f81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 12272345,
"upload_time": "2023-07-07T10:40:51",
"upload_time_iso_8601": "2023-07-07T10:40:51.152347Z",
"url": "https://files.pythonhosted.org/packages/6b/75/a8e77ee550f1092f26ac351fd017f28c6edc040e77d12ad4858bed00fc61/lokrez-4.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-07 10:40:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lokrez"
}
JSON