Starter Kit
Mod Configuration
The mod offers numerous parameters for fine-tuning starter kit behavior:
randomizeMultipleKitsToggle (default = true): With multiple kits available, you can either randomly select one or allow players to choose themselves upon first joining the world.
addExistingItemsAfterKitSet (default = true): Determines whether items added by other mods (such as guide books) should be returned to the inventory after the starter kit is given.
usePotionEffectsInStarterKit (default = true): Enables potion effect functionality. When creating a kit, the player's active effects are saved and then applied to new players.
formatKitNames (default = true): Automatically formats kit names by capitalizing each word.
chooseKitScreenHeader (default = "%s, you can choose a starter kit!"): Text displayed above the kit selection screen. %s is replaced with the player's name.
announcePlayerKitChoiceInDedicatedServer (default = true): Notifies the server when a new player chooses a kit. Requires disabling random selection and having at least 2 kits available.
enableFTBIslandCreateCompatibility (default = true): Provides compatibility with the '/ftbteamislands create' command from the FTB Team Islands mod.
Commands
Two command forms are available: '/starterkit' and '/sk'.
Admin Commands:
- /sk add (kit_name) - Adds current inventory to active kits
- /sk set (kit_name) - Sets current inventory as the only active kit
- /sk give
(kit_name) - Gives a player a random or specific kit - /sk activate
/_all - Activates specified kit or all kits - /sk deactivate
/_all - Deactivates specified kit or all kits - /sk list (inactive) - Shows list of active (or inactive) kits
- /sk reset - Resets all tracking, players receive kits again upon joining
- /sk reload - Reloads changes from configuration folder
Player Commands:
- /sk choose
- Allows selecting a starter kit via commands - /sk info
- Shows description and items in the kit - /sk help - Displays mod command list in-game
Usage Guide
Simple Level
By default, the mod provides a basic starter kit:
To create your own kit, use the '/starterkit set (kit_name)' command. After executing this command, all other active kits are moved to the inactive folder.
The new kit data file is created in the './config/starterkit/kits/' folder:
Now all new players will receive the upgraded kit when first joining the world:
In the configuration file './config/starterkit.json5', you can configure whether to remove or add items from other mods after giving the kit:
To manually give kits to other players, use the '/starterkit give
Intermediate Level
Add additional active kits using the '/starterkit add (kit_name)' command. With default settings, new players will randomly receive one of the available kits.
View active kits with '/starterkit list', inactive kits with '/starterkit list inactive':
Deactivate a kit with '/starterkit deactivate
The mod supports giving potion effects along with starter kits. Ensure the 'usePotionEffectsInStarterKit' parameter is enabled in configuration, then activate the desired effect and use the kit creation command.
The created kit file is located at './config/starterkit/kits/Speed_Kit.txt':
The file contains the list of items and effects players will receive. In this example, it shows Speed effect level 1 with duration of 3341 ticks (167 seconds, where 20 ticks = 1 second):
You can modify effect parameters, for example setting Speed level 5 with 5-minute duration (6000 ticks = 300 seconds):
Apply configuration file changes with the '/starterkit reload' command:
Now players will receive the "Speed Kit" with items and Speed V effect lasting 5 minutes upon first joining:
Show Animation
Advanced Level
Starter Kit includes a special kit selection screen. Here's an example with the "Default" kit:
To activate this feature, disable the "Randomize Multiple Kits Toggle" parameter in './config/starterkit.json5' or via the in-game configuration editor:
Standard kits are located in the './config/starterkit/kits/inactive/' folder. Activate them all with '/starterkit activate _all':
Check active kits with '/starterkit list':
Now when creating a new world, the kit selection screen will appear:
Show Animation
Create your own kit with description. Start with the desired inventory and use the '/starterkit add' command, for example naming the kit "Pumpkin":
Kit descriptions are saved in the './config/descriptions/' folder. Files are created automatically when kits are made.
The default description content for new kits is used in the selection screen and '/starterkit info
Change the description to anything appropriate. Size is not limited, but overly long text may be truncated:
Apply changes with '/starterkit reload':
Now the description appears in the kit selection screen:
Click the "Choose Starter Kit" button to receive the selected kit:
Starter Kit automatically detects mod installation on the client. When used server-side only, players can choose kits via commands.
When the mod is not installed on the client, a message appears upon first join:
Players can view kit contents with '/starterkit info
Kit selection is done with '/starterkit choose
