0
0
mirror of https://github.com/Pumpkin-MC/Pumpkin-Website.git synced 2025-02-07 00:19:51 +00:00
Pumpkin-Website/docs/config/resource-pack.md
Alexander Medvedev 530524b739 init
2024-12-22 19:45:25 +01:00

2.2 KiB

Resource Pack

Servers can send resource packs to the client in order to change the appearance of the game on the client. Pumpkin allows you to fully configure the resource pack.

Tip

Minify your resource pack using PackSquash! This can help clients download the resource pack faster.

Configuring Resource Pack

enabled: Boolean

Whether a resource pack is enabled or not.

:::code-group

[resource_pack]
enabled = true

:::

resource_pack_url: String

The direct download URL to the resource pack.

Tip

You can host the resource pack for free at MCPacks.

:::code-group

[resource_pack]
enabled = true
resource_pack_url = "[your download URL here]"

:::

resource_pack_sha1: String

The hash of the resource pack, using the SHA1 algorithm.

Important

Although not required to specify, you should specify this field because the client will otherwise redownload the resource pack every time they join the server, even if there are no changes to the resource pack.

Warning

Make sure to update this field if the resource pack is modified.

::: details How do I get the SHA1 hash of my resource pack? ::: code-group

Get-FileHash [file] SHA1
shasum -a 1 [file]
sha1sum [file]

:::

:::code-group

[resource_pack]
enabled = true
resource_pack_sha1 = "[your hash here]"

:::

prompt_message: String

The message to show to the user when prompted to download the resource pack.

:::code-group

[resource_pack]
enabled = true
prompt_message = "[your message here]"

:::

force: Boolean

Whether to force the client to download the resource pack or not. If the client declines the download, they will be kicked from the server.

:::code-group

[resource_pack]
enabled = true
force = false

:::

Default Config

By default, resource pack is disabled.

:::code-group

[resource_pack]
enabled = false
resource_pack_url = ""
resource_pack_sha1 = ""
prompt_message = ""
force = false

:::