updated docs with development documentation
All checks were successful
Actions / Build and Upload Export Files (push) Successful in 8s
Actions / Autotagger (push) Successful in 8s
Actions / Build Documentation (push) Successful in 22s

This commit is contained in:
SeaswimmerTheFsh 2024-05-09 14:15:56 -04:00
parent 47dcbad0a7
commit ece242a7a2
Signed by: cswimr
GPG key ID: 5D671B5D03D65A7F
33 changed files with 1087 additions and 0 deletions

34
docs/packwiz/packwiz.md Normal file
View file

@ -0,0 +1,34 @@
## packwiz
A command line tool for creating Minecraft modpacks
### Options
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
-h, --help help for packwiz
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz completion](packwiz_completion.md) - Generate the autocompletion script for the specified shell
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods
* [packwiz init](packwiz_init.md) - Initialise a packwiz modpack
* [packwiz list](packwiz_list.md) - List all the mods in the modpack
* [packwiz migrate](packwiz_migrate.md) - Migrate your Minecraft and loader versions to newer versions.
* [packwiz modrinth](packwiz_modrinth.md) - Manage modrinth-based mods
* [packwiz pin](packwiz_pin.md) - Pin a file so it does not get updated automatically
* [packwiz refresh](packwiz_refresh.md) - Refresh the index file
* [packwiz remove](packwiz_remove.md) - Remove an external file from the modpack; equivalent to manually removing the file and running packwiz refresh
* [packwiz serve](packwiz_serve.md) - Run a local development server
* [packwiz settings](packwiz_settings.md) - Manage pack settings
* [packwiz unpin](packwiz_unpin.md) - Unpin a file so it receives updates
* [packwiz update](packwiz_update.md) - Update an external file (or all external files) in the modpack
* [packwiz url](packwiz_url.md) - Add external files from a direct download link, for sites that are not directly supported by packwiz
* [packwiz utils](packwiz_utils.md) - Utilities for managing packwiz itself

View file

@ -0,0 +1,35 @@
## packwiz completion
Generate the autocompletion script for the specified shell
### Synopsis
Generate the autocompletion script for packwiz for the specified shell.
See each sub-command's help for details on how to use the generated script.
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz completion bash](packwiz_completion_bash.md) - Generate the autocompletion script for bash
* [packwiz completion fish](packwiz_completion_fish.md) - Generate the autocompletion script for fish
* [packwiz completion powershell](packwiz_completion_powershell.md) - Generate the autocompletion script for powershell
* [packwiz completion zsh](packwiz_completion_zsh.md) - Generate the autocompletion script for zsh

View file

@ -0,0 +1,54 @@
## packwiz completion bash
Generate the autocompletion script for bash
### Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(packwiz completion bash)
To load completions for every new session, execute once:
#### Linux:
packwiz completion bash > /etc/bash_completion.d/packwiz
#### macOS:
packwiz completion bash > $(brew --prefix)/etc/bash_completion.d/packwiz
You will need to start a new shell for this setup to take effect.
```
packwiz completion bash
```
### Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz completion](packwiz_completion.md) - Generate the autocompletion script for the specified shell

View file

@ -0,0 +1,45 @@
## packwiz completion fish
Generate the autocompletion script for fish
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
packwiz completion fish | source
To load completions for every new session, execute once:
packwiz completion fish > ~/.config/fish/completions/packwiz.fish
You will need to start a new shell for this setup to take effect.
```
packwiz completion fish [flags]
```
### Options
```
-h, --help help for fish
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz completion](packwiz_completion.md) - Generate the autocompletion script for the specified shell

View file

@ -0,0 +1,42 @@
## packwiz completion powershell
Generate the autocompletion script for powershell
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
packwiz completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
packwiz completion powershell [flags]
```
### Options
```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz completion](packwiz_completion.md) - Generate the autocompletion script for the specified shell

View file

@ -0,0 +1,56 @@
## packwiz completion zsh
Generate the autocompletion script for zsh
### Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(packwiz completion zsh); compdef _packwiz packwiz
To load completions for every new session, execute once:
#### Linux:
packwiz completion zsh > "${fpath[1]}/_packwiz"
#### macOS:
packwiz completion zsh > $(brew --prefix)/share/zsh/site-functions/_packwiz
You will need to start a new shell for this setup to take effect.
```
packwiz completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz completion](packwiz_completion.md) - Generate the autocompletion script for the specified shell

