Help for technical users

What is the setup that I need to do on the user's computer?

To start from scratch

Follow these Git and Unity setup instructions.

Then you can skip to "How to install Crafty"

If you want to work with a Unity project that is already in a local Git repository

Follow the Git and Unity setup instructions.

Skip step 2, 3 and 4.

Use the command line to make sure your credentials are working from the command line.
You might also need to setup the origin from the command line.

If that Unity project is not in a Git repository

You will need to connect it to a Git repository.

Follow the Git and Unity setup instructions.

You can skip step 4. Instead, after the instructions, take the folder of your existing Unity project, and move it into your newly created Git repository.

Like this:

If you want the user to push to a particular Git branch

Create the branch.

Chechout the branch.

Push it to the remote repository.

How to install Crafty?

Click here

How to use Crafty?

Click here

How does Crafty work?

Under the hood, Crafty is simply using the usual Git functions.

My team has a particular workflow, can I use Crafty?

It's only the beginning for Crafty. For now, it is designed mainly for an "art branch" workflow with default Git settings.
This means among other things that Crafty uses by default the current checked out branch. If the user needs to change branch or do something more particular, you can always use Git as usual.

How can I validate that Crafty works as expected?

The easiest way is to go on the service you used to create a Git server.

In this example, I used GitLab.

Go into the commit view. You can then notice commits, containing files that were sent by Crafty.