daniellanner / snow-for-unity-facade

The publicly exposed files and features for running the Snow for Unity plugin.

Artwork by Firman Hatibu

SnowFS for Unity - Easy local version control for the Unity Editor

Summary

SnowFS for Unity is an integration of SnowFS in the Unity editor. SnowFS is a lightweight version control system for artists and designers with a focus on multimedia assets.

What it is

SnowFS for Unity is a rapid versioning tool to save snapshots and rollback to earlier states. It is local-only versioning with a focus on increasing single-user iterations. It is heavily inspired by git and strips away the most confusing parts.

What it is not

• SnowFS for Unity is not a collaboration tool.
• SnowFS for Unity has no cloud storage features.
• SnowFS for Unity has no features of merging branches.

Installation

You can grab get the latest source code by cloning this repository and copy paste the content of the Assets directory into your project. Alternatively you can get the latest release from the releases page. Releases are compiled for all supported Unity versions.

Supported Unity Versions

• Unity 2018.4 LTS
• Unity 2019.4 LTS
• Unity 2020.3 LTS

Supported Platforms

• Windows
• MacOS
• Linux

Collisions

SnowFS for Unity is built using Newtonsoft.Json for Unity and the package is included in this repository at Snow/Plugins/Editor/libs. There is no need to import the directory should you already have a Newtonsoft.Json distribution present within your project.

Documentation

For a detailed documentation on how to work with SnowFS for Unity see the docs/ directory. Among other things the documentation will help you Getting Started, demonstrate an Example Workflow and discuss Advanced Features.

FAQ

See the dedicated FAQ section in the docs/ directory.

• What is SnowFS for Unity?
• What exactly is SnowFS?
• How does it work?
• Why not git or p4?
• I heard git had branching and merging. Can I merge branches in SnowFS?
• Does SnowFS for Unity have remote backup features?
• Can I share the versions created with SnowFS for Unity with others?
• Can I use SnowFS for Unity with other version control tools?

Contribute

Check the issues if your desired changes are already being worked on or open an issue before starting to work on any changes. Follow the contribution guidelines on how to integrate your changes.

Versioning

Starting with version 1.0.0 SnowFS for Unity follows the semantic versioning scheme. The API change and backward compatibility rules are those indicated by SemVer.

Built With ❤️

Tools 🛠️

• SnowFS
• Newtonsoft.Json for Unity

Automation 🤖

• Create Unity Package
• Github Changelog Generator

Utilities ⚙️

• VSCode Unity Debug
• Editorconfig VSCode
• VSCode Unity Code Snippets

Licensing

SnowFS for Unity is licensed under the MIT license, please review the LICENSE file. Excluded from the license are images, artworks, and logos.

External projects

• SnowFS is licensed under the MIT license, please review the LICENSE file. Excluded from the license are images, artworks, and logos.
• Newtonsoft.Json for Unity is licensed under the MIT license, please review the LICENSE file

Get in touch

Join the official Snowtrack Discord Server for more information on Snowtrack, SnowFS, SnowFS for Unity, and future plugins.