z_mirror/fmm

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

Caleb HeuerUpdate man pages, help, and readme99c090b

predep-parsing
branchesdependenciespredep-parsingrefactorrewriterust-icetrunkupdatingall refs →
1.9 KiB84 linesraw
1FMM(1)
2
3# NAME
4
5fmm - a mod manager for factorio
6
7# SYNOPSIS
8
9*fmm* [options] <operation> args...
10
11# MOD SYNTAX
12
13Operations and settings that take _mod_ values expect a string in the format of
14*name* or *name_version*. If _version_ is omitted, it is assumed to be the
15newest version in the local mods directory (for local operations) or the newest
16version on the mod portal (for remote operations).
17
18_version_ takes the format of *major.minor.patch*, e.g. *1.1.3*. Leading zeroes
19will be ignored during comparison.
20
21## EXAMPLES
22
23```
24RecipeBook
25RecipeBook_3.5.2
26RecipeBook_4.0
27```
28
29# OPERATIONS
30
31*disable, d* [mods...]
32	Disable the specified mods, or disable all mods if none are specified.
33
34*download, dl* [mods...]
35	Download the specified mods and their dependencies.
36
37*enable, e* [mods...]
38	Enable the specified mods and their dependencies.
39
40*upload, ul* [files...]
41	Upload the specified mod zip files to the mod portal.
42
43# OPTIONS
44
45*-c* <file>
46	Path to a custom configuration file.
47
48*-h*
49	Show help message and quit.
50
51# ENVIRONMENT
52
53Environment variables will be prioritized over options set in the config file,
54but can be overridden by CLI options.
55
56To retrieve or reset your API key, token, or username, visit
57https://factorio.com/profile.
58
59*FACTORIO_API_KEY*
60	Your Factorio mod portal API key, used for the *upload* operation. The API key
61	must have authorization for the _upload mods_ action.
62
63*FACTORIO_TOKEN*
64	Your Factorio mod portal token, used for the *download* operation.
65
66*FACTORIO_USERNAME*
67	Your Factorio username.
68
69# MODS DIRECTORY
70
71fmm determines the mods directory in the following order:
72	- the current working directory
73	- the *mods_dir* setting
74
75A valid mods directory must have a _mod-list.json_ file.
76
77# CONFIGURATION
78
79See *fmm*(5) for the configuration file syntax.
80
81# AUTHORS
82
83Maintained by Caleb Heuer <ch@raiguard.me>. For more information about fmm
84development, see https://github.com/raiguard/fmm.