Home

Awesome

Elarion

Elarion is a collection of tools for Unity. It includes quite a few things, but here are the highlights:

This thing is huge, I know, and I'm working on breaking it down into a couple of smaller repositories. This one will always be the central hub, but expect to see some submodules in the near future.

Getting Started

Adding Elarion to your project can be as easy as downloading it and extracting it anywhere in your Assets Folder. Alternatively, for easier updates (and extra points), you can add it as a git submodule.

Adding Elarion as a git submodule

If you're not familiar with git submodules, you can get started here.

Adding the submodule

I'll describe a simple setup in which Elarion lives in the root directory of the project - modify it to suit your needs.

First, go to your project's directory and run:

cd Assets
git submodule add https://github.com/jedybg/Elarion.git

This will clone the project in a the Elarion directory. You'll need to commit the folder and the .gitmodules file (tracking all submodules) to your repository.

Updating the submodule

The great thing about submodules is that they're simple repositories. You can easily go to your project's directory and use git pull to update to the latest version.

cd Assets/Elarion
git pull # or any other git command

Just remember that this will generate a changeset in your repository which you'll have to later commit.

Contributing

The project is, of course, open to contributions. Just fork it and post a pull request.

Authors

License

This project is licensed under the MIT - see the LICENSE file for details.