X Tutup
Skip to content

Latest commit

 

History

History

README.md

Documentation Hub

TextureAtlas Toolbox v2.0.0 ships with a fully Qt-based (PySide6) user interface covering extraction, atlas generation, and manual alignment. This folder contains the official documentation that mirrors the current UI and APIs.

Contents

Document Description
Installation Guide Platform-specific setup for Windows, macOS, and Linux
User Manual Walkthrough of the Extract, Generate, and Editor tabs
Format Reference In-depth technical specs for all supported atlas formats
FAQ Quick answers and troubleshooting steps
Friday Night Funkin' Guide Engine-specific workflows and FlxSprite offset tips
Developer Documentation Architecture overview and contributor onboarding
API Reference Key classes, callbacks, and extension points
Release Notes Version history and migration guidance
Translation Guide Working with Qt .ts files for localization
Licenses Project license and third-party license summaries

How to Use These Docs

  1. New to the tool? Start with the Installation Guide, then follow the quick-start path in the User Manual.
  2. Encountering an issue? Check the FAQ, then open a GitHub issue if the fix is not listed.
  3. Building new exporters or packers? Review the Developer Docs and API Reference before touching core/, packers/, or exporters/.
  4. Localizing the UI? The Translation Guide explains how to edit .ts files, run the helper scripts, and validate placeholders.

Screenshots

Screenshots are stored in the images/ subdirectory. If you notice the UI has changed and screenshots have not been updated, feel free to make a pull request with new screenshots!

Reporting Issues

If something is unclear or out of date, please open a documentation issue so we can keep the docs synced with the codebase.


Last updated: December 6, 2025 — TextureAtlas Toolbox v2.0.0

X Tutup