PackWiz-ard - Configuration

All of the configuration files for PackWiz-ard are located in the <game_directory>/config/packwiz_ard/ directory.

Configuration files:

common.toml: The common configuration file for PackWiz-ard, which contains settings that apply to both the server and client.
server.toml: The server configuration file for PackWiz-ard, which contains settings that apply only to the server.
client.toml: The client configuration file for PackWiz-ard, which contains settings that apply only to the client.

Common Configuration

#Common config
[common]
    updater = "PACKWIZ"
  pack_toml = ""
  lastSeenPackTomlHash = ""

updater

The updater to use for PackWiz-ard.

Type: Enum
Allowed Values:
- PACKWIZ
- PACKWEAVE
Default: PACKWIZ

pack_toml

The URL to the pack.toml file for this pack. This is used to check for updates and download the pack.toml file. If this is not set, the mod will not be able to check for updates or download the pack.toml file.

Default: "" (empty string)

lastSeenPackTomlHash

The last seen hash of the pack.toml file. This is used to detect whether the server or client pack has changed.

Default: "" (empty string)

Server Configuration

#Server Configuration
[server]
  minimumPermissionLevel = 4
  autoUpdate = false
  autoUpdateInterval = 1440

  #Discord Webhooks Configuration
  [server.discordWebhooks]
    enabled = false
    webhookUrl = "DISCORD_WEBHOOK_URL_HERE"
    discordAuthorName = "PackWiz ARD"
    discordAuthorIconUrl = "https://raw.githubusercontent.com/Matthiesen-dev/.github/refs/heads/main/mod-logos/packwiz-ard.png"

    #Webhook messages for various server events
    [server.discordWebhooks.webhookMessages]
      bootstrapDownloadTriggered_title = "Bootstrap Download Triggered!"
      bootstrapDownloadTriggered_description = "A new bootstrap download has been triggered, and the download process has started!"
      bootstrapDownloadTriggered_color = "GOLD"
      bootstrapDownloadFinished_title = "Bootstrap Download Finished!"
      bootstrapDownloadFinished_description = "The bootstrap download process has finished successfully! The update process will now continue."
      bootstrapDownloadFinished_color = "GREEN"
      bootstrapDownloadFailed_title = "Bootstrap Download Failed!"
      bootstrapDownloadFailed_description = "The bootstrap download process has failed! Please check the logs for more information."
      bootstrapDownloadFailed_color = "RED"
      packUpdateTriggered_title = "Modpack Update Triggered!"
      packUpdateTriggered_description = "A new modpack update has been triggered, and the update process has started!"
      packUpdateTriggered_color = "GOLD"
      packUpdateFinished_title = "Modpack Update Finished!"
      packUpdateFinished_description = "The modpack update process has finished successfully! Server restart pending to apply update"
      packUpdateFinished_color = "GREEN"
      packUpdateFailed_title = "Modpack Update Failed!"
      packUpdateFailed_description = "The modpack update process has failed! Please check the logs for more information."
      packUpdateFailed_color = "RED"
      packTomlLinkUpdated_title = "Pack.toml Link Updated!"
      packTomlLinkUpdated_description = "The pack.toml link has been updated! The new link is: %newLink%"
      packTomlLinkUpdated_color = "GOLD"
      minimumPermissionLevelUpdated_title = "Minimum Permission Level Updated!"
      minimumPermissionLevelUpdated_description = "The minimum permission level has been updated! The new level is: %newLevel%"
      minimumPermissionLevelUpdated_color = "GOLD"
      autoUpdateUpdated_title = "Auto Update Updated!"
      autoUpdateUpdated_description = "The auto update setting has been updated! The new setting is: %newSetting%"
      autoUpdateUpdated_color = "GOLD"
      autoUpdateIntervalUpdated_title = "Auto Update Interval Updated!"
      autoUpdateIntervalUpdated_description = "The auto update interval has been updated! The new interval is: %newInterval% minutes"
      autoUpdateIntervalUpdated_color = "GOLD"

minimumPermissionLevel

