Skip to content
Texture Atlas Generator is a pipeline tool for generating texture atlases, atlas data files and image fonts for use in apps and games.
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
README.md
create_virtualenv.sh
requirements.txt

README.md

Texture Atlas & Image Font Generator

Texture Atlas Generator is a pipeline tool for generating texture atlases, atlas data files and image fonts for use in apps and games. It was written for my own personal game engine but can be used in any game engine that can read xml or json.

It is written in python and uses the python image library to generate the texture atlases. It can be installed and used on any platform that supports python and the python imaging library. It is known to work on Windows and OSX.

Dependencies

Optional:

  • virtualenv

Installation

My prefered way of installing the tool is to use a python virtualenv to keep the tool and its dependancies off your system and into a sub directory that can be safely deleted when you are done.

OSX

On OSX, i recommend using Brew to manage the install (but macports will work as well if you prefer).

  • Install python from brew brew install python

  • Install virtualenv with pip pip install virtualenv

  • Clone the project git clone https://github.com/pjohalloran/texture-atlas-generator

  • Create the virtualenv and install all the tools dependencies cd texture-atlas-generator ./create_virtualenv.sh . env/bin/activate

  • Run the tool and see help instructions for cd src python AtlasGenerator.py --help

Contributer List

  • PJ O Halloran

Help

Contact me on twitter @pjohalloran if you need some help or would like to contribute.

Contribution Guidelines

If you have something to contribute, fork the project, make your change and open a pull request when done. The only guidelines I have is that you ensure the code is PEP-8 compliant.

Credits

The atlas packing algorithms include the maxrects algorithm (http://clb.demon.fi/files/RectangleBinPack.pdf) and John Ratcliffs packing algorithm (https://code.google.com/p/texture-atlas/). The maxrects algorithm implemted here is a python implementation of maxrects from https://github.com/juj/RectangleBinPack.

If you would like a project with more features then I would recommend you check out the excellent TexturePacker (http://www.codeandweb.com/texturepacker) by Andreas Low.

Software License

'texture-atlas-generator' is available to all under the MIT license. Copyright © 2011-2013 PJ O Halloran

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Python Imaging Library License

Copyright © 1997-2011 by Secret Labs AB
Copyright © 1995-2011 by Fredrik Lundh

By obtaining, using, and/or copying this software and/or its associated documentation, you agree that you have read, understood, and will comply with the following terms and conditions:

Permission to use, copy, modify, and distribute this software and its associated documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appears in all copies, and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Secret Labs AB or the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.

SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

You can’t perform that action at this time.