View file

@ -0,0 +1,30 @@
## packwiz curseforge
Manage curseforge-based mods
### Options
```
-h, --help help for curseforge
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz curseforge add](packwiz_curseforge_add.md) - Add a project from a CurseForge URL, slug, ID or search
* [packwiz curseforge detect](packwiz_curseforge_detect.md) - Detect .jar files in the mods folder (experimental)
* [packwiz curseforge export](packwiz_curseforge_export.md) - Export the current modpack into a .zip for curseforge
* [packwiz curseforge import](packwiz_curseforge_import.md) - Import a curseforge modpack from a downloaded pack zip or an installed metadata json file
* [packwiz curseforge open](packwiz_curseforge_open.md) - Open the project page for a CurseForge file in your browser

View file

@ -0,0 +1,33 @@
## packwiz curseforge add
Add a project from a CurseForge URL, slug, ID or search
```
packwiz curseforge add [URL|slug|search] [flags]
```
### Options
```
--addon-id uint32 The CurseForge project ID to use
--category string The category to add files from (slug, as stored in URLs); the category in the URL takes precedence
--file-id uint32 The CurseForge file ID to use
--game string The game to add files from (slug, as stored in URLs); the game in the URL takes precedence (default "minecraft")
-h, --help help for add
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods

View file

@ -0,0 +1,29 @@
## packwiz curseforge detect
Detect .jar files in the mods folder (experimental)
```
packwiz curseforge detect [flags]
```
### Options
```
-h, --help help for detect
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods

View file

@ -0,0 +1,31 @@
## packwiz curseforge export
Export the current modpack into a .zip for curseforge
```
packwiz curseforge export [flags]
```
### Options
```
-h, --help help for export
-o, --output string The file to export the modpack to
-s, --side string The side to export mods with (default "client")
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods

View file

@ -0,0 +1,29 @@
## packwiz curseforge import
Import a curseforge modpack from a downloaded pack zip or an installed metadata json file
```
packwiz curseforge import [modpack path] [flags]
```
### Options
```
-h, --help help for import
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods

View file

@ -0,0 +1,29 @@
## packwiz curseforge open
Open the project page for a CurseForge file in your browser
```
packwiz curseforge open [name] [flags]
```
### Options
```
-h, --help help for open
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz curseforge](packwiz_curseforge.md) - Manage curseforge-based mods

View file

@ -0,0 +1,48 @@
## packwiz init
Initialise a packwiz modpack
```
packwiz init [flags]
```
### Options
```
--author string The author of the modpack (omit to define interactively)
--fabric-latest Automatically select the latest version of Fabric loader
--fabric-version string The Fabric loader version to use (omit to define interactively)
--forge-latest Automatically select the latest version of Forge
--forge-version string The Forge version to use (omit to define interactively)
-h, --help help for init
--index-file string The index file to use (default "index.toml")
-l, --latest Automatically select the latest version of Minecraft
--liteloader-latest Automatically select the latest version of LiteLoader
--liteloader-version string The LiteLoader version to use (omit to define interactively)
--mc-version string The Minecraft version to use (omit to define interactively)
--modloader string The mod loader to use (omit to define interactively)
--name string The name of the modpack (omit to define interactively)
--neoforge-latest Automatically select the latest version of NeoForge
--neoforge-version string The NeoForge version to use (omit to define interactively)
--quilt-latest Automatically select the latest version of Quilt loader
--quilt-version string The Quilt loader version to use (omit to define interactively)
-r, --reinit Recreate the pack file if it already exists, rather than exiting
-s, --snapshot Use the latest snapshot version with --latest
--version string The version of the modpack (omit to define interactively)
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,31 @@
## packwiz list
List all the mods in the modpack
```
packwiz list [flags]
```
### Options
```
-h, --help help for list
-s, --side string Filter mods by side (e.g., client or server)
-v, --version Print name and version
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,27 @@
## packwiz migrate
Migrate your Minecraft and loader versions to newer versions.
### Options
```
-h, --help help for migrate
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz migrate loader](packwiz_migrate_loader.md) - Migrate your modloader version to a newer version.
* [packwiz migrate minecraft](packwiz_migrate_minecraft.md) - Migrate your Minecraft version to a newer version.

View file

@ -0,0 +1,29 @@
## packwiz migrate loader
Migrate your modloader version to a newer version.
```
packwiz migrate loader [version|latest|recommended] [flags]
```
### Options
```
-h, --help help for loader
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz migrate](packwiz_migrate.md) - Migrate your Minecraft and loader versions to newer versions.

