Skip to content

Latest commit

 

History

History
423 lines (292 loc) · 12.3 KB

README.md

File metadata and controls

423 lines (292 loc) · 12.3 KB
Raw

Facti   crates.io docs.rs Build status Audit status

A CLI tool to interact with Factorio mods both locally and via the API and aid in mod development.

Important

Facti is in its early stages and very much a work in progress and highly experimental.

Any commands and APIs are subject to change while it's still in pre-release.

Quick links: Installation — Building — Usage — Configuration

Contributing

GitHub discussions   Matrix room

Contributors are very welcome!

If you want to discuss the project you can do so in the discussions on GitHub or join the Matrix room.

Installation

Cargo

You can install Facti using cargo binstall:

cargo binstall facti

This will fetch and install binaries from the latest release of Facti automatically.

If you don't want to use binstall you can also use regular cargo install:

cargo install facti

Which will download, compile, and install Facti from crates.io.

Pre-built binaries

If all else fails, you can manually download and use pre-built binaries from the latest release of Facti.

Building

Facti is written in Rust, so you'll have to install Rust to build it.

After you have it set up, it's as simple as these steps:

git clone https://github.com/Sharparam/facti.git
cd facti

cargo build --workspace --release
# Or if you want all available features:
cargo build --workspace --release --all-features

# If you want to build just the facti binary:
cargo build --package facti --release

# The finished binary will be in target/release where you can run it directly:
./target/release/facti --help

# Or copy it somewhere like your local bin directory:
cp target/release/facti ~/.local/bin

Running tests

Facti has several tests that can be run with cargo test:

cargo test --workspace --all-features

Features

Facti has a few optional features that can be enabled when building, these are:

  • ron: Enables support for the RON format when converting between formats.

    E.g. facti changelog convert --to ron changelog.txt to convert a changelog to RON.

  • sexpr: Enables support for the S-expression format when converting between formats.

    E.g. facti changelog convert --to sexpr changelog.txt to convert a changelog to S-expressions.

  • yaml: Enables support for the YAML format when converting between formats.

    E.g. facti changelog convert --to yaml changelog.txt to convert a changelog to YAML.

Manpages

You can generate manpages for Facti using the man task in xtask:

cargo xtask man

The finished manpages will be in target/assets/man.

Completions

Generating shell completions is done with the facti binary itself, and supports completions for Bash, Zsh, fish, Elvish, and PowerShell.

facti completion bash
facti completion zsh
facti completion fish
facti completion elvish
facti completion powershell

Usage

For more help on the CLI commands, you can run facti help <command> or facti <command> --help.

Warning

Commands outlined here are still experimental and subject to change. Additionally, some commands may not have been implemented yet.

Expected mod layout

This tool expects your mod to be organized a certain way, as shown by the diagram below.

(The .git folder is just to show where the root of the Git repo is.)

my-mod/
├── .git/
└── src/
    ├── locale/
    │   └── en/
    │       └── mod.cfg
    ├── info.json
    ├── changelog.txt
    ├── control.lua
    ├── data.lua
    └── thumbnail.png

Create new mod

Facti can bootstrap a new mod for you, placing some placeholder files and setting up the expected folder structure:

facti new [mod-name]

When invoked without a name, it will set it up in the current directory, if it is empty, using the directory name as the mod name.

Packaging

You can use facti to package your mod for distribution to the mod portal (or elsewhere) by using facti pack:

facti pack

If this command is used inside a Git repo, it will check to make sure the project layout matches the one describes under Expected mod layout.

If the current directory is not a Git repo, but contains an info.json file, it will treat that as the mod directory.

To override the mod directory, pass it as an argument to pack:

facti pack cool/path/to/mod

Passing an explicit directory will disable Git repository detection and fail if the specified directory does not contain an info.json file.

Mod Portal

You can interact with the Factorio mod portal via facti by using the facti portal command.

Here are some examples:

# Search for mods that match the name "cybersyn-combinator"
facti portal search cybersyn-combinator

# Show information about the cybersyn-combinator mod
facti portal show cybersyn-combinator

# Show more detailed information about the cybersyn-combinator mod
facti portal show --full cybersyn-combinator

# By default, deprecated mods are excluded from search
# if you want to show them you have to specify the --deprecated flag
facti portal search --deprecated

# You can enable JSON output by supplying the --json flag.
# In a non-interactive context, this is the default
# and can be negated with --no-json
facti portal --json show --full cybersyn-combinator

# Checks if all listed mods are compatible with each other.
# Currently this just makes sure none of the mods have each other listed
# as "incompatible"
facti portal check cybersyn-combinator cybersyn

# By default the above command will check against the latest version of each
# mod, to check a specific version you can include a version requirement
facti portal check [email protected] [email protected]

Configuration

Some commands like uploading mod packages to the mod portal require the use of an API key.

To obtain this, you must generate an API key on your Factorio profile page.

Important

Your API key is highly sensitive, do not store it anywhere other people than you might get access to it.

Facti maintainers will NEVER ask for your API key.

Anyone who gets access to your API key can publish and/or modify your mods without your approval, depending on the permissions on the key.

To make use of all features in facti, you must enable all three usage checkboxes:

  • ModPortal: Upload Mods
  • ModPortal: Publish Mods
  • ModPortal: Edit Mods

Of course, if you know you will not use some of these, you can disable them to avoid granting more permissions than necessary.

You can either provide the API key with every invocation of facti like so:

# Directly as a parameter
facti --api-key <your-api-key> ...

# from stdin to avoid it showing up in shell history
$ facti --api-key-stdin ...
Please input your Factorio API key to continue:
>

# read it from a file
$ facti --api-key-file <path-to-file> ...

Or save it in facti's configuration file:

[factorio]
api-key = "<your-api-key>"

facti will look for its configuration file in the following places and in this order:

  1. $XDG_CONFIG_HOME/facti/config.toml
  2. $HOME/.config/facti/config.toml

You can manually specify the location of the config file when invoking facti:

facti --config <path-to-config-file> ...

You can also supply the API key via environment variables:

export FACTI_FACTORIO_API_KEY="<your-api-key>"
facti ...

As well as the path to the config file:

export FACTI_CONFIG="<path-to-config-file>"
facti ...

Configuration hierarchy

As a rule, the most "direct" application of a setting is the one that will be in effect.

Essentially, this means settings are resolved in this order:

  1. Command line arguments
  2. Environment variables
  3. Configuration file

The first one encountered "wins".

For API keys specifially, there is also a priority within the different ways to supply it:

  1. Direct value

    • --api-key command line option
    • FACTI_FACTORIO_API_KEY environment variable
    • api-key setting in config file

  2. From standard input (stdin) with --api-key-stdin

  3. From file

    • --api-key-file command line option
    • FACTI_FACTORIO_API_KEY_FILE environment variable
    • api-key-file setting in config file

The first one encountered wins, with respect to the primary hierarchy of CLI arguments vs environment variables vs config file.

For example: If your config file has a value for api-key, and the environment variable FACTI_FACTORIO_API_KEY_FILE is set, and you also specify --api-key-stdin, then the stdin method will win, because it was specified via command line argument, which is in the top primary priority.

License

Copyright © 2023 by Adam Hellberg.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.