About
<p style="text-align: center;"><center><a href="https://serilum.com/"><img src="https://github.com/Serilum/.cdn/raw/main/description/header/header.png" alt="" width="838" height="400" /></a></p><p style="text-align: center;"><a href="https://curseforge.com/members/serilum/projects" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Serilum/.data-workflow/main/badges/svg/curseforge.svg" width="200" /></a> <a href="https://modrinth.com/user/Serilum" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Serilum/.data-workflow/main/badges/svg/modrinth.svg" width="200" /></a> <a href="https://patreon.com/serilum" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Serilum/.data-workflow/main/badges/svg/patreon.svg" width="200" /></a> <a href="https://youtube.com/@serilum" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Serilum/.data-workflow/main/badges/svg/youtube.svg" width="200" /></a></center></p><p><strong><span style="font-size: 24px;">Requires the library mod <a style="font-size:24px" href="https://modrinth.com/mod/collective" target="_blank" rel="nofollow">Collective</a>.</span></strong><br><br><strong> This mod is part of <span style="color:#008000"><a style="color:#008000" href="https://modrinth.com/modpack/the-vanilla-experience" target="_blank" rel="nofollow">The Vanilla Experience</a></span> modpack and <span style="color:#666"><a style="color:#666" href="https://modrinth.com/mod/serilums-customization-bundle" target="_blank" rel="nofollow">Serilum's Customization Bundle</a></span> mod.</strong><br><span style="font-size:18px">Starter Kit is a mod which allows players who join a world for the first time to receive items set in a config file. It's possible to set items to any specific slot in the inventory, to the offhand and to the armour slots. The mod can detect which players have never joined before. If another mod adds items, such as guide books, they can either be removed completely or added after the kit has been set. This is configurable via the <em>addExistingItemsAfterKitSet</em> config option.<br><br>Can be used in a server for all new players or in singleplayer to start off with a default inventory of your choosing. There is also optional support for FTB's Team Island mod after the create island command.<br><br>The mod can be used <strong>server-side only</strong>. If you want players to be able to use the "Choose Kit GUI", it has to be installed on the client as well. Alternatively, they can choose kits via server commands.<br><br><span style="font-size:24px"><strong>Features:</strong></span><br> • A guide here in the description. Difficulty ranging from <strong>Simple</strong>, <strong>Intermediate</strong> and <strong>Advanced</strong>.<br> • Give players joining the world for the first time custom starter items and/or potion effects.<br> • Support for multiple kits. Can be given randomly or chosen by the player.<br> • There is custom tracking to determine who are new players, compatible with existing worlds.<br> • Lots of commands! For creating, adding, managing and choosing starter kits.<br> • If installed on the client, kits can be chosen via a custom GUI screen. If not, commands can be used.<br> • Add descriptions to your kits. RPG modpack, anyone?<br> • Remove other modded starter items, such as guide books. Or add them after the starter kit.<br><br></span></p>
<p><strong><span style="font-size:24px">Configurable:</span> <span style="color:#008000;font-size:14px"><a style="color:#008000" href="https://github.com/Serilum/.information/wiki/how-to-configure-mods" rel="nofollow">( how do I configure? )</a></span><br></strong><span style="font-size:12px"><strong>randomizeMultipleKitsToggle</strong> (default = true): When multiple starter kits are added via /starterkit add, there are two ways to distribute them. With this enabled, one is chosen at random. When disabled, players can choose one on first join.<br><strong>addExistingItemsAfterKitSet</strong> (default = true): Whether items that existed in the inventory, such as books added by other mods, should be added back to the inventory after the kit was set. If disabled, they'll be removed. You can still manually set them via the kit.<br><strong>usePotionEffectsInStarterKit</strong> (default = true): If potion/mob effect functionality should be enabled. This means that when creating a kit via /sk (add/set), it also saves the active effects the player has. And when handing out the starter kits, it adds the effects to new players.<br><strong>formatKitNames</strong> (default = true): If kit names should be formatted. Each word will be capitalized.<br><br><strong>chooseKitScreenHeader</strong> (default = "%s, you can choose a starter kit!"): The text used above the kit choice screen, or if the mod is not installed in the chat. %s will be replaced with the player's name.<br><br><strong>announcePlayerKitChoiceInDedicatedServer</strong> (default = true): Whether an announcement should be broadcasted to the server whenever a new player makes a kit choice. 'randomizeMultipleKitsToggle' must be disabled, and there must be at least 2 starter kits available.<br><strong>enableFTBIslandCreateCompatibility</strong> (default = true): Whether the starter kit should be re-set after the '/ftbteamislands create' command from FTB Team Islands. Does nothing when it's not installed.<br></span></p>
<p><br><span style="font-size:24px"><strong>Commands:</strong></span><span style="font-size:14px"><em><br>Both '/starterkit' and '/sk' can be used.</em><strong><br><br><span style="text-decoration:underline">Admin Commands:</span></strong></span><br><span style="font-size:14px">/sk add (kit_name)</span> - <em>Adds your current inventory to the active kits.</em><br><span style="font-size:14px">/sk set (kit_name)</span> - <em>Sets your current inventory as the only active kit.</em></p>
<p><span style="font-size:14px">/sk give <player> (kit_name)</span> - <em>Give a player a random (or specific) starter kit.</em></p>
<p><span style="font-size:14px">/sk activate <kit_name>/_all</span> - <em>Moves kit_name or all kits from inactive to active.</em><br><span style="font-size:14px">/sk deactivate <kit_name>/_all</span> - <em>Moves kit_name or all kits from active to inactive.</em></p>
<p><span style="font-size:14px">/sk list (inactive)</span> - <em>Lists all active (or inactive) kits.</em><br><span style="font-size:14px">/sk reset</span> - <em>Resets all tracking. Players receive another kit on join.</em><br><span style="font-size:14px">/sk reload</span> - <em>Reloads starter kit changes from the config folder.</em><br><br></p>
<p><span style="text-decoration:underline;font-size:14px"><strong>User Commands:</strong></span><br><span style="font-size:14px">/sk choose <kit_name></span> - <em>Allows players to choose a starter kit via commands. This is only needed when Starter Kit is not installed on the client and the server enabled kit choices.</em><br><span style="font-size:14px">/sk info <kit_name></span> - <em>Shows the description and items of kit_name.<br></em><span style="font-size:14px">/sk help</span> -<em> Shows the Starter Kit commands in-game.<br></em></p>
<p><br><br><span style="font-size:36px"><strong>Usage Guide:</strong></span><br><span style="font-size:14px">The mod can be configured in many different ways. To keep a better overview, I've divided the difficulty into three different sections. <strong>Simple</strong>, <strong>Intermediate</strong> and <strong>Advanced</strong>.<br></span><br><span style="font-size:18px"><strong>Simple:</strong></span><br><span style="font-size:14px">Set a custom starter kit. Add/Remove starter items from other mods. And giving players a starter kit via commands.</span><br><br><span style="font-size:18px"><strong>Intermediate:</strong></span><br><span style="font-size:14px">Add an extra starter kit. Deactivate a kit via commands. Add a starter kit with potion effects, and setting the level and duration.</span><br><br><span style="font-size:18px"><strong>Advanced:</strong></span><br><span style="font-size:14px">Make players choose a kit on first join. Move the inactive default kits to active. Show the choose kit GUI screen. Create a starter kit with a custom description.</span><br><br><br><span style="font-size:36px"><strong>Section 1: <span style="font-size:36px">Simple</span></strong></span><br><span style="font-size:14px">This is the default starter kit, which will be given when the mod is installed without any configuration:</span><br><img src="https://github.com/Serilum/.cdn/raw/main/projects/starter-kit/0.png"><br><br><span style="font-size:14px">You can set your own starter kit by using the '<em><strong>/starterkit set (kit_name)</strong></em>' (or '<em><strong>/sk set (kit_name)</strong></em>') command. The kit name is optional.</span><br><span style="font-size:14px">After using this command, all other active starter kits are moved to the inactive folder.</span><br><img src="https://github.com/Serilum/.cdn/raw/main/projects/starter-kit/1.png"><br><br><span style="font-size:14px">Here you can see the new starter kit data file that was created with the previous command. It's located in '<em><strong>./config/starterkit/kits/</strong></em>':</span><br><img src="https://github.com/Serilum/.cdn/raw/main/projects/starter-kit/2.png"><br><br><span style="font-size:14px">That's it! All new players will now receive the "<strong>Upgraded</strong>" kit when they first join the world:</span><br><img src="https://github.com/Serilum/.cdn/raw/main/projects/starter-kit/3.png"><br><br><span style="font-size:14px">Inside the config file, located at '<em><strong>./config/starterkit.json5</strong></em>', you can ch