The minimum permission level required to use the mod’s commands. This can be set to any value between 0 and 4, where 0 is the lowest permission level and 4 is the highest.

Type: Integer
Default: 4

autoUpdate

Whether to enable or disable automatic updates for the modpack. If enabled, the mod will check for updates at the interval specified by autoUpdateInterval.

Type: Boolean
Default: false

autoUpdateInterval

The interval in minutes for automatic updates. This determines how often the mod will check for updates to the modpack.

Type: Integer
Default: 1440 (24 hours)

Discord Webhooks Configuration

Discord webhooks can be configured to send notifications for various server events, such as when a modpack update is triggered or completed. The webhook settings can be found under the [server.discordWebhooks] section in the server.toml file.

enabled

Whether to enable or disable Discord webhooks for server events.

Type: Boolean
Default: false

webhookUrl

The Discord Webhook URL to send server event notifications to.

Type: String
Default: "DISCORD_WEBHOOK_URL_HERE"

discordAuthorName

The name to display as the author of the Discord webhook messages.

Type: String
Default: "PackWiz ARD"

discordAuthorIconUrl

The URL of the icon to display as the author of the Discord webhook messages.

Type: String
Default: "https://raw.githubusercontent.com/Matthiesen-dev/.github/refs/heads/main/mod-logos/packwiz-ard.png"

webhookMessages

The webhook messages for various server events can be customized under the [server.discordWebhooks.webhookMessages] section in the server.toml file. Each event has a title, description, and embed color that can be set to your preference.

Title:

Type: String Description:
Type: String Embed Color:
Type: Enum
Allowed Values:
- RED
- GREEN
- BLUE
- PURPLE
- ORANGE
- GOLD
- GREY
- DARK_RED
- DARK_GREEN
- DARK_BLUE
- BLACK
- WHITE

bootstrapDownloadTriggered

Title: bootstrapDownloadTriggered_title
Description: bootstrapDownloadTriggered_description
Embed Color: bootstrapDownloadTriggered_color

bootstrapDownloadFinished

Title: bootstrapDownloadFinished_title
Description: bootstrapDownloadFinished_description
Embed Color: bootstrapDownloadFinished_color

bootstrapDownloadFailed

Title: bootstrapDownloadFailed_title
Description: bootstrapDownloadFailed_description
Embed Color: bootstrapDownloadFailed_color

packUpdateTriggered

Title: packUpdateTriggered_title
Description: packUpdateTriggered_description
Embed Color: packUpdateTriggered_color

packUpdateFinished

Title: packUpdateFinished_title
Description: packUpdateFinished_description
Embed Color: packUpdateFinished_color

packUpdateFailed

Title: packUpdateFailed_title
Description: packUpdateFailed_description
Embed Color: packUpdateFailed_color

packTomlLinkUpdated

Title: packTomlLinkUpdated_title
Description: packTomlLinkUpdated_description
Embed Color: packTomlLinkUpdated_color

minimumPermissionLevelUpdated

Title: minimumPermissionLevelUpdated_title
Description: minimumPermissionLevelUpdated_description
Embed Color: minimumPermissionLevelUpdated_color

autoUpdateUpdated

Title: autoUpdateUpdated_title
Description: autoUpdateUpdated_description
Embed Color: autoUpdateUpdated_color

autoUpdateIntervalUpdated

Title: autoUpdateIntervalUpdated_title
Description: autoUpdateIntervalUpdated_description
Embed Color: autoUpdateIntervalUpdated_color

Client Configuration

#Client Configuration
[client]
  auto_refresh_enabled = true
  auto_refresh_interval_seconds = 60

auto_refresh_enabled

Whether the client should periodically re-check the pack.toml status while the client update screen is open. Set this to false if you prefer manual refresh only.

Type: Boolean
Default: true

auto_refresh_interval_seconds

How often the client should re-check the pack.toml status while the update screen is open. This value is only used when auto_refresh_enabled is true.

Type: Integer
Default: 60 (seconds)
Range: 5 ~ 3600 (seconds)