What is FigVCS anyway?

FigVCS is a (VCS) Version Control System built specifically for managing FiguraMC avatars.

Contents

• Installation
  • Windows (easiest)
  • Linux
  • Prefer clicking?
  • Building from source (devs/contributors)
• Quick start
• More docs
• Plans for this project
• Copyright

Installation

You do not need to know how to code or install any developer tools. Pick your system below.

Windows (easiest)

1. Press Win + X and choose Windows PowerShell.
2. Paste this one line and press Enter:

   irm https://raw.githubusercontent.com/catsizedcoder/FigVCS/main/install.ps1 | iex

3. Close the terminal and open a new one. Done! Try it: fvcs --help

the script only downloads the FigVCS binary from this repository and adds it to your PATH.

Linux

curl -sSfL https://raw.githubusercontent.com/catsizedcoder/FigVCS/main/install.sh | sh

Prefer clicking?

Grab fvcs-windows-x86_64.zip (or the Linux tarball) from the Releases page, unzip it anywhere, and run fvcs.exe (windows) or fvcs (linux) from that folder.

Building from source (devs/contributors)

Requires a Rust toolchain:

cargo build --release

The binary is built to target/release/.

Quick start

cd path/to/your/avatar     # the folder containing avatar.json
fvcs init                  # create the repository (.fvcs/)
fvcs add .                 # stage all files
fvcs commit -m "initial"   # record the first version

Files listed in .fvcsignore (Formatted in the same way as git.) are excluded from tracking.

More docs

• Usage.md | every command, remotes, accounts & permissions, library linking, the central registry, and how storage works.
• HOSTING.md | run your own fvcs-server: flags, anti-spam, garbage collection, and size limits.

Plans for this project

• Establish a system that is low on storage usage but effective.
• Establish an efficient system so that if a hub is created for avatars the local versioned repos can be uploaded with ease.
• Add easy library linking to have libraries update automatically with something like fvcs pull
• Eventually a Desktop GUI with Linux and Windows support(Possibly even MacOS support) since I know not everyone prefers CLI
• A Minecraft Companion mod for FigVCS that allows for dynamically saving versions of avatars and managing versions within FiguraMC
• Add the support for automatic backups to a server if configured, allowing for avatars to be restored even if the user encounters hardware failure.
• Create a system that is similar to git except more user friendly while also not compromising usability and allowing for in depth usage for automation scripts and such.
• Create a public server for FigVCS that the community can use.

Copyright

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. In other words you may share and modify the source code, however you may not use the code for commercial purposes, you must distribute your contributions under the same license as the original, you may not apply legal terms or technological measures that legally restrict others from doing anything the license permits, and you may not use the code without giving proper credit to me, you must indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests that I endorse you or your use. For more details please read the page on creativecommons.org