Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/itzg/mc-image-helper

This tool does the complicated bits for the itzg/minecraft-server image
https://github.com/itzg/mc-image-helper

cli docker minecraft-server

Last synced: 1 day ago
JSON representation

This tool does the complicated bits for the itzg/minecraft-server image

Host: GitHub
URL: https://github.com/itzg/mc-image-helper
Owner: itzg
License: mit
Created: 2021-09-09T23:09:45.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-10-29T12:39:01.000Z (4 months ago)
Last Synced: 2024-10-29T15:07:58.539Z (4 months ago)
Topics: cli, docker, minecraft-server
Language: Java
Homepage:
Size: 1.27 MB
Stars: 57
Watchers: 2
Forks: 26
Open Issues: 45
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/itzg/mc-image-helper?sort=semver)](https://github.com/itzg/mc-image-helper/releases/latest)
[![test](https://github.com/itzg/mc-image-helper/actions/workflows/test.yml/badge.svg)](https://github.com/itzg/mc-image-helper/actions/workflows/test.yml)

This tool does the complicated bits for the [itzg/minecraft-server](https://github.com/itzg/docker-minecraft-server) and [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/) Docker images.

## Usage

> **NOTE** The following documentation may not always be up-to-date. Please be sure to use `-h` or `--help` after any subcommand to view the current usage.

```
Usage: mc-image-helper [-hs] [--debug] [COMMAND]
--debug Enable debug output. Can also set environment variable
DEBUG_HELPER
-h, --help Show this usage and exit
-s, --silent Don't output logs even if there's an error
Commands:
asciify Converts UTF-8 on stdin to ASCII by escaping
Unicode characters
assert Provides assertion operators for verifying
container setup
compare-versions Used for shell scripting, exits with success(0)
when comparison is satisfied or 1 when not
curseforge-files Download and manage individual mod/plugin files
from CurseForge
find Specialized replacement for GNU's find
get Download a file
github
hash Outputs an MD5 hash of the standard input
install-curseforge Downloads, installs, and upgrades CurseForge
modpacks
install-fabric-loader Provides a few ways to obtain a Fabric loader with
simple cleanup of previous loader instances
install-forge Downloads and installs a requested version of Forge
install-modrinth-modpack Supports installation of Modrinth modpacks along
with the associated mod loader
install-neoforge Downloads and installs a requested version of
NeoForge
install-paper Installs selected PaperMC
install-purpur Downloads latest or selected version of Purpur
install-quilt Installs Quilt mod loader
interpolate Interpolates existing files in one or more
directories
java-release Outputs the Java release number, such as 8, 11, 17
manage-users
maven-download Downloads a maven artifact from a Maven repository
modrinth Automates downloading of modrinth resources
mcopy Multi-source file copy operation with with managed
cleanup. Supports auto-detected sourcing from
file list, directories, and URLs
network-interfaces Provides simple operations to list network
interface names and check existence
patch Patches one or more existing files using JSON path
based operations
Supports the file formats:
- JSON
- JSON5
- Yaml
- TOML, but processed output is not pretty
resolve-minecraft-version Resolves and validate latest, snapshot, and
specific versions
set-properties Maps environment variables to a properties file
show-all-subcommand-usage Renders all of the subcommand usage as markdown
sections for README
sync Synchronizes the contents of one directory to
another.
sync-and-interpolate Synchronizes the contents of one directory to
another with conditional variable interpolation.
test-logging-levels
toml-path Extracts a path from a TOML file using json-path
syntax
yaml-path Extracts a path from a YAML file using json-path
syntax
vanillatweaks Downloads Vanilla Tweaks resource packs, data
packs, or crafting tweaks given a share code or
pack file
```

For [patch](#patch) command [see below](#patch-schemas) for a description of [PatchSet](#patchset) and [PatchDefinition](#patchdefinition) JSON schemas.

For [install-curseforge](#install-curseforge) and [install-modrinth-modpack](#install-modrinth-modpack) commands, refer to [the exclude/include file schema](#excludeinclude-file-schema).

### asciify

```
Usage: mc-image-helper asciify
Converts UTF-8 on stdin to ASCII by escaping Unicode characters
```

### assert

```
Usage: mc-image-helper assert [COMMAND]
Provides assertion operators for verifying container setup
Commands:
fileExists
fileNotExists
jsonPathEquals
propertyEquals
```

### compare-versions

```
Usage: mc-image-helper compare-versions

Used for shell scripting, exits with success(0) when comparison is satisfied or
1 when not

```

### curseforge-files

```
Usage: mc-image-helper curseforge-files [-h] [--disable-api-caching]
[--api-base-url=]
[--api-key=]
[--default-category=]
[--game-version=]
[--mod-loader=] [-o=DIR]
[[--api-cache-ttl=OPERATION=DURATION]...
[--api-cache-default-ttl=DURATION]]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeo
ut=DURATION]
[--connection-pool-max-idle-timeout=DURA
TION]] [REF[,REF...]...]
Download and manage individual mod/plugin files from CurseForge
[REF[,REF...]...] Can be |':', |'@', |, project page URL, file page URL,
'@'
If not specified, any previous mod/plugin files are
removed
--api-base-url=
Allows for overriding the CurseForge Eternal API used
Can also be passed via CF_API_BASE_URL
--api-cache-default-ttl=DURATION
Set default/fallback TTL in ISO-8601 duration format.
Default: P2D
--api-cache-ttl=OPERATION=DURATION
Set individual operation TTLs
--api-key= An API key allocated from the Eternal developer
console at https://console.curseforge.com/
Can also be passed via CF_API_KEY
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--default-category=
When providing slugs, a category is required to
qualify those
--disable-api-caching

--game-version=
The Minecraft version
Can also be passed via VERSION
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--mod-loader=
One of Any, Forge, Cauldron, LiteLoader, Fabric,
Quilt, NeoForge
-o, --output-directory=DIR

--tls-handshake-timeout=DURATION
Default: PT30S
```

### find

```
Usage: mc-image-helper find [-hq] [--delete] [--delete-empty-directories]
[--fail-no-matches] [--only-shallowest]
[--output-count-only] [--stop-on-first]
[--format=] [--max-depth=N] [--min-depth=N]
[--exclude-name=glob[\s*,\s*glob...]]...
[--name=glob[\s*,\s*glob...]]... [-t=[\s*,
\s*...]]... startDir...
Specialized replacement for GNU's find
startDir... One or more starting directories
--delete Deletes the matched entries. When searching for
directories, each directory and its contents will
be recursively deleted.
--delete-empty-directories
Deletes a traversed directory if it becomes empty
after matching files/directories within it were
deleted
--exclude-name=glob[\s*,\s*glob...]
One or more glob patterns to exclude by looking at
name part of the path. If a pattern matches a
directory's name, then its entire subtree is
excluded.
--fail-no-matches
--format= Applies a format when printing each matched entry.
Supports the following directives
%% a literal %
%h leading directory of the entry
%P path of the entry relative to the starting point
-h, --help
--max-depth=N Unlimited depth if negative
--min-depth=N Minimum match depth where 0 is a starting point
--name=glob[\s*,\s*glob...]
One or more glob patterns to match name part of the
path
--only-shallowest
--output-count-only
-q, --quiet
--stop-on-first
-t, --type=[\s*,\s*...]
Valid values: file, directory
```

### get

```
Usage: mc-image-helper get [-hz] [--exists] [--log-progress-each]
[--output-filename] [--skip-existing]
[--apikey=] [--json-path=]
[--json-value-when-missing=]
[-o=FILE|DIR] [--prune-depth=]
[--retry-count=]
[--retry-delay=]
[--uris-file=]
[--accept=[\s*,
\s*...]]... [--prune-others=GLOB
[\s*,\s*GLOB...]]... [URI[\s*,\s*URI...]...]
Download a file
[URI[\s*,\s*URI...]...]
The URI of the resource to retrieve. When the
output is a directory, more than one URI can be
requested.
--accept=[\s*,\s*...]
Specifies the accepted content type(s) to use with
the request
--apikey=
Specifies the accept header to use with the request
--exists Test if the given URIs are retrievable
-h, --help Show this usage and exit
--json-path=
Extract and output a JsonPath from the response
--json-value-when-missing=
Defines the value that is output when the requested
JSON path does not exist. An empty value results
in a non-zero exit code.
--log-progress-each Output a log as each URI is being retrieved
-o, --output=FILE|DIR Specifies the name of a file or directory to write
the downloaded content. If a directory is
provided, the filename will be derived from the
content disposition or the URI's path. If not
provided, then content will be output to standard
out.
--output-filename Output the resulting filename
--prune-depth=
When using prune-others, this specifies how deep to
search for files to prune
--prune-others=GLOB[\s*,\s*GLOB...]
When set and using an output directory, files that
match the given glob patterns will be pruned if
not part of the download set. For example *.jar
--retry-count=

--retry-delay=
in seconds
--skip-existing Do not retrieve if the output file already exists
--uris-file=
A file that contains a URL per line
-z, --skip-up-to-date Skips re-downloading a file that is up to date
```

### github

```
Usage: mc-image-helper github [COMMAND]
Commands:
download-latest-asset From the latest release, downloads the first matching
asset, and outputs the downloaded filename
```

### hash

```
Usage: mc-image-helper hash
Outputs an MD5 hash of the standard input
```

### install-curseforge

```
Usage: mc-image-helper install-curseforge [-h] [--disable-api-caching]
[--force-reinstall-modloader] [--force-synchronize]
[--overrides-skip-existing] [--api-base-url=]
[--api-key=] [--downloads-repo=DIR] [--file-id=]
[--filename-matcher=STR] [--missing-mods-filename=]
[--modpack-manifest=PATH] [--modpack-page-url=URL] [--modpack-zip=PATH]
[-o=DIR] [--results-file=FILE] [--set-level-from=]
[--slug=] [--ignore-missing-files=[,
|...]]...
[--overrides-exclusions=[NL or ,
...]]... [[--exclude-include-file=FILE|URI]
[[--exclude-mods=PROJECT_ID|SLUG[,|PROJECT_ID|SLUG...]]...
[--force-include-mods=PROJECT_ID|SLUG[,|PROJECT_ID|SLUG...]]...]]
[[--http-response-timeout=DURATION] [--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=DURATION]
[--connection-pool-max-idle-timeout=DURATION]]
[[--api-cache-ttl=OPERATION=DURATION]...
[--api-cache-default-ttl=DURATION]] [COMMAND]
Downloads, installs, and upgrades CurseForge modpacks
--api-base-url=
Allows for overriding the CurseForge Eternal API
used
--api-cache-default-ttl=DURATION
Set default/fallback TTL in ISO-8601 duration
format.
Default: P2D
--api-cache-ttl=OPERATION=DURATION
Set individual operation TTLs
--api-key= An API key allocated from the Eternal developer
console at https://console.curseforge.com/
Can also be passed via CF_API_KEY
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--disable-api-caching
--downloads-repo=DIR A local directory that will supply pre-downloaded
mod and modpack files that are marked disallowed
for automated download. The subdirectories mods,
modpacks, and worlds will also be consulted
accordingly.
--exclude-include-file=FILE|URI
A JSON file that contains global and per modpack
exclude/include declarations. See README for
schema.
--exclude-mods=PROJECT_ID|SLUG[,|PROJECT_ID|SLUG...]
For mods that need to be excluded from server
deployments, such as those that don't label as
client
--file-id=
--filename-matcher=STR Substring to select specific modpack filename
--force-include-mods=PROJECT_ID|SLUG[,|PROJECT_ID|SLUG...]
Some mods incorrectly declare client-only support,
but still need to be included in a server deploy.
This can also be used to selectively override
exclusions.
--force-reinstall-modloader

--force-synchronize
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--ignore-missing-files=[,|...]
These files will be ignored when evaluating if the
modpack is up to date
--missing-mods-filename=

--modpack-manifest=PATH
Similar to --modpack-zip but provide the manifest.
json from the modpack.
Can be a local file path or a URL to a manifest.
--modpack-page-url=URL URL of a modpack page such as
https://www.curseforge.
com/minecraft/modpacks/all-the-mods-8or a file's
page
https://www.curseforge.
com/minecraft/modpacks/all-the-mods-8/files/42483
90
--modpack-zip=PATH Path to a pre-downloaded modpack client zip file
that can be used when modpack author disallows
automation.
Can also be passed via CF_MODPACK_ZIP
-o, --output-directory=DIR
--overrides-exclusions=[NL or ,
...]
Excludes files from the overrides that match these
ant-style patterns
* : matches any non-slash characters
** : matches any characters
? : matches one character
--overrides-skip-existing
When enabled, existing files will not be replaced
by overrides content from the modpack
--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--set-level-from=
When WORLD_FILE, a world file included the modpack
will be unzipped into a folder under 'saves' and
referenced as 'LEVEL' in the results file.
When OVERRIDES and the overrides contains a world
save directory (contains level.dat), then that
directory will be referenced as 'LEVEL' in the
results file.
In either case, existing world data will be
preserved and skipped if it already exists.
Valid values: WORLD_FILE, OVERRIDES
--slug= The short-URL identifier
--tls-handshake-timeout=DURATION
Default: PT30S
Commands:
schemas Output relevant JSON schemas
```

### install-fabric-loader

```
Usage: mc-image-helper install-fabric-loader [-h] [--output-directory=DIR]
[--results-file=FILE] [--from-local-file=FILE | --from-url=URL |
[[--minecraft-version=VERSION] [--installer-version=VERSION]
[--loader-version=VERSION]]]
Provides a few ways to obtain a Fabric loader with simple cleanup of previous
loader instances
--from-local-file=FILE

--from-url=URL
-h, --help
--installer-version=VERSION
By default the latest installer version is used
--loader-version=VERSION
By default the latest launcher version is used
--minecraft-version=VERSION

--output-directory=DIR

--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
```

### install-forge

```
Usage: mc-image-helper install-forge [-h] [--force-reinstall]
[--minecraft-version=VERSION]
[--output-directory=DIR]
[--results-file=FILE]
[--forge-installer= |
[--forge-version=]]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=
DURATION]
[--connection-pool-max-idle-timeout=DURATIO
N]]
Downloads and installs a requested version of Forge
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--force-reinstall
--forge-installer=
Use a local forge installer
--forge-version=
A specific Forge version or to auto-resolve the
version provide 'latest' or 'recommended'.
Default value is recommended
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--minecraft-version=VERSION
'latest', which is the default, or a specific
version
--output-directory=DIR

--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
```

### install-modrinth-modpack

```
Usage: mc-image-helper install-modrinth-modpack [--force-modloader-reinstall]
[--force-synchronize] [--api-base-url=]
[--default-exclude-includes=FILE|URI] [--default-version-type=TYPE]
[--game-version=] [--loader=]
[--output-directory=DIR] --project=
[--results-file=FILE] [--version=]
[--exclude-files=[,|...]]...
[--force-include-files=[,
|...]]...
[--ignore-missing-files=[,
|...]]...
[--overrides-exclusions=[NL or ,
...]]... [[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=DURATION]
[--connection-pool-max-idle-timeout=DURATION]]
Supports installation of Modrinth modpacks along with the associated mod loader
--api-base-url=
Default: https://api.modrinth.com
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--default-exclude-includes=FILE|URI
A JSON file that contains global and per modpack
exclude/include declarations. See README for
schema.
--default-version-type=TYPE
Valid values: release, beta, alpha
Default: release
--exclude-files=[,|...]
Files to exclude, such as improperly declared
client mods. It will match any part of the file's
name/path.
--force-include-files=[,|...]
Files to force include that were marked as
non-server mods. It will match any part of the
file's name/path.
--force-modloader-reinstall

--force-synchronize
--game-version=
Applicable Minecraft version
Default: (any)
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--ignore-missing-files=[,|...]
These files will be ignored when evaluating if the
modpack is up to date
--loader= Valid values: fabric, forge, quilt, neoforge
Default: (any)
--output-directory=DIR

--overrides-exclusions=[NL or ,
...]
Excludes files from the overrides that match these
ant-style patterns
* : matches any non-slash characters
** : matches any characters
? : matches one character
--project=
One of
- Project ID or slug
- Project page URL
- Project file URL
- Custom URL of a hosted modpack file
- Local path to a modpack file
--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
--version, --version-id=
Version ID, name, or number from the file's metadata
Default chooses newest file based on game version,
loader, and/or default version type
```

### install-neoforge

```
Usage: mc-image-helper install-neoforge [-h] [--force-reinstall]
[--minecraft-version=VERSION]
[--neoforge-version=]
[--output-directory=DIR]
[--results-file=FILE]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeo
ut=DURATION]
[--connection-pool-max-idle-timeout=DURA
TION]]
Downloads and installs a requested version of NeoForge
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--force-reinstall
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--minecraft-version=VERSION
'latest', which is the default, or a specific
version to narrow NeoForge version selection
--neoforge-version=
A specific NeoForge version, 'latest', or 'beta'.
Default value is latest
--output-directory=DIR

--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
```

### install-paper

```
Usage: mc-image-helper install-paper [--check-updates] [--base-url=]
[-o=]
[--results-file=FILE] [--url=
| [[--project=] [--build=]
[--channel=]
[--version=]]]
[[--http-response-timeout=DURATION] |
[--tls-handshake-timeout=DURATION] |
--connection-pool-pending-acquire-timeout=D
URATION |
--connection-pool-max-idle-timeout=DURATION
]
Installs selected PaperMC
--base-url=
--build=
--channel=
--check-updates Check for updates and exit with status code 0 when
available
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
-o, --output-directory=

--project=
--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
--url= Use a custom URL location
--version= May be 'latest' or specific version
```

### install-purpur

```
Usage: mc-image-helper install-purpur [--base-url=]
[-o=]
[--results-file=FILE]
[--url= |
[[--version=]
[--build=]]]
[[--http-response-timeout=DURATION] |
[--tls-handshake-timeout=DURATION] |
--connection-pool-pending-acquire-timeout=
DURATION |
--connection-pool-max-idle-timeout=DURATIO
N]
Downloads latest or selected version of Purpur
--base-url=
--build=
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
-o, --output-directory=

--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
--url= Use a custom URL location
--version= May be 'latest' or specific version
```

### install-quilt

```
Usage: mc-image-helper install-quilt [-h] [--force-reinstall]
[--loader-version=VERSION]
[--minecraft-version=VERSION]
[--output-directory=DIR]
[--repo-url=]
[--results-file=FILE] [--installer-url=URL
| --installer-version=VERSION]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=
DURATION]
[--connection-pool-max-idle-timeout=DURATIO
N]]
Installs Quilt mod loader
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--force-reinstall
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--installer-url=URL
--installer-version=VERSION
Default uses latest
--loader-version=VERSION
Default uses latest
--minecraft-version=VERSION
'latest', 'snapshot', or specific version
--output-directory=DIR
--repo-url= Default: https://maven.quiltmc.
org/repository/release
--results-file=FILE A key=value file suitable for scripted environment
variables. Currently includes
SERVER: the entry point jar or script
--tls-handshake-timeout=DURATION
Default: PT30S
```

### interpolate

```
Usage: mc-image-helper interpolate [-h] ([--replace-env-prefix=]
[--replace-env-excludes=FILENAME[,
FILENAME...]]...
[--replace-env-exclude-paths=PATH[,
PATH...]]... --replace-env-file-suffixes=PATH
[,PATH...] [--replace-env-file-suffixes=PATH
[,PATH...]]...) [DIRECTORY...]
Interpolates existing files in one or more directories
[DIRECTORY...]
-h, --help Show this usage and exit
--replace-env-exclude-paths=PATH[,PATH...]
Destination paths that will be excluded from processing
--replace-env-excludes=FILENAME[,FILENAME...]
Filenames (without path) that should be excluded from
processing.
--replace-env-file-suffixes=PATH[,PATH...]
Filename suffixes (without dot) that should be
processed. For example: txt,json,yaml
--replace-env-prefix=
Only placeholder variables with this prefix will be
processed.
Default: CFG_
```

### java-release

```
Usage: mc-image-helper java-release
Outputs the Java release number, such as 8, 11, 17
```

### manage-users

```
Usage: mc-image-helper manage-users [-fh] [--existing=]
[--mojang-api-base-url=]
[--output-directory=]
[--playerdb-api-base-url=] -t=
[--user-api-provider=]
[--version=]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=D
URATION]
[--connection-pool-max-idle-timeout=DURATION
]] [INPUT[,INPUT...]...]
[INPUT[,INPUT...]...] One or more Mojang usernames, UUID, or ID (UUID
without dashes); however, when offline, only
UUID/IDs can be provided.
When input is a file, only one local file path or
URL can be provided
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--existing=
Select the behavior when the resulting file already
exists
Allowed: SYNCHRONIZE, MERGE, SKIP
-f, --input-is-file
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--mojang-api-base-url=

--output-directory=

--playerdb-api-base-url=

-t, --type= Allowed: JAVA_WHITELIST, JAVA_OPS
--tls-handshake-timeout=DURATION
Default: PT30S
--user-api-provider=
Allowed: mojang, playerdb
--version= Minecraft game version. If not provided, assumes
JSON format
```

### maven-download

```
Usage: mc-image-helper maven-download [-h] [--print-filename] [--skip-existing]
[--skip-up-to-date] -a=
[--classifier=] -g=
[--output-directory=]
[--packaging=]
[-r=] [-v=]
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout
=DURATION]
[--connection-pool-max-idle-timeout=DURATI
ON]]
Downloads a maven artifact from a Maven repository
-a, -m, --module, --artifact=

--classifier=

--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

-g, --group=
-h, --help
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--output-directory=

--packaging=

--print-filename
-r, --maven-repo=

--skip-existing
--skip-up-to-date
--tls-handshake-timeout=DURATION
Default: PT30S
-v, --version= A specific version, 'release', or 'latest'
Default: release
```

### mcopy

```
Usage: mc-image-helper mcopy [-hz] [--file-is-listing] [--skip-existing]
[--glob=GLOB] [--scope=] --to=
SRC[,|SRC...]...
Multi-source file copy operation with with managed cleanup. Supports
auto-detected sourcing from file list, directories, and URLs
SRC[,|SRC...]... Any mix of source file, directory, or URLs.
Can be optionally comma or newline separated.
--file-is-listing Source files or URLs are processed as a line
delimited list of sources.
For remote listing files, the contents must all be
file URLs.
--glob=GLOB When a source is a directory, this filename glob
will be applied to select files.
-h, --help
--scope, --manifest-id=
If managed cleanup is required, this is the
identifier used for qualifying manifest filename
in destination
--skip-existing
--to, --output-directory=

-z, --skip-up-to-date
```

### modrinth

```
Usage: mc-image-helper modrinth [--skip-existing] [--skip-up-to-date]
[--allowed-version-type=]
[--api-base-url=]
[--download-dependencies=]
--game-version= --loader=
[--output-directory=DIR]
[--world-directory=]
[--projects=id|slug[,|id|slug...]]...
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=DURAT
ION]
[--connection-pool-max-idle-timeout=DURATION]]
Automates downloading of modrinth resources
--allowed-version-type=
Valid values: release, beta, alpha
--api-base-url=
Default: https://api.modrinth.com
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--download-dependencies=
Default is NONE
Valid values: NONE, REQUIRED, OPTIONAL
--game-version=
Applicable Minecraft version
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--loader= Valid values: fabric, quilt, forge, neoforge, bukkit,
spigot, paper, pufferfish, purpur, bungeecord,
velocity, datapack
--output-directory=DIR

--projects=id|slug[,|id|slug...]
Project ID or Slug
--skip-existing
--skip-up-to-date
--tls-handshake-timeout=DURATION
Default: PT30S
--world-directory=
Used for datapacks, a path relative to the output
directory or an absolute path
Default: world
```

### network-interfaces

```
Usage: mc-image-helper network-interfaces [--include-loopback]
[--check=]
Provides simple operations to list network interface names and check existence
--check=

--include-loopback
```

### patch

```
Usage: mc-image-helper patch [-h] [--patch-env-prefix=] FILE_OR_DIR
Patches one or more existing files using JSON path based operations
Supports the file formats:
- JSON
- JSON5
- Yaml
- TOML, but processed output is not pretty
FILE_OR_DIR Path to a PatchSet json file or directory containing
PatchDefinition json files
-h, --help Show this usage and exit
--patch-env-prefix=
Only placeholder variables with this prefix will be
processed
Default: CFG_
```

### resolve-minecraft-version

```
Usage: mc-image-helper resolve-minecraft-version
[[--http-response-timeout=DURATION] [--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=DURATION]
[--connection-pool-max-idle-timeout=DURATION]]
Resolves and validate latest, snapshot, and specific versions

--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--http-response-timeout=DURATION
The response timeout to apply to HTTP operations. Parsed
from ISO-8601 format. Default: PT30S
--tls-handshake-timeout=DURATION
Default: PT30S
```

### set-properties

```
Usage: mc-image-helper set-properties [--escape-unicode]
[--definitions=]
[-p=]...
Maps environment variables to a properties file

--definitions=
JSON file of property names to PropertyDefinition
mappings
--escape-unicode
-p, --custom-property, --custom-properties=
Key=value pairs of custom properties to set
```

### show-all-subcommand-usage

```
Usage: mc-image-helper show-all-subcommand-usage
Renders all of the subcommand usage as markdown sections for README
```

### sync

```
Usage: mc-image-helper sync [-h] [--skip-newer-in-destination]
Synchronizes the contents of one directory to another.
source directory
destination directory
-h, --help Show this usage and exit
--skip-newer-in-destination
Skip any files that exist in the destination and have a newer
modification time than the source.
```

### sync-and-interpolate

```
Usage: mc-image-helper sync-and-interpolate [-h] [--skip-newer-in-destination]
([--replace-env-prefix=] [--replace-env-excludes=FILENAME[,
FILENAME...]]... [--replace-env-exclude-paths=PATH[,PATH...]]...
--replace-env-file-suffixes=PATH[,PATH...]
[--replace-env-file-suffixes=PATH[,PATH...]]...)
Synchronizes the contents of one directory to another with conditional variable
interpolation.
source directory
destination directory
-h, --help Show this usage and exit
--replace-env-exclude-paths=PATH[,PATH...]
Destination paths that will be excluded from processing
--replace-env-excludes=FILENAME[,FILENAME...]
Filenames (without path) that should be excluded from processing.
--replace-env-file-suffixes=PATH[,PATH...]
Filename suffixes (without dot) that should be processed. For
example: txt,json,yaml
--replace-env-prefix=
Only placeholder variables with this prefix will be processed.
Default: CFG_
--skip-newer-in-destination
Skip any files that exist in the destination and have a newer
modification time than the source.
```

### test-logging-levels

```
Usage: mc-image-helper test-logging-levels
```

### toml-path

```
Usage: mc-image-helper toml-path query [file]
query JSON path expression where root element $ can be omitted
[file] TOML file or reads stdin
```

### vanillatweaks

```
Usage: mc-image-helper vanillatweaks [--force-synchronize]
[--base-url=]
[--output-directory=DIR]
[--world-subdir=]
[--pack-files=FILE[,|FILE...]]...
[--share-codes=CODE[,|CODE...]]...
[[--http-response-timeout=DURATION]
[--tls-handshake-timeout=DURATION]
[--connection-pool-pending-acquire-timeout=
DURATION]
[--connection-pool-max-idle-timeout=DURATIO
N]]
Downloads Vanilla Tweaks resource packs, data packs, or crafting tweaks given a
share code or pack file
--base-url=
--connection-pool-max-idle-timeout=DURATION

--connection-pool-pending-acquire-timeout=DURATION

--force-synchronize
--http-response-timeout=DURATION
The response timeout to apply to HTTP operations.
Parsed from ISO-8601 format. Default: PT30S
--output-directory=DIR
--pack-files=FILE[,|FILE...]

--share-codes=CODE[,|CODE...]

--tls-handshake-timeout=DURATION
Default: PT30S
--world-subdir=

```

### yaml-path

```
Usage: mc-image-helper yaml-path [--file=]
Extracts a path from a YAML file using json-path syntax
A YAML/JSON path in to query. Leading root anchor, $,
will be added if not present
--file= A YAML file to query
```

## Patch Schemas

### PatchSet

- `patches` : array of [PatchDefinition](#patchdefinition)

Example

```json
{
"patches": [
{
"file": "/data/paper.yml",
"ops": [
{
"$set": {
"path": "$.verbose",
"value": true
}
},
{
"$set": {
"path": "$.settings['velocity-support'].enabled",
"value": "${CFG_VELOCITY_ENABLED}",
"value-type": "bool"
}
},
{
"$put": {
"path": "$.settings",
"key": "my-test-setting",
"value": "testing"
}
}
]
}
]
}
```

### PatchDefinition

- `file` : Path to the file to patch
- `file-format` : **optional** If non-null, declares a specifically supported format name: json, yaml. Otherwise, the file format is detected by the file's suffix.
- `ops` : array of [PatchOperation](#patchoperation)

Example:

```json
{
"file": "/data/paper.yml",
"ops": [
{
"$set": {
"path": "$.verbose",
"value": true
}
},
{
"$set": {
"path": "$.settings['velocity-support'].enabled",
"value": "${CFG_VELOCITY_ENABLED}",
"value-type": "bool"
}
},
{
"$put": {
"path": "$.settings",
"key": "my-test-setting",
"value": "testing"
}
}
]
}
```

### PatchOperation

Each patch operation object contains a single key that one is one of the following sections and then an object within each. For example `{ "$set" : { ... } }`.

#### `$set`

The `$set` operation can set an existing field to a new value. If a new field needs to be added, use the [$put](#put) operation.

- `$set`
- `path` : The [JSON path](https://github.com/json-path/JsonPath#readme) to the field to set
- `value` : The value to set. If the given value is a string, variable placeholders of the form `${...}` will be replaced from the environment variables and the resulting string can be converted by setting value-type.
- `value-type` : **optional** [see below](#valuetype)

Example:

```json
{
"$set": {
"path": "$.verbose",
"value": true
}
}
```

#### `$put`

The `$put` operation can add or update a field with the given key within an object.

- `$put`
- `path` : The [JSON path](https://github.com/json-path/JsonPath#readme) to the object containing key to set
- `key` : The key to set
- `value` : The value to set. If the given value is a string, variable placeholders of the form `${...}` will be replaced from the environment variables and the resulting string can be converted by setting value-type.
- `value-type` : **optional** [see below](#valuetype)

Example:

```json
{
"$put": {
"path": "$.settings",
"key": "my-test-setting",
"value": "testing"
}
}
```

### ValueType

One of the following identifiers or can be prefixed with `list of ` to indicate a list of the identified type:
- int : integer/whole value
- float : numerical value with an optional decimal part
- bool : boolean value of `true` or `false`
- auto : where the text value is attempted to be converted into one of the above

## Exclude/Include File Schema

```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Mods Exclude/Include File Content",
"type": "object",
"additionalProperties": false,
"properties": {
"globalExcludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Mods by slug|id to exclude for all modpacks"
},
"globalForceIncludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Mods by slug|id to force include for all modpacks"
},
"modpacks": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ExcludeIncludes"
},
"description": "Specific exclude/includes by modpack slug"
}
},
"definitions": {
"ExcludeIncludes": {
"type": "object",
"additionalProperties": false,
"properties": {
"excludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Mods by slug|id to exclude for this modpack"
},
"forceIncludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Mods by slug|id to force include for this modpack"
}
}
}
}
}
```