Get started with Odin Inspector and Validator

Introduction to Odin attributes

Create custom editor windows using attributes

Getting the most out of Odin Validator

In this tutorial, we will go over how to install and configure Odin Inspector and Validator within Unity. 

Install Odin Inspector

Install and configure Odin Validator

Odin Course Dependencies.zip

Welcome to this getting started course for Odin Inspector and Validator. Odin Inspector helps you create custom editors for your game with ease, while Odin Validator helps you validate all your data so you can catch errors before they become a problem.

By the end of this course, you'll understand the capabilities and features of Odin and know how to leverage them effectively. You'll learn how to set up Odin Inspector and Validator, use attributes, and create custom editor windows. You'll also understand how to extract the most value from Odin Validator, and ultimately, increase your productivity in Unity significantly.

This course is intended for people who are not familiar with Odin but have some experience programming in C#. Creating new ScriptableObject and MonoBehaviour scripts should be familiar concepts to you.

Note: The Odin Serializer will not be covered in this course. 

2022.3

Getting Started with Odin

3a4bc232-adae-5e0f-adba-614a6a915197:EJWbNZ6QA41b2p9CvaVtPC

Note:  Skip to the next step if you’ve purchased Odin through the Unity Asset Store.

If you’ve bought or acquired Odin through their website or through an educational program, then the package will not be available in your package manager, instead, you’ll have to download the package from odininspector.com/download.

By clicking on the link above, you'll be presented with various customization options. One of these is the inclusion of the Odin Validator - if you have access to this tool, go ahead and include it. As for the serializer, you can leave it enabled if you expect to handle more complex data types in the future. However, for the purposes of this course, it's not necessary to include it.

Once you’ve successfully downloaded the Odin package, open the project where you want to install Odin. After this, proceed to open the downloaded file. Unity will then display an Import dialogue.

If you’ve purchased Odin Inspector and Serializer from the Unity Asset Store, you can import them directly from the Package Manager. 

1.  Navigate to Window > Package Manager in Unity. 

2.  Find Odin Inspector and Serializer in the list and select Import.

You should now see an Import Unity Package dialogue. 

After clicking import, you may encounter a popup regarding an Assembly Updater. If this popup appears, it is crucial that you confirm the action by selecting yes. The Assembly Updater updates Odin to be compatible with your version of Unity. If you do not confirm this action, Odin may throw errors, which could disrupt the setup and use of the software.

If everything has worked correctly, a getting started popup should appear.

Odin Validator is an optional yet powerful tool for Odin Inspector and Serializer, scanning and analyzing your Unity project data. It validates attributes and data structures, detects common Unity issues like missing references or invalid values with built-in validators, and allows custom validator creation for unique project needs. It not only identifies issues but also offers solutions, streamlining development and enhancing project quality.

For those who downloaded Odin from the Odin Inspector website, Odin Validator should already be installed and you can skip to the configuration step. However, if you’ve purchased Odin Inspector and Serializer from the Unity Asset Store, you’ll need to import Odin Validator separately. Follow the same steps as you did when importing Odin Inspector and Serializer.

After Odin Validator is installed, the “Getting Started” popup should appear again, but now with Odin Validator turned from gray to green, indicating it’s active and ready to be used.

After installing Odin Validator, you should notice a small red error widget in the bottom left corner of the Unity scene view. Clicking on this widget will bring up the Odin Validator window, and the error message will instruct you to configure Odin Validator from the “Setup Wizard” on the getting started popup. Please go ahead and do so, and follow the instructions of the setup wizard carefully. It is fine to leave everything as default, but do take some time to read what the wizard has to say.

After the setup has been completed, the error message will turn green.

To configure Odin Validator, follow the setup wizard instructions as well as the instructions in the introductory error message. This configuration process ensures that Odin Validator is appropriately set up to check for errors and issues in your project.

Get started with Odin Inspector and Validator

1. Install Odin Inspector

2. Install and configure Odin Validator

Complete this tutorial