⚛️ Unity Atoms

Tiny modular pieces utilizing the power of Scriptable Objects

Influences

Unity Atoms is derived from and a continuation of Ryan Hipple's talk from Unite 2017. The original source code can be found here.

This talk by Richard Fine is a forerunner to Ryan Hipple's talk during Unite 2016.

Motivation

The general approach to building scripts in Unity often generates a code base that is monolithic. This results in that your code is cumbersome to test, non-modular and hard to debug and understand.

Unity Atoms is an open source library that aims to make your game code:

• 📦 Modular - avoid scripts and systems directly dependent on each other
• ✏️ Editable - Scriptable Objects makes it possible to make changes to your game at runtime
• 🐛 Debuggable - modular code is easier to debug than tightly coupled code

Requirements

As of Unity Atoms v5, Unity 2020.1 or newer is required. We made this move due to Unity 2020.1's ability to serialize generic types. Unity Atoms v4 and below were pushing the use of generics to the limit, making it hard to implmenet new features, making it hard to update the library for end users and made the code base unnessarily complicated.

Installation

NPM

Prerequisite: Since Unity Atoms is using the Unity Package Manager (UPM) you need to use Unity version 2020.1 >=

Add the following to your manifest.json (which is located under your project location in the folder Packages):

{
    "scopedRegistries": [
        {
            "name": "NPM Registry",
            "url": "https://registry.npmjs.org",
            "scopes": [
                "com.unity-atoms.unity-atoms-core",
                "com.unity-atoms.unity-atoms-base-atoms",
                "com.unity-atoms.unity-atoms-fsm",
                "com.unity-atoms.unity-atoms-mobile",
                "com.unity-atoms.unity-atoms-mono-hooks",
                "com.unity-atoms.unity-atoms-tags",
                "com.unity-atoms.unity-atoms-scene-mgmt",
                "com.unity-atoms.unity-atoms-ui",
		        "com.unity-atoms.unity-atoms-input-system"
            ]
        }
    ],
    "dependencies": {
        ...
        "com.mambojambostudios.unity-atoms-core": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-base-atoms": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-fsm": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-mobile": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-mono-hooks": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-tags": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-scene-mgmt": "5.0.0-alpha",
        "com.mambojambostudios.unity-atoms-ui": "5.0.0-alpha",
        ...
    }
}

Note that the core and base atoms packages are mandatory while the others are optional. If you don't want a subpackage, simply remove it from your dependencies. Note that subpackages may have additional dependencies.

OpenUPM

The package is available on the openupm registry. It's recommended to install it via openupm-cli.

# required
openupm add com.unity-atoms.unity-atoms-core
openupm add com.unity-atoms.unity-atoms-base-atoms

# optional
openupm add com.unity-atoms.unity-atoms-fsm
openupm add com.unity-atoms.unity-atoms-mobile
openupm add com.unity-atoms.unity-atoms-mono-hooks
openupm add com.unity-atoms.unity-atoms-tags
openupm add com.unity-atoms.unity-atoms-scene-mgmt
openupm add com.unity-atoms.unity-atoms-ui
openupm add com.unity-atoms.unity-atoms-input-system

Documentation

The Unity Atoms docs are now published at https://unity-atoms.github.io/unity-atoms.

Blog posts

• Unity Atoms — Tiny modular pieces utilizing the power of Scriptable Objects
• Announcing Unity Atoms v2
• Unity Atoms v4 is out!

How does it work?

Read this article on Medium for a great introduction to Unity Atoms.

Looking for support?

For questions and support please join our Discord channel.

Maintainers

• AdamRamberg
• soraphis
• miikalo
• Casey-Hofland

We are looking for more people to join the team! Contact us if you want to jump aboard.