Home Documentation Script Reference Forum

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 1.92 final. Click here to download an offline copy of the documentation.

---

Table of Contents

• System overview

  • Terminology and introduction

• Quick-start walkthrough

  • 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

  • Animated Sprites

    • Creating a sprite animation
    • Creating an animated sprite
    • Scripting an animated sprite

  • 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
  • External Link: Sprite Optimizations using 2D Toolkit
  • Platform specific Sprite Collections
  • Version control
  • Animation Editor Operators
  • Experimental Features
    • Packed fonts

• Camera

  • tk2dCamera

• Tile Maps (Beta)

  • Tutorial

• Reference

  • Sprite Collection
  • Sprite
  • Sliced Sprite
  • Sprite Animation
  • Animated Sprite
  • Font
  • TextMesh
  • tk2dCamera
  • Extra features
    • Button

• Faqs

• Script Reference

• Changelog and Beta Versions