Skip to content

A tool and library used to manipulate SEGA's File Archive file format

License

Notifications You must be signed in to change notification settings

diva-rust-modding/farc

Repository files navigation

farchive Build Status

A command line tool and library used to create/manipulate SEGA's File Archive format.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and usage.

Prerequisites

What things you need to install the software

Installing

  • Clone this repository
$ git clone https://github.com/Waelwindows/farc.git
  • Install the project using cargo install
$ cargo install
  • (Only for developers) Build/test the project using cargo
$ cargo build
$ cargo test

And then you should be ready to run the program

$ farc
farc 0.1.0
Waelwindows <[email protected]>
manipulates SEGA File Archive file formats

USAGE:
    farc <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    create
    extract
    help       Prints this message or the help of the given subcommand(s)
    view

Versioning

We use SemVer for versioning.

License

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

Acknowledgments