Medieval Cookery

Real server console output from Medieval Cookery 0.2.0 (built from main) on a local throwaway Paper 1.21.11 test server: the five default recipes being registered when the plugin enables.

This Minecraft plugin allows server owners to add cooking recipes for an enhanced roleplay experience.

Supported Minecraft Versions

This plugin is supported on the Minecraft versions listed in minecraft-versions.json: currently 1.19.4, 1.21.11, 26.2 and 26.3 (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up.

Custom Recipes

Recipes are shaped, and use the symbols you define in the 'symbols' list of your recipe section.

• Each recipe's id (its key under 'recipes:') may contain only lowercase letters, digits, '/', '.', '_' and '-' (for example 'fish_stew'). A recipe with any other id is skipped, and the reason is logged at startup.

• 'hungerDecrease' is the number of ticks that the Saturation potion effect lasts for once this item has been consumed. The more filling the item, the longer the effect. It must be a whole number of at least 1; a value that is not a number, or is 0 or less, is logged at startup and replaced with 1.

• 'afterEatItem' is the item the player ends up with after consuming the food item (for example: a wooden bowl used in the recipe ingredients can be given back)

• 'textureBase64' is the player head texture to use to represent this food item. Examples can be found on the player head database under food and drink (https://minecraft-heads.com/player-heads/food-drinks). Then search the corresponding username to find the uuid, and then paste that uuid at the end of this url: https://sessionserver.mojang.com/session/minecraft/profile/ The string inside the "value" key of the JSON returned from that URL is what you need to paste in this part of the recipe. (TODO: Automate this process with API calls to automatically retrieve this based on a player uuid)

Works Well With

Medieval Cookery is part of two sets of Dan's Plugins: medieval roleplay and survival flavour. These are companion plugins that suit the same kind of server and run side by side; Medieval Cookery does not depend on or call into any of them.

Medieval roleplay:

• Medieval Roleplay Engine (SpigotMC, /dpm get medievalroleplayengine): character cards, local, global, whisper and yell chat, emotes, dice and messenger birds.
• Medieval Factions (SpigotMC, /dpm get medievalfactions): nation-like factions with land claims, diplomacy and laws. Its add-ons are listed in its Expansions section.
• Mailboxes (SpigotMC, /dpm get mailboxes): persistent mail between players, with item attachments.
• Medieval Economy (SpigotMC, /dpm get medievaleconomy): a coinpurse and a physical currency item.
• PlayerLore (SpigotMC, /dpm get playerlore): players write their own lore onto their items.
• Conquest Recipes (SpigotMC, /dpm get conquestrecipes): recipes for historical weapons, armour and shields named to match the Conquest resource pack.

Survival flavour:

• Food Spoilage (SpigotMC, /dpm get foodspoilage): food goes bad over time.
• Wild Pets (SpigotMC, /dpm get wildpets): players tame any entity and keep it as a pet.
• SimpleSkills (SpigotMC, /dpm get simpleskills): skills that level up as players play and unlock benefits.
• More Recipes (SpigotMC, /dpm get morerecipes): recipes for items that cannot be crafted in vanilla.

Every plugin above is listed on dansplugins.com. Medieval Cookery is listed at dansplugins.com/resources/medieval-cookery, and Dan's Plugin Manager installs it with /dpm get medievalcookery.

Documentation

• USER_GUIDE.md – installation, the craftable foods, and how to eat them
• CONFIG.md – recipes.yml location and field reference, and the config.yml usage-reporting switch
• COMMANDS.md – command reference
• CONTRIBUTING.md – building the plugin and adding recipes
• CHANGELOG.md – release history

Usage reporting

Usage reporting is on by default: when the plugin is enabled it sends its name and version (the plugin has no commands, so startup is its only event) to https://trace.danielstephenson.dev so it is known which plugins are actually in use. Nothing about players, worlds or IPs is sent. The plugin says on every startup whether reporting is on. Each event also carries a random server ID (the server-id line in plugins/trace/config.yml) so servers can be counted rather than events. It identifies no person, account or IP address; delete the line to get a new one.

To turn it off:

• usage-reporting.enabled: false in this plugin's config.yml
• for every plugin on the server that reports to trace: enabled: false in plugins/trace/config.yml (written by the first such plugin to start)
• the environment variable TRACE_USAGE_REPORTING=off or DO_NOT_TRACK=1

Details: https://danielstephenson.dev/usage-reporting

Adoption

This project was adopted by the Dan's Plugins Community on June 5th, 2022.

License

Medieval Cookery is open source under the Apache License 2.0.