Commandline tool to convert images to tiles, sprites or charsets for the TIC-80.
When developing a game or a demo, sooner or later you will need to add some nice graphics.
TicMcTile reads your imagefile(s) in a variety of formats and creates files from it, which can be run/loaded by the TIC-80 or your favorite editor/ide. Supported languages are: Lua & Javascript.
Of course images can be loaded into the sprite editor by using the import-command. But TicMcTile can stuff more tiles/sprites into your program, allowing you to import images as 4 or 2 color images instead of 16, thanks to a feature called BPP (Bits Per Pixel). It is also possible to replace the systemfont with an own charset of the right size. All this data can additionally be compressed by using RLE (Run-length encoding).
The TIC-80 offers you 8192 bytes (8kb) for tiles (8x8 pixels), which can be used in the map editor or as sprites. Another 8192 bytes (8kb) can be used for regular sprites of the same pixel size. You can have one page (128 x 128 pixels each) with up to 256 tiles and 256 sprites in total. Each one of these tiles/sprites will be stored in 32 bytes of data, when using the default of 16 colors. You can switch between both types by using the TAB-key or by clicking on the 9Dots-icon (tiles) or the Smiley-icon (sprites) in the upper, middle of the sprite editor.
With the BPP (Bits Per Pixel)-feature you can have more tiles/sprites if less colors (4 or 2) are used. This is accomplished by storing more pixels per byte into the 32 byte-chunks already used for the 16 color tiles/sprites. The 4 color-mode will then give you two pages (128 x 128 pixels each) for tiles and the same amount for regular sprites in the sprite editor. And 2 colors will result in four pages of the same size for each type. You can switch between those pages in the upper, right corner of the sprite editor.
But there is currently no easy way to use these extended capabilities with images made outside the TIC-80. The import-command used with the sprite editor will always fall back to one page (128 x 128 pixels) with 16 colors each. But TicMcTile comes to the rescue. It will convert your images (no matter if 16, 4 or 2 colors) into a file with the correct encoding of the data. This file can then directly be used by the TIC-80.
You can convert a singlepage-image (128x128 or smaller) and assign it to one of the available pages, or you can use multipage-images. When using 4 colors, a multipage can be max. 256 pixels wide & 128 pixels high. In case of 2 colors, a multipage can be max. 512 pixels wide & 128 pixels high. You can select whether the image(s) should be converted to tiles (default) or sprites.
Only images with 16 colors or less are supported, for obvious reasons. These images should consist of indexed colors resp. have a color-palette. Truecolor-images will be converted, but results may vary. Make sure, that images match the color-palette (SWEETIE-16) of the TIC-80. Or tell TicMcTile to keep (-k / --keep) the colors of your image by replacing the default ones.
There are several methods to use a different charset/font in TIC-80. The 2 most common are, the Font-function and/or the replacement of the systemfont, which is used by the Print-function.
The Font-function uses the sprites for storing the chars and displays them on the screen. It supports 8x8 pixel per char and all 16 colors can be used on every single char.
The Print-function uses the systemfont of the TIC-80, which consists of a big-font and a small-font. By default the big chars are used and the small ones can be activated by using the smallfont-option of the Print-function. Both charsets are also based on a grid using 8x8 pixel per char, but only 5x6 pixels (big) or 3x6 pixels (small) are used. The systemfont is monochrome (1 color), but the color can be switched between all 16 colors from char to char.
To replace the big chars of the systemfont, use the Charset-option (-c / --charset) of TicMcTile. To replace the small chars, just add "-p 1" or "--page 1" to that command. The new charset should start with the Space-symbol (ASCII Pos. 32) and must not exceed the Tilde-symbol (ASCII Pos. 126).
TicMcTile supports different modes to store the data of tiles/sprites, by default the raw-mode is used. In this case, tiles/sprites or charsets and the palette will be saved into variables. To get this data written to memory at runtime, some extra functions (decoders) will be included to the file as well. In case of rle-mode, all data will be compressed using RLE (Run-length encoding) to save some space, before stored to the variables. Note that you can have multiple sets of sprites/tiles or charsets and palettes when using these modes, because you can have several variables (eg. gfx1, gfx2 & pal1, pal2) to store and decode them.
As both modes write their data directly into the RAM of the TIC-80, the sprite editor will NOT display these sprites/tiles.
To still be able to debug them, a simple viewer will also be included to the file. The sources of the viewers can be found in the Viewers-directory. The decoders are located in the Decoders-directory, accordingly. They also contain a brief description of the dataformat for the variables. To run files with raw or rle-mode, use:
tic80 --skip --fs=. --cmd="import code myscript.lua & run"
When using the config-mode, the file will include some pseudo-code and at the end, palette & sprites/tiles within XML-style tags. This mode is only supported in the PRO-version of TIC-80, as shown in the table below. Charsets are not supported when using this mode. To run a file with config-mode, simply use: "tic80 myscript.lua"
The binary mode is just an admission for a close friend and NOT directly usable for the TIC-80.
| Mode | Description | TIC 80 | TIC 80 Pro |
|---|---|---|---|
| raw | data saved as script-code and variable at beginning of source code | ✓ | ✓ |
| rle | data saved as script-code and variable at beginning of source code | ✓ | ✓ |
| config | data saved as XML-style tagged config-block at end of sourc ecode | _ | ✓ |
| binary | data is saved in a standalone binary file for further usage | - | - |
- Python (3.x) - https://www.python.org/
- Pillow (Python Imaging Library) - https://pypi.org/project/Pillow/
If missing, Pillow can be installed using pip.
Linux:
$ pip install pillow
Windows:
$ python -m pip install pillow
TicMcTile is straightforward to use and its really easy to convert an image to TIC-80.
Just run ticmctile.py using the provided example images. To prevent the config-mode of TIC-80 Pro, just add -m raw to the examples:
$ ticmctile.py singlepage-16colors.png
Will generate an output file, in config-mode, called "singlepage-16colors.lua", can be opened with an editor or the TIC-80 Pro.
Specify a different name for the output file:
$ ticmctile.py singlepage-2colors.png -o twocolors.lua
The default language is Lua, but other languages are supported.
Set a different scripting language for the output file:
$ ticmctile.py singlepage-2colors.png -l js -o myownscript.js
Mind the correct file extension: .js or .lua
Generate a sprite page instead of a tile page:
$ ticmctile.py singlepage-4colors.png -o mysprites.lua -s
In the sprite-editor of the TIC-80 you can switch between tiles and sprites (press the TAB-Key).
Start the tiles on a different page e.g. 1 instead of 0 (default):
$ ticmctile.py multipage-2colors.png -o someotherpage.lua -p 1
In the sprite-editor of the TIC-80 you can toggle between 4 different pages (when using 2 colors).
Save the tiles or sprites to a different memory bank, there is only 1 by default:
$ ticmctile.py multipage-4colors.png -o bankbonkers.lua -b 7
In the PRO Version of TIC-80 there are 8 memory banks instead of only 1.
Keep the colors of the image file instead of using the default ones:
$ ticmctile.py ownpalette-16colors.png -o mynicepalette.lua -k
16 colors will replace the whole palette, 4 or 2 colors will only replace the first palette entries.
Encode the tiles or sprites as rle-compressed part of the code:
$ ticmctile.py multipage-2colors.png -o smallerscript.lua -m rle
This makes it possible to use multiple sets of tiles/sprites, storing them in different variables.
Replace the systemfont with a custom charset:
$ ticmctile.py ionicV5-charset.png -o freshchars.lua -m raw -c
This will replace the bigfont. To change the smallfont, set the page to 1 by adding "-p 1"
$ ticmctile.py --help
Usage: ticmctile.py imagefile [OPTION...]
Generate TIC-80 tile/sprite or charset values from pixeled images
mandatory arguments:
imagefile imagefile with pixeled graphics (e.g.: .png, .gif, etc.)
optional arguments:
-o, --output outputfile for tile/sprite or charset values (e.g.: .lua)
-l, --language output as: js, default is lua
-f, --force force overwrite of outputfile when it already exist
-s, --sprites export as sprites instead of tiles
-c, --charset export as charset to replace the systemfont
-p, --page start page (1-3) for tiles/sprites, default is 0
-m, --mode mode to encode as: raw, rle, binary, default is config
-b, --bank memory bank (1-7) for TIC-80 PRO version, default is 1
-k, --keep keep colors of imagefile to adjust the TIC-80 palette
-v, --version show version info
-h, --help show this help
The optional arguments are only needed if the default setting does not meet the
required needs. A specific name for the output file (-o / --output) can be set.
The language (-l / --language) for output can be Lua (default) or JavaScript.
The data can be saved as sprites (-s / --sprites) instead of tiles.
Tiles/sprites can start on a different page (-p / --page) instead of 0.
Mode (-m / --mode) to encode the tiles/sprites as part of the code as
raw (default), rle, as binary-file (binary) or as part of the config (config).
Replace the systemfont with a correct formated charset (-c / --charset).
To replace the smallfont choose (-p 1 / --page 1) instead of 0, which is default.
In the PRO version of TIC-80 there are up to 8 memory banks (-b / --bank)
to store the tiles/sprites, instead of only one. The colors of the image can
be kept (-k / --keep), replacing the default colors (Sweetie-16) of the TIC-80.
examples:
ticmctile.py imagefile.png
ticmctile.py graphic.gif -o myticprog.lua
ticmctile.py pixels.bmp -o javascript.js -l js
ticmctile.py logo.png -o tempvalues.lua -f
ticmctile.py goblins.gif -o sprites.lua -s
ticmctile.py atothez.png -o lettering.lua -p 2
ticmctile.py flextiles.bmp -o thecodeinside.lua -m rle
ticmctile.py dafont.png -o freshchars.lua -m raw -c
ticmctile.py tilesgalore.gif -o membank3.lua -b 3
ticmctile.py nicecolors.png -o mypalette.lua -k
- ticmctile.py (the commandlinetool itself)
- images/singlepage-2colors.png (example image with 2 colors, original by Decca/Lego)
- images/singlepage-4colors.png (example image with 4 colors, original by Decca/Lego)
- images/singlepage-16colors.png (example image with 16 colors, original by Decca/Lego)
- images/multipage-2colors.png (3 pages with 2 colors, originals both by Decca/Lego), font from Chartist)
- images/multipage-4colors.png (2 pages with 4 colors, originals both by Decca/Lego)
- images/ownpalette-16colors.png (example image with an own palette, original by Decca/Lego)
- images/ionicV5-charset.png (example charset with 2 colors, original by Decca/RiFT)
- decoders/decoder-raw.lua/.js (the decoder when using raw-mode)
- decoders/decoder-rle.lua/.js (the decoder when using rle-mode)
- viewers/viewer.lua/.js (the viewer when using raw- or rle-mode)
- keeping the color-palette of the image, instead of using the default palette - Done, implemented in version 1.2
- Real compression of the values incl. a small decompressor for Lua - Done, implemented in version 2.0
There is no warranty for the scripts or it's functionality, use it at your own risk.
The icon/logo consists of the Sweetie 16-palette © by GrafxKid & a Clamp emoji clipart © by Creazilla.
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/PhilSwiss/ticmctile/issues
Development of ticmctile happens at GitHub: https://github.com/PhilSwiss/ticmctile