From 7873a882a847ccfd53f40fc67e1ce73423a0b1a2 Mon Sep 17 00:00:00 2001 From: Map Date: Mon, 7 Oct 2024 02:50:02 -0500 Subject: [PATCH] Add note about icon in mod README --- game/mods/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game/mods/README.md b/game/mods/README.md index 1808721..834dc44 100644 --- a/game/mods/README.md +++ b/game/mods/README.md @@ -66,7 +66,7 @@ Below is all the possible entries you can put in, and explanations for what they In the same directory as your metadata file, there's image files you can put in the to make your mod more appealing. These can be any of Ren'Py's supported image file types, so the file extension here is just for demonstration: -'thumbnail.png' will appear as a banner for your mod, at the top of the mod details pane - -'icon.png' will show a small image next your mod name or take up the entire button depending on what your "Display" entry is set to. + -'icon.png' will show a small image next your mod name or take up the entire button depending on what your "Display" entry is set to. NOTE: Putting in an image too big in dimensions will crash the game. -'screenshot(number).png' will show screenshots at the bottom of the mod details pane. The '(number)' is a placeholder for a number that represents what order your screenshots appear in. For example, you can have 'screenshot1.png', 'screenshot2.png', and 'screenshot3.png' in your mod directory, and they will all appear in the mod details pane in order. These numbers don't need to be strictly sequential, they can be any number as long as they are integers, and the order will be derived from ASCII ordering. As the game loads the metadata, it will also collect scripts for loading. When you make your mod scripts, ALL OF THEM NEED TO HAVE .rpym EXTENSIONS. This is important for being able to control mods with the mod loader, otherwise there would be mod conflicts galore. If you use .rpy extensions to make your mod scripts, they will work, but they will not be manageable by the mod loader. This means you should only use them for development, or if you're not using the mod loader anyway - such as adding a translation to the base game.