About Cinemachine | Cinemachine | 2.5.0
docs.unity3d.com
    Show / Hide Table of Contents

    About Cinemachine

    Unity Cinemachine

    Cinemachine is a suite of modules for operating the Unity camera. Cinemachine solves the complex mathematics and logic of tracking targets, composing, blending, and cutting between shots. It is designed to significantly reduce the number of time-consuming manual manipulations and script revisions that take place during development.

    The procedural nature of these modules makes Cinemachine bug-resistant. When you make adjustments—for example, change an animation, vehicle speed, terrain, or other GameObjects in your Scene—Cinemachine dynamically adjusts its behavior to make the best shot. There is no need, for example, to re-write camera scripts just because a character turns left instead of right.

    Cinemachine works in real time across all genres including FPS, third person, 2D, side-scroller, top down, and RTS. It supports as many shots in your Scene as you need. Its modular system lets you compose sophisticated behaviors.

    Cinemachine works well with other Unity tools, acting as a powerful complement to Timeline, animation, and post-processing assets. Create your own extensions or integrate it with your custom camera scripts.

    Installing Cinemachine

    Cinemachine is a free package, available for any project. You install Cinemachine like any other package.

    After you install Cinemachine, a new Cinemachine folder appears in the Gizmos folder of your Project window, and a new Cinemachine menu is available.

    Cinemachine menu in the Unity Editor

    Upgrading from the Cinemachine Asset Package

    If you already installed Cinemachine from the Unity Asset Store, you can upgrade to the Cinemachine Package.

    To upgrade to the Cinemachine Package:

    1. In Unity Editor, 2018.1 or later, open your project.

    2. Save the current Scene you are working on.

    3. Create a new, empty Scene.

    4. In the Project window, delete the Cinemachine Asset and any CinemachinePostProcessing adaptor assets you may have installed.

    5. Install the Cinemachine package.

    Requirements

    Cinemachine has no external dependencies. Just install it and start using it. If you are also using the Post Processing Stack (version 2), then adapter modules are provided - protected by ifdef directives which auto-define if the presence of the Post Processing Stack is detected.

    This Cinemachine version 2.4 is compatible with the following versions of the Unity Editor:

    • 2017.1 and later

    Revision History

    Date: Reason:
    Nov 15, 2019 Updated for 2.4. Restructured Table of Contents and added Pixel Perfect extension.
    July 3, 2018 Updated for 2.2.6.
    February 15, 2018 Updated for 2.1.11.
    November 21, 2017 Initial version.
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023