SPECTRE PIXELATOR
=================

Turns images and 3D model textures into retro pixel art.

LAUNCH
------

Windows 10/11 (64-bit)
  Extract the entire ZIP, then run spectre-pixelator.exe. Keep the assets
  folder beside the executable.

macOS 11 or newer (Apple Silicon and Intel)
  Extract the archive, then open Spectre Pixelator.app. The build is not
  notarized, so macOS blocks the first launch. Open System Settings > Privacy &
  Security and choose Open Anyway. On macOS 14 or older, Control-click the app
  and choose Open.

Linux x86_64 (X11)
  Extract the archive, then run ./spectre-pixelator from a terminal or file
  manager. OpenGL 3.3 and the usual X11 libraries are required. Native file
  dialogs use zenity, kdialog, or another supported desktop dialog helper.
  To add it to a desktop menu, put the path to the program in
  spectre-pixelator.desktop and copy that file to ~/.local/share/applications.
  Copy spectre-pixelator.xml to ~/.local/share/mime/packages and run
  update-mime-database ~/.local/share/mime to open .spectre files from a file
  manager.

Browser
  Open https://signalspike.games/tools/spectre-pixelator/app/ in a current
  browser. Files stay on your computer. Exports arrive as downloads.

GETTING STARTED
---------------

1. Drag in an OBJ, GLTF, GLB, FBX, IQM, VOX, PNG, JPG, BMP, or TGA file.
2. Adjust the processing controls and inspect the 3D and texture previews.
3. Use File > Export for processed textures, models, GIFs, normal maps, or
   sprite atlases.

For GLTF, keep its .bin and image files beside it. For OBJ, keep its .mtl and
image files beside it. Packed GLB is the easiest single-file Blender export.
Mesh-compressed glTF files are not supported.

BROWSER VERSION
---------------

Select or drop a model together with its .mtl, .bin and textures.
Files open up to 64 MB each and 256 MB together. Images open up to 67 megapixels
and 16384 pixels per side.
Save Project downloads a .spectre file. To open it elsewhere, keep the source
file with it. The same browser finds the source by name while it still has it.
Export All and Export Model + Textures download one zip. Downloads stop at 192 MB.
The browser keeps your recent uploads, up to 256 MB and 12 uploads, for recent
files and recovery. Clearing site data removes them.
A second tab can edit, but saves no settings and has no recovery.

COMMAND LINE
------------

spectre-pixelator --batch IN... --out DIR processes images with no window.
Run spectre-pixelator --help for the options.

SAVED DATA
----------

Windows: %APPDATA%/Signal Spike Games/Spectre Pixelator
macOS:   ~/Library/Application Support/Spectre Pixelator
Linux:   $XDG_CONFIG_HOME/spectre-pixelator, or ~/.config/spectre-pixelator
Browser: this site's data in your browser

Presets, custom palettes, rules, recent files, and recovery data live there.

LINKS
-----

https://signalspike.games/tools/spectre-pixelator/app/
https://korze.org/code/code/spectre-pixelator

See THIRD_PARTY_NOTICES.txt for dependency licenses and acknowledgments.