View file

@ -0,0 +1,29 @@
## packwiz migrate minecraft
Migrate your Minecraft version to a newer version.
```
packwiz migrate minecraft [version] [flags]
```
### Options
```
-h, --help help for minecraft
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz migrate](packwiz_migrate.md) - Migrate your Minecraft and loader versions to newer versions.

View file

@ -0,0 +1,27 @@
## packwiz modrinth
Manage modrinth-based mods
### Options
```
-h, --help help for modrinth
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz modrinth add](packwiz_modrinth_add.md) - Add a project from a Modrinth URL, slug/project ID or search
* [packwiz modrinth export](packwiz_modrinth_export.md) - Export the current modpack into a .mrpack for Modrinth

View file

@ -0,0 +1,32 @@
## packwiz modrinth add
Add a project from a Modrinth URL, slug/project ID or search
```
packwiz modrinth add [URL|slug|search] [flags]
```
### Options
```
-h, --help help for add
--project-id string The Modrinth project ID to use
--version-filename string The Modrinth version filename to use
--version-id string The Modrinth version ID to use
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz modrinth](packwiz_modrinth.md) - Manage modrinth-based mods

View file

@ -0,0 +1,31 @@
## packwiz modrinth export
Export the current modpack into a .mrpack for Modrinth
```
packwiz modrinth export [flags]
```
### Options
```
-h, --help help for export
-o, --output string The file to export the modpack to
--restrictDomains Restricts domains to those allowed by modrinth.com (default true)
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz modrinth](packwiz_modrinth.md) - Manage modrinth-based mods

View file

@ -0,0 +1,29 @@
## packwiz pin
Pin a file so it does not get updated automatically
```
packwiz pin [flags]
```
### Options
```
-h, --help help for pin
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,30 @@
## packwiz refresh
Refresh the index file
```
packwiz refresh [flags]
```
### Options
```
--build Only has an effect in no-internal-hashes mode: generates internal hashes for distribution with packwiz-installer
-h, --help help for refresh
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,29 @@
## packwiz remove
Remove an external file from the modpack; equivalent to manually removing the file and running packwiz refresh
```
packwiz remove [flags]
```
### Options
```
-h, --help help for remove
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,36 @@
## packwiz serve
Run a local development server
### Synopsis
Run a local HTTP server for development, automatically refreshing the index when it is queried
```
packwiz serve [flags]
```
### Options
```
--basic Disable refreshing and allow all files in the directory, rather than just files listed in the index
-h, --help help for serve
-p, --port int The port to run the server on (default 8080)
-r, --refresh Automatically refresh the index file (default true)
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,26 @@
## packwiz settings
Manage pack settings
### Options
```
-h, --help help for settings
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz settings acceptable-versions](packwiz_settings_acceptable-versions.md) - Manage your pack's acceptable Minecraft versions. This must be a comma seperated list of Minecraft versions, e.g. 1.16.3,1.16.4,1.16.5

View file

@ -0,0 +1,31 @@
## packwiz settings acceptable-versions
Manage your pack's acceptable Minecraft versions. This must be a comma seperated list of Minecraft versions, e.g. 1.16.3,1.16.4,1.16.5
```
packwiz settings acceptable-versions [flags]
```
### Options
```
-a, --add Add a version to the list
-h, --help help for acceptable-versions
-r, --remove Remove a version from the list
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz settings](packwiz_settings.md) - Manage pack settings

