Update README

master
Lertsenem 2020-07-23 10:06:33 +02:00
parent 452507619e
commit 480bd1f8a2
1 changed files with 21 additions and 9 deletions

View File

@ -20,14 +20,20 @@ Requirements
------------ ------------
=== Modules === Modules
- *jinja2* is the only mandatory external module - *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 - *cairosvg* can be used for some rasterized exports (see corresponding
section) section)
=== Templates === Templates
The *rebootlyon* template needs the *Impact* font (available by default on The *rebootlyonXXX* templates needs the *Impact* font (available by default on
Windows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian). 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 === Exports
The default and preferred output format is *SVG*. The default and preferred output format is *SVG*.
@ -36,23 +42,29 @@ extension in the filename supplied to +--outfile+. Those exports are based on
the *SVG* output. the *SVG* output.
To export in *PNG*, lokrez will first try to use *Inkscape* command line. If 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 that fails (inkscape is not installed, or lokrez can't find it in your PATH),
will try to use the *cairosvg* module (which can create artefacts for some SVG it will try to use the *cairosvg* module (which can create artefacts for some
objects). SVG objects).
To export in *PDF* or *PS*, lokrez will try to use the *cairosvg* module. To export in *PDF* or *PS*, lokrez will try to use the *cairosvg* module.
=== Images === Images
The SSBU characters images are not included (since this is both copyrighted 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 work and a lot of heavy bitmaps). The +init+ command is designed to download
put them in a +res/ssbu/chars+ directory. They should be named like so : 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 {charactername}/chara_{formatnumber}_{charactername}_{skinnumber}.png
----- -----
where: where:
- +charactername+ is the character name (see appendix for valid names) - +charactername+ is the character name (see <<_SSBU_charaappendix for valid names)
- +formatnumber+ indicates what kind of image it is - +formatnumber+ indicates what kind of image it is
* +0+ is a 128x128 head crop * +0+ is a 128x128 head crop
* +1+ is a 512x512 bust crop * +1+ is a 512x512 bust crop
@ -68,7 +80,7 @@ Annexes
------- -------
=== SSBU Characters names === SSBU Characters names
These are the string uised to name SSBU characters. These are the string used to name SSBU characters.
- +banjo & kazooie+ - +banjo & kazooie+
- +bayonetta+ - +bayonetta+