A smash.gg-aware local-results generator for Super Smash Brothers Ultimate. lokrez.smashlyon.com
 
 
Go to file
Lertsenem 37eccfeaf4 Add script to fix msi generation
The generated msi will be modified so it can be installed by any user.
2020-07-22 20:46:13 +02:00
lokrez Change template rebootlyon to rebootlyon2019 2020-07-22 20:30:35 +02:00
.gitignore Update .gitignore 2020-07-20 23:53:08 +02:00
LICENSE Add MIT License 2020-07-20 19:12:48 +02:00
README.adoc Add basic usage to README 2020-07-09 15:40:16 +02:00
setup.py Add script to fix msi generation 2020-07-22 20:46:13 +02:00

README.adoc

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
- *jinja2* is the only mandatory external module
- *cairosvg* can be used for some rasterized exports (see corresponding
  section)

=== Templates
The *rebootlyon* template needs the *Impact* font (available by default on
Windows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian).

=== 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 install, 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), you'll have to get them by your own means and
put them in a +res/ssbu/chars+ directory. They should be named like so :

-----
{charactername}/chara_{formatnumber}_{charactername}_{skinnumber}.png
-----

where:
- +charactername+ is the character name (see appendix 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 uised 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+