From aaf054130989c269af52394251df1a0ca6415373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 00:57:08 +0200 Subject: docs: change configuration page --- Writerside/topics/resource-pack.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 Writerside/topics/resource-pack.md (limited to 'Writerside/topics/resource-pack.md') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md new file mode 100644 index 0000000..48076f3 --- /dev/null +++ b/Writerside/topics/resource-pack.md @@ -0,0 +1,3 @@ +# Making a cutom resource pack + +🚧 WIP 🚧 \ No newline at end of file -- cgit v1.2.3 From eb78e7e772db656d703519cb2fa25a5a8f2cef82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 22:38:34 +0200 Subject: docs: add resource pack page --- Writerside/topics/resource-pack.md | 166 ++++++++++++++++++++++++++++++++++++- 1 file changed, 165 insertions(+), 1 deletion(-) (limited to 'Writerside/topics/resource-pack.md') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index 48076f3..6ae8915 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -1,3 +1,167 @@ # Making a cutom resource pack -🚧 WIP 🚧 \ No newline at end of file +If you want to customize visual elements of the mod, you can create +your own custom resource pack. + +Doing so will enable you to change or translate every text line used by +the mod, and also change to default skin that is applied to all players +(if the [gamerule `showSkins`](gamerules.md#client-side-settings) is set to true). + +> After creating your resource pack, you can either force its use by setting it as +> the server's resource pack, or make it optional (it's purely visuals anyway!) +{style=tip} + + +## First steps + +First, create a folder with your resource pack name (it can be whatever you want!). Then, +inside of this folder, create a file named `pack.mcmeta`. This file is very important : it tells +the game that it is indeed a resource pack. + +Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following : +```json +{ + "pack": { + "description": "An awesome description for an awesome resource pack", + "pack_format": 34 + } +} +``` + +> Note that the `pack_format` used here (34) corresponds to minecraft version 1.21.x. If you +> are making the resource pack for another version, you can check which pack format to use +> [on the wiki](https://minecraft.wiki/w/Pack_format). +{style=note} + +You can now close the `pack.mcmeta` file. Now, inside your resource pack's main folder, +create a folder named `assets`, and inside it make another folder name `molehunt`. + +You file tree you look like that : +``` +πŸ“ MyAwesomeResourcePack +β”œβ”€β”€ πŸ“„ pack.mcmeta +└── πŸ“ assets + └── πŸ“ molehunt +``` + +> If you want, you can also add an icon to your resource pack : just add a png file named +> `pack.png` in your resource pack's main folder. +{style=tip} + + +## Adding a custom skin + +To add a custom skin, first you need to make one. You can either use +your own skin, or make a new one using a minecraft skin editor (there are +a lot online). + +Then grab your skin file (make sure it's a `.png` file!), name it `skin.png` +and put it inside a `textures` folder, inside the `molehunt` folder. It should +look like that : +``` +... +πŸ“ assets +└── πŸ“ molehunt + └── πŸ“ textures + └── πŸ“„ skin.png +``` + +Now everyone in the game will be wearing your custom skin! + + +## Changing the mod's text + +Finally, if the mod's text doesn't suit you, or if you want to translate +it to another language, you can! + +> Note that french is already supported by default, so no need to translate +> to it. +{style=tip} + +First, create a new folder in the `molehunt` folder named `lang`, then create +a `en_us.json` file. + +> If you want to target another language, name the file according to your language +> and region. For example : `fr_fr.json` for French in France. +{style=note} + +Now copy the content of the [default `en_us.json` file](#default-en-us-json-language-file) +in you language file, and start editing the lines you want to change! + +Finally, your file structure should look like that : +``` +... +πŸ“ assets +└── πŸ“ molehunt + └── πŸ“ lang + └── πŸ“„ en_us.json + └── πŸ“„ en_pt.json + └── etc. +``` +(You can have only one, or multiple language files, it doesn't matter) + +[Minecraft formatting codes](https://minecraft.wiki/w/Formatting_codes) are +supported in `titles` and `subtitles`. + + +## Final file tree, and installing your resource pack + +If you followed every step of this tutorial, the final resource apck should look like this : +``` +πŸ“ MyAwesomeResourcePack +β”œβ”€β”€ πŸ“„ pack.mcmeta +β”œβ”€β”€ πŸ“„ pack.png (optional) +└── πŸ“ assets + └── πŸ“ molehunt + β”œβ”€β”€ πŸ“ textures + β”‚ └── πŸ“„ skin.png + └── πŸ“ lang + └── πŸ“„ en_us.json + └── πŸ“„ en_pt.json + └── etc. +``` + +To install it on your client, simply put your awesome resource pack in the `resourcepacks` folder +of [your `.minecraft` folder](https://minecraft.wiki/w/.minecraft). + +If you want, you can zip it to make sharing it easier, but it is not required. + + +## Default `en_us.json` language file + +Here's the default `en_us.json` file. You can use it as a template to +customize the mod's text lines. + +> The weird `Β§` and the character after it corresponds to a minecraft +> formatting code. It can change the text's color and format. You can +> learn more [on the wiki](https://minecraft.wiki/w/Formatting_codes). +{style=tip} + +```json +{ + "commands.molehunt.stop.failed": "The Molehunt game has not been started yet.", + "commands.molehunt.timer.show": "Showing Molehunt timer.", + "commands.molehunt.timer.hide": "Hiding Molehunt timer.", + "commands.molehunt.moles.list": "List of moles:", + "commands.molehunt.moles.list.deny": "You can't see the list of moles.", + "commands.molehunt.stop.success": "The Molehunt game has been stopped.", + "molehunt.game.end.suspense.title": "Β§eAnd the winners are...", + "molehunt.game.end.winners.moles.title": "Β§cThe Moles!", + "molehunt.game.end.winners.survivors.title": "Β§aNot the Moles!", + "molehunt.game.end.winners.subtitle": "Β§6The Moles were", + "molehunt.game.start.suspense": "Β§eYou are...", + "molehunt.game.start.mole.title": "Β§cThe Mole!", + "molehunt.game.start.mole.subtitle": "Β§eGet the list of moles with Β§6/molehunt moles", + "molehunt.game.start.survivor.title": "Β§aNot the Mole!", + "molehunt.game.start.survivor.subtitle": "Β§eTry to survive and find out who's the mole!", + "gamerule.molehunt:gameDuration": "Molehunt: Duration of a game", + "gamerule.molehunt:molePercentage": "Molehunt: Percentage of Mole", + "gamerule.molehunt:moleCount": "Molehunt: Number of Mole", + "gamerule.molehunt:showNametags": "Molehunt: Show players' nametag", + "gamerule.molehunt:showTab": "Molehunt: Enable the tab", + "gamerule.molehunt:showSkins": "Molehunt: Show players' skin", + "gamerule.molehunt:initialWorldSize": "Molehunt: Initial world size", + "gamerule.molehunt:finalWorldSize": "Molehunt: Final world size", + "gamerule.molehunt:borderMovingStartingTimeOffsetMinutes": "Molehunt: Time before moving the borders" +} +``` -- cgit v1.2.3 From 0c9c50f1aa14053bc22dd4032cb9b1e87aeac1e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Mon, 26 Aug 2024 13:52:06 +0200 Subject: docs: remove spaces before colons --- Writerside/topics/resource-pack.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'Writerside/topics/resource-pack.md') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index 6ae8915..b71e44f 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -15,10 +15,10 @@ the mod, and also change to default skin that is applied to all players ## First steps First, create a folder with your resource pack name (it can be whatever you want!). Then, -inside of this folder, create a file named `pack.mcmeta`. This file is very important : it tells +inside of this folder, create a file named `pack.mcmeta`. This file is very important: it tells the game that it is indeed a resource pack. -Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following : +Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following: ```json { "pack": { @@ -36,7 +36,7 @@ Now, edit the `pack.mcmeta` file with your favorite text editor, and write the f You can now close the `pack.mcmeta` file. Now, inside your resource pack's main folder, create a folder named `assets`, and inside it make another folder name `molehunt`. -You file tree you look like that : +You file tree you look like that: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta @@ -44,7 +44,7 @@ You file tree you look like that : └── πŸ“ molehunt ``` -> If you want, you can also add an icon to your resource pack : just add a png file named +> If you want, you can also add an icon to your resource pack: just add a png file named > `pack.png` in your resource pack's main folder. {style=tip} @@ -57,7 +57,7 @@ a lot online). Then grab your skin file (make sure it's a `.png` file!), name it `skin.png` and put it inside a `textures` folder, inside the `molehunt` folder. It should -look like that : +look like that: ``` ... πŸ“ assets @@ -82,13 +82,13 @@ First, create a new folder in the `molehunt` folder named `lang`, then create a `en_us.json` file. > If you want to target another language, name the file according to your language -> and region. For example : `fr_fr.json` for French in France. +> and region. For example: `fr_fr.json` for French in France. {style=note} Now copy the content of the [default `en_us.json` file](#default-en-us-json-language-file) in you language file, and start editing the lines you want to change! -Finally, your file structure should look like that : +Finally, your file structure should look like that: ``` ... πŸ“ assets @@ -106,7 +106,7 @@ supported in `titles` and `subtitles`. ## Final file tree, and installing your resource pack -If you followed every step of this tutorial, the final resource apck should look like this : +If you followed every step of this tutorial, the final resource apck should look like this: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta -- cgit v1.2.3 From 7c844612883be1d9b04ed91726062364635eb73d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Mon, 26 Aug 2024 13:52:36 +0200 Subject: docs: typo --- Writerside/topics/resource-pack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Writerside/topics/resource-pack.md') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index b71e44f..c2fd871 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -106,7 +106,7 @@ supported in `titles` and `subtitles`. ## Final file tree, and installing your resource pack -If you followed every step of this tutorial, the final resource apck should look like this: +If you followed every step of this tutorial, the final resource pack should look like this: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta -- cgit v1.2.3