2D Toolkit Documentation

Welcome to the 2D Toolkit documentation.

2D Toolkit is a set of tools to provide an efficient 2D sprite, collider set-up and text system which integrates seamlessly into the Unity environment. This manual contains a quick-start walkthrough, and a reference for the various interfaces in the package.

This documentation was generated from 2D Toolkit 2.5 beta 2.
Click here to download an offline copy of the documentation.

Table of Contents

• System overview

  • Terminology and introduction
  • 2D Toolkit 2.0 migration guide
  • Unity 4.3 integration

• Tutorials

  • Whack a Mole

• Quick-start walkthrough

  • Camera
    • Choosing a camera for your project
    • tk2dCamera
  • Sprites
    • Creating a sprite collection
    • Creating a sprite in the editor
    • Attaching a collider to a sprite
    • Creating polygon colliders
    • Scripting a sprite
  • Static Sprite Batcher
    • Using the static sprite batcher
    • Level creation tips
  • Animating Sprites
    • Creating a sprite animation
    • Animating a sprite
    • Scripting a sprite animator
  • Fonts
    • Preparing a font
    • Creating and using a text mesh
    • Using gradients and inline style changes
    • Scripting a text mesh

• Advanced

  • Importing a font into a sprite collection
  • Importing a spritesheet
  • Multiple materials in a Sprite Collection
  • Article: Sprite Optimizations using 2D Toolkit
  • Platform specific Sprite Collections
  • Linked Sprite Collections
  • Scripting a Static Sprite Batcher
  • Sprite Dicing
  • Version control
  • Animation Editor Operators
  • Experimental Features
    • Packed fonts
  • Advanced Collider Shapes

• 2D Tookit UI

  • Getting Started
  • Customizing a Basic Button
  • Basic UI Layout
    • Advanced UI Layout
  • Built in Component Examples
  • Understanding the UI System and building your own components

• 2D Toolkit TileMap

  • Tutorial
  • Reference

• Reference

  • Data
    
    • Sprite Collection
    • Sprite Animation
    • Font
  • Camera
    • tk2dCamera
  • Sprites
    • Sprite
    • Sliced Sprite
    • Clipped Sprite
    • Tiled Sprite
  • Text
    • TextMesh
  • Support behaviours
    • Sprite Animator
    • Sprite From Selected Texture
    • Static Sprite Batcher
    • Sprite Attach Point
  • Extra features
    • Button

• Faqs

• Script Reference

• Changelog and Beta Versions