Getting Started¶

These guides take you from installing FlexVault to sharing a repository with your team. Follow them in order. If you already are reasonably familiar with Git, Perforce, or another version control system, you can skip step 2.

1. Installing FlexVault

Install the fxv command-line tool on Windows or Linux and confirm it runs.

Read the installation guide
2. Learning Version Control Basics

Start here if you are new to version control. Track changes to a project on your own machine, look back through its history, and restore earlier versions of files. No cloud account needed.

Learn the basics
3. Setting up a Shared Repository

Create a repository in cloud storage, connect a workspace to it, publish your first change, and sync changes from teammates.

Set up a shared repository

Editor and engine plugins¶

Once you have a workspace, editor and engine plugins integrate FlexVault directly into your workflow.

Install your engine's plugin before your first snapshot

The Unity, Godot, and Unreal Engine plugins add their engine's generated folders to .fxvignore so FlexVault does not track them. Ignore rules only apply to files FlexVault is not tracking yet, so install the plugin before you take your first snapshot or publish.

The plugins:

Use the Visual Studio Code Extension: Source control panel, gutter diffs, history inspection, and safe publish workflows.
Use the Unity Plugin: In-editor asset tracking, automatic .meta file pairing, and background snapshots.
Use the Godot Plugin: Dock and bottom-panel controls, companion file tracking, and automatic snapshots.
Use the Unreal Engine Plugin: Unreal Revision Control integration with asset status badges, visual diffs, and automatic snapshots.