README
¶
Modtorio
Search mods.factorio.com from the command line! Intended for server environments where your "friends" constantly pester you to install new mods to your already poor, mod-overloaded server.
Development requirements
- Go v1.16+
Dependencies
- golang.org/x/crypto/ssh/terminal (used to hide user passwords)
Compiling
- Clone the project.
- Install dependencies with
go get. go buildor (go install).
Running
./modtorio help (or modtorio help if you installed it).
Docker
docker build -t modtorio .docker run -i -t modtorio <command>
Obviously the above is only really useful for searching and viewing the help documentation. In order to download, update, enable and disable, or list mods a directory must be provided.
docker run -i -t -v /absolute/path/to/mod/dir:/mods modtorio --dir /mods <command>
Providing a populated mod-list.json but no mod files in the directory will result in modtorio downloading the latest version for each mod in mod-list.json.
Licence
BSD-3 clause
Documentation
¶
Overview ¶
Package to search mods.factorio.com. Authentication with factorio.com is requried to download mods, and the user is prompted prior to downloading.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Common re-usable functions, types, and constants.
|
Common re-usable functions, types, and constants. |
|
Package to hold the credentials for a user logged in via the auth.factorio.com web API.
|
Package to hold the credentials for a user logged in via the auth.factorio.com web API. |
|
Sub-package containing all operations related to interactions with the mod list file.
|
Sub-package containing all operations related to interactions with the mod list file. |