z_mirror/fmm

git clone https://git.raiguard.me/z_mirror/fmm

raiguardAdd paths for all platformsd7642c7

rust-ice
branchesdependenciespredep-parsingrefactorrewriterust-icetrunkupdatingall refs →
1.9 KiB80 linesraw

Factorio Mod Manager

fmm is a basic CLI Factorio mod manager. Is is completely portable and runs on all major platforms.

Getting started

Installing

Download the binary for your system from the releases page and place it on your PATH.

Coming soon: an AUR package.

Building

Requires Rust nightly.

git clone https://github.com/raiguard/fmm & cd fmm
cargo build

Installing to PATH

You can build fmm from source and install it on your PATH like this:

cargo install --locked --force --path .

Or just run this without cloning the repository:

cargo install fmm

Usage

fmm --enable space-exploration

See fmm --help for all subcommands.

Features

  • List all mods in the mods directory
  • Enable mods and their dependencies
  • Disable mods
  • Enable or disable all mods at once
  • Enable pre-defined sets of mods
  • Sync enabled mods with a save file
  • Download mods from the portal
  • Remove mods from your mods directory

Configuration

fmm accepts a --config flag with a path to a toml configuration file. If --config is not provided, fmm will look for this file in the following location:

PlatformPath
Linux/home/rai/.config/fmm/fmm.toml
macOS/Users/Rai/Library/Application Support/fmm/fmm.toml
WindowsC:\Users\Rai\AppData\Roaming\fmm\fmm.toml

Values passed as flags will override those in the config file.

EXAMPLE CONFIGURATION

Roadmap

Roughly in this order:

  • Sync with mod-list.json
  • Local config
  • Automatically publish to AUR
  • Create new mod
  • Package mod
  • Datestamp and increment mod version
  • Download mods
  • Upload mods
1# Factorio Mod Manager
2
3`fmm` is a basic CLI Factorio mod manager. Is is completely portable and runs on all major platforms.
4
5## Getting started
6
7## Installing
8
9Download the binary for your system from the [releases](https://github.com/raiguard/fmm/releases) page and place it on your `PATH`.
10
11Coming soon: an AUR package.
12
13## Building
14
15Requires [Rust](https://rust-lang.org) nightly.
16
17```
18git clone https://github.com/raiguard/fmm & cd fmm
19cargo build
20```
21
22### Installing to `PATH`
23
24You can build `fmm` from source and install it on your `PATH` like this:
25
26```
27cargo install --locked --force --path .
28```
29
30Or just run this without cloning the repository:
31
32```
33cargo install fmm
34```
35
36## Usage
37
38```
39fmm --enable space-exploration
40```
41
42See `fmm --help` for all subcommands.
43
44## Features
45
46- List all mods in the mods directory
47- Enable mods and their dependencies
48- Disable mods
49- Enable or disable all mods at once
50- Enable pre-defined sets of mods
51- Sync enabled mods with a save file
52- Download mods from the portal
53- Remove mods from your mods directory
54
55## Configuration
56
57`fmm` accepts a `--config` flag with a path to a [`toml`](https://toml.io/en/) configuration file. If `--config` is not provided, `fmm` will look for this file in the following location:
58
59| Platform | Path                                                |
60| -------- | --------------------------------------------------- |
61| Linux    | /home/rai/.config/fmm/fmm.toml                      |
62| macOS    | /Users/Rai/Library/Application Support/fmm/fmm.toml |
63| Windows  | C:\Users\Rai\AppData\Roaming\fmm\fmm.toml           |
64
65Values passed as flags will override those in the config file.
66
67[EXAMPLE CONFIGURATION](./fmm.toml)
68
69## Roadmap
70
71Roughly in this order:
72
73- Sync with `mod-list.json`
74- Local config
75- Automatically publish to AUR
76- Create new mod
77- Package mod
78- Datestamp and increment mod version
79- Download mods
80- Upload mods