X-Git-Url: http://nitlanguage.org diff --git a/contrib/inkscape_tools/README.md b/contrib/inkscape_tools/README.md index c338656..b279d0f 100644 --- a/contrib/inkscape_tools/README.md +++ b/contrib/inkscape_tools/README.md @@ -1,15 +1,36 @@ -# SVG to PNG and Nit +tools to extract images from SVG files: `svg_to_icons` for app icons and `svg_to_png_and_nit` for game sprites -This tool uses Inkscape to prepare assets for Nit applications from a single SVG file. -It selects objects to extract from the SVG file when their id begins with `0`. +Both tools use Inkscape for to read the SVG files and extract the images. -It will produce two files: +# Create applications icons + +`svg_to_icons` creates icons for Android, iOS and the stores from an SVG file. +The icons are generated with the formats and minimum file structure expected by the target platform. +This tools works especially well with _app.nit_. + +## Variations + +The `--android` option generates the folders drawable-hdpi, drawable-xhdpi, etc. with the corresponding icon within. + +The `--ios` option generates many different icon formats for different iOS devices, +along with the `Contents.json` file as expected by Xcode. + +## Usage examples + +See the portable applications at `contrib/tnitter` and `examples/calculator` for practical usages of this tool. + +# Create game sprites and a module to load them + +`svg_to_png_and_nit` prepares sprite assets for Nit applications from a single SVG file. +It selects the objects to extract from the SVG file when their id begins with `0`. + +It produces two files: * A Nit source file that declares a single class with an attribute for each selected object. - The attribute usually holds a single texture, except if the the id ends with a digit, then it will be an array. + The attribute usually holds a single texture, except if the id ends with a digit, then it will be an array. * A single PNG image file that contains all the selected objects. - With the option `--pow2`, the image size is rounded to the next of 2. + With the option `--pow2`, the image size is rounded to the next power of 2. ## Usage @@ -19,13 +40,3 @@ It will produce two files: 4. Execute `bin/svg_to_png_and_nit drawing.svg` 5. From your code, import the generated source file at `src/drawing.nit`. 6. Use the class `DrawingImages` and its attributes. - -## Examples - -The minimal test in `tests/app/` shows the basic usage of this tool. - -The Dino example `../../../../examples/mnit_dino` also uses this tool and is a more complete and practical example. - -# Authors - -Alexis Laferrière