View file

@ -0,0 +1,29 @@
## packwiz unpin
Unpin a file so it receives updates
```
packwiz unpin [flags]
```
### Options
```
-h, --help help for unpin
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,30 @@
## packwiz update
Update an external file (or all external files) in the modpack
```
packwiz update [name] [flags]
```
### Options
```
-a, --all Update all external files
-h, --help help for update
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks

View file

@ -0,0 +1,26 @@
## packwiz url
Add external files from a direct download link, for sites that are not directly supported by packwiz
### Options
```
-h, --help help for url
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz url add](packwiz_url_add.md) - Add an external file from a direct download link, for sites that are not directly supported by packwiz

View file

@ -0,0 +1,31 @@
## packwiz url add
Add an external file from a direct download link, for sites that are not directly supported by packwiz
```
packwiz url add [name] [url] [flags]
```
### Options
```
--force Add a file even if the download URL is supported by packwiz in an alternative command (which may support dependencies and updates)
-h, --help help for add
--meta-name string Filename to use for the created metadata file (defaults to a name generated from the name you supply)
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz url](packwiz_url.md) - Add external files from a direct download link, for sites that are not directly supported by packwiz

View file

@ -0,0 +1,26 @@
## packwiz utils
Utilities for managing packwiz itself
### Options
```
-h, --help help for utils
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz](packwiz.md) - A command line tool for creating Minecraft modpacks
* [packwiz utils markdown](packwiz_utils_markdown.md) - Generate markdown documentation (that you might be reading right now!!)

View file

@ -0,0 +1,30 @@
## packwiz utils markdown
Generate markdown documentation (that you might be reading right now!!)
```
packwiz utils markdown [flags]
```
### Options
```
--dir string The destination directory to save docs in (default ".")
-h, --help help for markdown
```
### Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")
--config string The config file to use (default "/home/seasw/.config/packwiz/.packwiz.toml")
--meta-folder string The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
--pack-file string The modpack metadata file to use (default "pack.toml")
-y, --yes Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```
### SEE ALSO
* [packwiz utils](packwiz_utils.md) - Utilities for managing packwiz itself

View file

@ -23,6 +23,39 @@ nav:
- Post-Install Tips and Tricks: installing-the-modpack/servers/post-install-tips-and-tricks.md
- Modifying Optional Content: modifying-optional-content.md
- Common Issues: common-issues.md
- Development:
- packwiz.md
- packwiz_completion.md:
- packwiz_completion_bash.md
- packwiz_completion_fish.md
- packwiz_completion_powershell.md
- packwiz_completion_zsh.md
- packwiz_curseforge.md:
- packwiz_curseforge_add.md
- packwiz_curseforge_detect.md
- packwiz_curseforge_export.md
- packwiz_curseforge_import.md
- packwiz_curseforge_open.md
- packwiz_init.md
- packwiz_list.md
- packwiz_migrate.md:
- packwiz_migrate_loader.md
- packwiz_migrate_minecraft.md
- packwiz_modrinth.md:
- packwiz_modrinth_add.md
- packwiz_modrinth_export.md
- packwiz_pin.md
- packwiz_refresh.md
- packwiz_remove.md
- packwiz_serve.md
- packwiz_settings.md:
- packwiz_settings_acceptable-versions.md
- packwiz_unpin.md
- packwiz_update.md
- packwiz_url.md:
- packwiz_url_add.md
- packwiz_utils.md:
- packwiz_utils_markdown.md
plugins:
- git-authors