From e151309a4dc8eec52a57c65e2c5a3294d98a5d63 Mon Sep 17 00:00:00 2001
From: Lertsenem <lertsenem@lertsenem.com>
Date: Thu, 9 Jul 2020 14:42:40 +0200
Subject: [PATCH] Update README with requirements

---
 README.adoc | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 107 insertions(+), 1 deletion(-)

diff --git a/README.adoc b/README.adoc
index b7f7c9a..dfa3040 100644
--- a/README.adoc
+++ b/README.adoc
@@ -14,4 +14,110 @@ Windows, install +ttf-mscorefonts-installer+ on Ubuntu or Debian).
 === 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 the +res/ssbu+ directory.
+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+
+