Skip to content
Julian edited this page Oct 3, 2023 · 30 revisions

UltimateFoods - Wiki

Commands

Permissions

  1. uf.get - Allows you to grant food to the user
  2. uf.menu - It will allow you to see the list of categories and meals.
  3. uf.reload - It will allow you to reload the plugin and its settings
  4. **uf.edit - Allow you to edit/create foods and recipes in game. You can add different permissions to each food from the food.json configuration file

Resourcepack

You can download the Resourcepack via the Link in the config.json File within the plugin settings.

Editing the resource pack

_UltimatedFoods uses custom model data and materials, so you can create as many foods as you want in your resourcepack, I cant explain how to edit resourcepacks in this wiki because that a lot of information, but there are loots of tutorials out there.

Default foods

The default foods will be downloaded automatically with your .jar in spigot.

Create new foods and categories

Creating new categories.

To create a new categorie just create a new folder in "categories" ex "categories/sweets_2"

Creating new foods

We must go to the folder of our category, then we must create (or copy an already existing config) and name it: "Food_foodname.json" ex: Food_CheeseBurger.json

And we will have to copy and paste the food configuration structure, you can get it by copying it from existing food from other categories or you can copy the following code:

{
"uniqueID": "CheeseBurger",
"displayName": "&eCheeseBurger",
"description": [],
"instantEat": false,
"foodMaterial": "APPLE",
"headTexture": "",
"customModelData": 30091,
"permission": "",
"price": 0.0,
"saturation": 1.0936872442685543,
"hunger": 1.54,
"health": 0,
"commands": [],
"recipe": {
"shape": [
"xxx",
"xxx",
"xxx"
],
"materials": {
"x": "AIR"
}
}
}

How to configure a food:

uniqueID Is the id of the food, it must be unique and that the id that we will use in /uf get
Ex: CheeseBurger

displayName Is the name that people will see when they craft this food.
Ex: "&eCheeseBurger"

description Lore of the item.
Ex: ["Lore line 1", "lore line 2"]

instantEat set this to true if you want people to be able to eat food instantly on right click.
Ex: true

foodMaterial spigot material that this food will use, really helpful for resourcepacks and custom models. List of materials: https://helpch.at/docs/1.12.2/org/bukkit/Material.html
Ex: CARROT

headTexture if "foodMaterial" is set to PLAYER_HEAD it will use "headTexture" for the texture, here you can user player names or a "base64" string.
Ex of player name: xXJuliGameXx
Ex of base64: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDYxZTc4ZmE1OTQyNzRiNGZmOTRhNjdlZTM5OTEzZmNlZGIxYzNhOGQ1ZjI2YzNlZGMzM2ZlZDQwMzI3MTA4MiJ9fX0=" Base64 head list: https://minecraft-heads.com/custom-heads

customModelData resourcepack custom model data of item. https://minecraft.fandom.com/wiki/Tutorials/Models
Ex: 30006

permission if player should have a permission to eat this food.
Ex: uf.cheeseburger

price monetary value that this food has.
Ex: 50

Saturation and food is not the same. Food is visible, saturation cant be seen. List: https://www.thegamer.com/minecraft-every-food-item-hunger-saturation/
saturation ammount of "saturation" that this meal give you.
Ex: 2.5

hunger ammount of "food" that this meal give you.
Ex: 2.5

health ammount of health that this food gives you.
Ex: 3

commands List of commands that will be executed when a player eats this food.
Ex: ["tp %player% 100 50 100", "playsound minecraft:entity.experience_orb.pickup ambient %player%"]

recipe recipe of the food. Example: "recipe": {
"shape": [
"bbb",
"csa",
"bbb"
],
"materials": {
"b": "BREAD",
"c": "Cheese",
"s": "COOKED_BEEF",
"a": "bacon"
},
"craft_amount": 3
}
Note that this craft will give you 3 as resoult, also "BREAD" and "COOKED_BEEF" are vanilla items, but "bacon" and "Cheese" are custom food of this plugin (the come in the default config). To use a custom food you must place its id and it case sensitive.

Tips: To see a recipe you must do "uf reload" to load it, and then use "uf menu" and go to your food and right click it. If it does not work you did something wrong.
Screenshot_2023-07-16_18-38-19

If your food is not loading you made something wrong, as the config is a json, you can check if your format is correct in https://jsonlint.com/ if its correct and it does not load anyways contact me in the support discord.

Roadmap

Upcoming implementations for this plugin ;)

Official Discord!

Through the discord you can make your queries to obtain support, recommendations and suggestions to improve our plugin :)