# Home ## What is Nexo? Nexo is an all-in-one Minecraft plugin that makes it easy for server admins to add their own items, blocks, armor, and furniture.\ By using simple file-based configuration, Nexo automatically handles Resource Pack generation. Nexo then dispatches the pack to all players on the server, allowing everyone to see the custom models and textures set up by the admin. This documentation contains a complete list of features, as well examples of what Nexo can do. If you need further assistance, please join the Discord server with a proof of purchase. {% hint style="info" %} Nexo has been tested on Paper & Folia. Info about versions are supported can be found [Version Support](/version-support) {% endhint %} # Version Support Nexo aims to support the latest releases of Minecraft as soon as possible.\ Below is a detailed list of which server-versions Nexo currently supports.
VersionStatusNotes
26.2✅ SupportedNexo 1.25+
26.1-26.1.2✅ SupportedNexo 1.22+
1.21.11✅ SupportedNexo 1.16+
1.21.10✅ SupportedNexo 1.13+
1.21.8✅ SupportedNexo 1.10+
1.21.5✅ Supported
1.21.4✅ Supported
1.21.3⚠️ UnsupportedOfficial support removed as of Nexo 1.25+
Can be used on Nexo 1.24 & older
1.21.1⚠️ UnsupportedOfficial support removed as of Nexo 1.25+
Can be used on Nexo 1.24 & older
1.20.4, 1.20.6⚠️ UnsupportedOfficial support removed as of Nexo 1.13+
Can be used on Nexo 1.12 & older
1.20.5, 1.21, 1.21.2, 1.21.6, 1.21.7, 1.21.9🛑 UnsupportedThese versions are labelled as "Unsupported" because they were quickly followed by a new release to fix bugs. There is no reason to use any of these versions in favor of the above-mentioned ones. Nexo might still work on these releases but in no way is it ideal to use
[^1]: Nexo 1.25+ [^2]: Nexo 1.22+ [^3]: Nexo 1.16+ [^4]: Nexo 1.13+ [^5]: Nexo 1.10+ [^6]: Official support removed as of Nexo 1.25+\ Can be used on Nexo 1.24 & older [^7]: Official support removed as of Nexo 1.13+\ Can be used on Nexo 1.12 & older [^8]: These versions are labelled as "**Unsupported"** because they were quickly followed by a new release to fix bugs. There is no reason to use any of these versions in favor of the above-mentioned ones.\ \ Nexo might still work on these releases but in no way is it ideal to use # FAQ A summary of the most common questions about Nexo ## 📦 ResourcePack ### Can I still use my own resourcepack with Nexo? Yes, you can merge any resourcepacks into the ResourcePack generated by Nexo.\ You can do so by simply adding the .zip or folder to `Nexo/pack/external_packs`\ and the plugin will merge it into the final ResourcePack and send it to all players.\ Check out the [ResourcePack](/configuration/resourcepack) page for a detailed explanation ### NoteBlocks & Tripwires aren't working correctly? Nexo uses NoteBlocks and TripWires for custom blocks, and thus disables all their vanilla behaviour.\ Noteblock-mechanic does have an option to re-enable this without losing custom blocks, if you go to Nexo/`mechanics.yml`\ If you do not care about Custom Blocks, you can also just disable the noteblock & stringblock-mechanics in `mechanics.yml` *** ## 🔧 Configuration ### How do I reference a ResourcePack file in a config? Minecraft ResourcePacks follow a defined and consistent structure.\ ResourcePack files are also split into sub-categories; **sounds, textures, models, fonts, etc..**\ A full list of it can be found on the [Minecraft Wiki](https://minecraft.wiki/w/Resource_pack#Directory_structure), more info on ResourcePacks in [ResourcePack](/configuration/resourcepack) The **namespace** is just another way to sort said sub-categories between different usecases.\ The **filepath** is the remaining path to your file itself When you then want to make a reference to said file in say a NexoItem, this is how you do it; {% code title="assets/nexo/textures/item/nexo\_defaults/forest\_axe.png" %} ```yaml myitem: Pack: # assets/minecraft/models/item/paper.json model: minecraft:item/paper.json # assets/nexo/textures/item/nexo_defaults/forest_axe.png texture: nexo:item/nexo_defaults/forest_axe ``` {% endcode %} Here is an example to reference a given PNG Texture **or** a JSON Model.\ This is the exact same for sounds, fonts etc. Only difference is the immediate folder after the namespace is not textures **ItemModels:**\ assets/**NAMESPACE**/items/**PATH/FILE**.json -> `item_model: NAMESPACE:PATH/FILE` **Models:**\ assets/**NAMESPACE**/models/**PATH/FILE**.json `model: NAMESPACE:PATH/FILE` **Textures:**\ assets/**NAMESPACE**/textures/**PATH/FILE**.png `texture: NAMESPACE:PATH/FILE` **Sounds:**\ assets/**NAMESPACE**/sounds/**PATH/FILE**.ogg `sound: NAMESPACE:PATH/FILE` If your file is inside `assets/minecraft/...` , meaning your namespace is **minecraft**, specifying it in a config is optional. If no namespace is defined, it will assume you mean **minecraft** ### Why can't I hear Stone/Wood sounds? Nexo replaces these sounds with empty ones in order to correctly play Custom Block sounds.\ Nexo will however, play a clone of the vanilla sound whenever the sound would normally play.\ Majority of the time when you cannot hear these sounds, is when you have a ResourcePack sent by Nexo, but you are on a server without Nexo. Like a Velocity/Bungee network where Server A has Nexo, but Server B does not. The fastest fix is to disable `custom_block_sounds` in `mechanics.yml` for CustomBlock & Furniture. ### What is a Duration & how do I use it? A duration is a dynamic way to specify time in a variety of ways.\ Normally plugins require you to specify in ticks or seconds only.\ Nexo allows you to more easily define a length of time with a Duration Format.\ An example is [Sounds](/configuration/sounds) which has a `duration` inside `jukebox_playable` to set the sound-length.\ The format for duration is a value + a suffix stamp for the DurationUnit. Some DurationUnits support non-integer values and will automatically format this into the correct values. `duration: 20t` - 20 ticks\ `duration: 20ms` - 20 milliseconds\ `duration: 20.2s` - 20 seconds & 40 ticks\ `duration: 20.1m` - 20 minutes and 6 seconds\ You also have hours, days, weeks & months # ItemModels vs. CustomModelData ### What is an ItemModel? In 1.21.4, Mojang added a feature to specify the ItemModel of an item.\ In short an ItemModel is the **base model** of an item, which decides when to show what.\ \ ResourcePacks can be split into a few different types of files:\ ItemModels - Tells the client when to show what for an item\ Models - All the visual data of an item, cubes, uv-mappings etc\ Textures - The textures used by Models and other files An ItemModel in short just says "when X condition is satisfied, show this Model to the player"\ By default an item using PAPER as its material will use the vanilla ItemModel **minecraft:paper**\ When an item uses CustomModelData it then adds a custom entry into this vanilla ItemModel that says;\ "When an item with this ItemModel has the CustomModelData X, show this Model". This is the ways custom items have been done ever since it was introduced, as there was no better way.\ It works fine in most cases but can cause some issues and conflicts when merging a lot of files together. Now we can change the base ItemModel itself, and not rely on overriding the vanilla one.\ For servers which only support 1.21.4+ clients, this is the ideal way to handle it.\ It will cause no conflicts, open up for more customizability and stability, and is the intended way to do custom models. ### How do I start using custom ItemModels? Nexo makes the process of swapping away from CustomModelData to ItemModels very easy.\ 1\. Ensure you take a backup of your `Nexo/items` - folder\ 2\. Go into `Nexo/settings.yml` and set `Pack.generation.prefer_item_models: true`\ 3\. Go into your server and run the command `/nexo reset_custom_model_data`\ 4\. Run the command `/nexo reload` And that is it, your NexoItems should now all be swapped to their own custom ItemModel\\ ```yaml myitem: Pack: model: mymodel Components: item_model: nexo:mymodel ``` This ItemModel can be used on any item with any material in any plugin (that supports ItemModels) and will never conflict. Nexo will by default not set `Components.item_model` in the config. It will by default use `nexo:item_id` but you can set it to something else manually if you want to. ### When should I not use a custom ItemModel? The only real time you should not use a custom ItemModel over CustomModelData is if your server tries to support clients older than 1.21.4. There is also some downsides when you have plugins which are still to allow such new features, and rely exclusively on CustomModelData for its features # Video Tutorials Nexo itself only has written documentation in the form of this wiki.\ There is however a community made set of videos, primarily by *Turretedash7,* for a large numbers of the features found in Nexo. You can find a playlist for all the videos [here](https://www.youtube.com/playlist?list=PLDQSwTgJzz5SG3UUNVXpI5H0kp0s9KL-q) {% hint style="info" %} **These tutorials are community made so information in them might be outdated.** As Nexo updates frequently. some things might be different, removed or added after the publication of a specific video-guide, so recommend checking the relevant wiki-page if you encounter issues It is recommended to use them as a starting guide until you get to know Nexo.\ Especially if you find written guides harder to follow to begin with. {% endhint %} {% embed url="" %} # Commands A simple explanation to use the plugin commands ## 📋 Getting Started All the nexo-commands can be found under `/nexo` or it's aliases `/n` `/nx` ## 🎁 Getting/Removing items ### 📦 Nexo Inventory The main benefit of this method is that it allows you to see all the items at the same time in categories based on your `Nexo/items/filename.yml`\ You can grab copies of items here but cannot give it to other players. #### Usage: `/nexo inventory` or `/nexo inv` #### Permission: `nexo.command.inventory` ### 🎯 Give Item This command will be mainly useful if you want to give an item to another player or when you want to automate the give #### Usage: `/nexo give [amount] [player]` #### Permission: `nexo.command.give` ### 🫳 Drop Item This command will be useful if you want to drop an item to another player #### Usage: `/nexo drop [amount] [player]` #### Permission: `nexo.command.drop` ### 🫴 Take Item This command will be useful if you want to remove an item from a player #### Usage: `/nexo take [player]` #### Permission: `nexo.command.take` ### :printer: Dump Item This command is useful for debugging a NexoItem or held item to find the Data & Components on it #### Usage: `/nexo dumpitem ` #### Permission: `nexo.command.dumpitem` *** ## 🎨 Dyeing Items This command allows you to dye the item in your hand, whether it's a dyeable Nexo item or just a normal dyeable item. #### Usage: `/nexo dye ` {% hint style="info" %} `color` can be dye names (red, green), rgb (`0,255,0` for pure green), or hex (`0xFF0000` or `#00FFFF`) {% endhint %} #### Permission: `nexo.command.dye` *** ## 🔧 Recipe Commands This command allows you to add new recipes to the configuration directly from the game using recipes builder. For more information on how to use it, see [Recipes](/general-usage/recipes). #### Usage: ```yaml /nexo recipe builder # Start building a new recipe /nexo recipe save # Save your recipe /nexo recipe show all # See all your recipes /nexo recipe show # Check a specific recipe ``` #### Permission: `nexo.command.recipes` *** ## 📩 Manual Pack Sending This command allows you to send the pack to a group of players.\ Useful if the automatic sending failed or for testing #### Usage: `/nexo pack ` #### Permission: `nexo.command.pack` *** ## ⬆️ Updating Items and Furnitures This command allows you to update furnitures and items.\ Useful if the auto update failed or if you disabled it in settings #### Usage: ```yaml /nexo update furniture # Update furniture in a radius /nexo update item # Update the Nexo items in a players inventory ``` #### Permission: `nexo.command.update` *** ## 🔍 Item Info This command allows you to print general info about a Nexo Item for debugging.\ An example of the output: ```yaml ItemID: my_cool_item # this is the ID of the item CustomModelData: 1000 # the custommodeldata of the item Material: PAPER # the material used for the item Model Name: minecraft:my_cool_item # the name of the model, in the final pack you can find this in minecraft/models/my_cool_item.json ``` #### Usage: `/nexo iteminfo ` #### Permission: `nexo.command.iteminfo` ## 🔍 Glyph Info This command allows you to print general info about a Nexo Glyph for debugging.\ An example of the output: ```yaml GlyphID: required # this is the ID of the glyph Texture: minecraft:required/exit_icon.png # the texture path of the glyph Font: minecraft:default # the font that the glyph uses Unicode: ꐏ # the character used for displaying the glyph (you should use ) ``` #### Usage: `/nexo glyphinfo ` #### Permission: `nexo.command.glyphinfo` ## 🟩 Block Info This command allows you to print general info about a Nexo Block for debugging.\ An example of the output for a noteblock: ```yaml ItemID: my_cool_block # this is the ID of the item that the block is tied to Intrument: PIANO # this is the instrument the noteblock uses Note: 1 # the note Powered: false # the powered state ``` this is different for other block types #### Usage: `/nexo blockinfo ` #### Permission: `nexo.command.blockinfo` *** ## 🙂 Emoji List This command opens a book with all the emojis (glyphs with `is_emoji: true`). #### Usage: `/nexo emojis` #### Permission: `nexo.command.emojis` *** ## 🔄 Reload This command allows you to reload Nexo configurations.\ Reloading items updates any changes you might have made, and updates all old copies players might have.\ Reloading pack regenerates the resourcepack, and if `Pack.dispatch.send_on_reload` is enabled in `settings.yml`, will be dispatched to all players. #### Usage ```yaml /nexo reload # Refresh everything - items, recipes, and pack /nexo reload items # Just update items /nexo reload pack # Rebuild and resend the resource pack /nexo reload recipes # Reload recipe configurations /nexo reload configs # Reload configs /nexo reload dialogs # Reload Dialog configs (new dialogs require a restart) ``` #### Permission: `nexo.command.reload` *** ## 🐛 Debug Mode This command just toggles the debug-state of Nexo.\ In case you run into a bug or an error, you might be asked to toggle this to provide support with a more full error-log of the bug. #### Usage: `/nexo debug` #### Permissions: `nexo.command.debug` *** ## ℹ️ Nexo Version This command simply shows you the version of Nexo.\ If using devbuilds, we might ask you to give us the full jar-file name. #### Usage: `/nexo version` #### Permissions: `nexo.command.version` *** ## ❌ Reset Custom Model data This command deletes the custom\_model\_data from all of your Nexo Items.\ Mainly useful for swapping Nexo to a "ItemModel" based system for 1.21.4+ servers.\ You can get more info about the difference between ItemModels and CustomModelDatas, and why ItemModels are the recommended choice at [ItemModels vs. CustomModelData](/general-usage/faq/itemmodels-vs.-custommodeldata) #### Usage: `/nexo reset_custom_model_data` #### Permissions: `nexo.command.resetcmd` # Recipes Recipes can be created directly in the relevant file within the `Nexo/recipes` directory, or through the ingame RecipeBuilder.\ The RecipeBuilder can be accessed with the command `/nexo recipes builder`.\ Drag your desired items into the crafting slots to create your recipe. Make sure to set the "output" slot to the item you want to give. Each Recipe-type has its own folder in `plugins/Nexo/recipes`, meaning you can organize recipes inside each folder into different files, sub-folders, etc.\ The RecipeBuilder will store recipes inside `plugins/Nexo/recipes/X/X_recipes.yml`, X being the type (shaped, shapeless, etc.) ### Available Recipe Types: * SHAPELESS - Allows each ingredient to be put in any slot * SHAPED - Requires ingredients to be in a specific shape * FURNACE - Recipe for the Furnaces * BLASTING - Recipe for the Blast Furnace * SMOKING - Recipe for the Smoker * STONECUTTING - Recipe for the Stone Cutter * BREWING - Recipe for the Brewing Stand * SMITHING - Recipe for the Smithing Table - This is added via [NexoAddon](https://nexoaddon.gitbook.io/docs/recipes/smithing-recipe) ### Disabling Recipes There is also a new file for disabling recipes in `Nexo/recipes/disabled_recipes.yml` .\ In this file, simply add the Recipe-Key, `minecraft:vanilla_recipe` , and Nexo will disable it. ## Recipe-Type Examples: ### Shapeless `amount` in result specifies how many of said item you should get. It is not available for ingredients. ```yaml grass_block_shapeless: result: minecraft_type: GRASS_BLOCK amount: 2 ingredients: A: minecraft_type: MOSS_CARPET B: minecraft_type: DIRT C: minecraft_type: DIRT ```
*** ### Shaped You can also use Minecraft tags and Nexo items in recipes ```yaml forest_axe: result: nexo_item: forest_axe ingredients: A: tag: minecraft:leaves B: minecraft_type: STICK shape: - _AA - _BA - _B_ ```
*** ### Furnace + Blasting + Smoking ```yaml raw_iron_block_to_iron: result: minecraft_type: IRON_INGOT amount: 9 input: minecraft_type: RAW_IRON_BLOCK cookingTime: 100 experience: 20 ```
*** ### Stonecutting ```yaml stripped_spruce_log: result: minecraft_type: STRIPPED_SPRUCE_LOG input: minecraft_type: SPRUCE_LOG ```
*** ### Brewing ```yaml diamond: result: minecraft_type: DIAMOND input: minecraft_type: GLASS_BOTTLE ingredient: nexo_item: rainbow_ingot ```
# Oraxen → Nexo This article explains how to migrate your Oraxen config to Nexo.\ The process will be mostly automatic, but first follow the steps below.\\ {% stepper %} {% step %} **Put Nexo JAR in your server's `plugins` folder** {% endstep %} {% step %} **Copy the contents of `plugins/Oraxen` into `plugins/Nexo/converter/Oraxen`** The `plugins/Nexo/converter/Oraxen` folder does not exist by default, so create the required folders yourself.\ Also make sure to keep the folder `plugins/Oraxen`, as this will be used later for the conversion process.\ On server reload, Nexo will empty the data from the `plugins/Nexo/converter/Oraxen` folder into a valid Nexo config and remove the folder.\ This step may be repeated for as many Oraxen packs as you would like to add, even at a future date. {% endstep %} {% step %} **Take a backup** It is recommended to make a backup of your server's world folders before swapping to Nexo, as there might be small oversights leading to minor loss of furniture/custom blocks.\\ {% endstep %} {% step %} **Remove Oraxen .jar file** Make sure to only delete the jar files - keep the folder `plugins/Oraxen`.\\ {% endstep %} {% step %} **Start your server** {% endstep %} {% step %} **Check console for conversion issues. And finally, test that the migration has worked by testing items, glyphs, and anything else that may be on your server!** {% endstep %} {% endstepper %} ### Resource Packs There are small changes in how ResourcePacks work between Oraxen and Nexo.\ The main change is that Nexo does not have shortcut folders for `pack/models` etc.\ Instead, Nexo follows the file structure used in vanilla Minecraft resource packs.\ For example, instead of using `pack/models`, Nexo uses `pack/assets/minecraft/models` (etc.)\ This system allows for the easier importing of vanilla Minecraft resource packs.\ You may add any resource pack .zip or ResourcePack-folder (MyPack/assets/...) to `pack/external_packs` and it will be included in the final pack. ### Items When a player joins, any Oraxen items in their inventory will be converted to Nexo items.\ These will also be scanned and converted where there have been changes to the config, most notably in how NoteBlock, StringBlock and Furniture-Mechanics are defined. ### Furniture Placed Oraxen furniture will be automatically converted to Nexo furniture when they load.\ There might be some issues with item frame furniture due to Nexo only supporting ItemDisplay furniture.\ These can be manually replaced, although an automatic conversion feature may be added in a future Nexo update.\ \ Main config changes here are with how seats, lights, and [hitboxes](/mechanics/furniture-mechanic/hitbox) are defined.\ Nexo allows for multiple interaction hitboxes, seats, and lights. Read [Furniture Mechanic](/mechanics/furniture-mechanic) for more info. ### Custom Blocks Custom blocks will be converted to Nexo, however there is a difference in the custom-variation calculation between Oraxen and Nexo. When importing OraxenItems, Nexo will correct this custom-variation.\ Example: `custom_variation: 1` -> `custom_variation: 51`\ There are also some minor changes in how these mechanics are defined.\ Examples can be found at [NoteBlock Mechanic](/mechanics/custom-block-mechanics/noteblock-mechanic) and [StringBlock Mechanic](/mechanics/custom-block-mechanics/stringblock-mechanic).\ \ \ **If there are any issues in the conversion process, let the developers know!** # ItemsAdder → Nexo This article explains how to migrate your ItemsAdder config to Nexo.\ The process will be mostly automatic, but first follow the steps below. {% hint style="danger" %} This page covers migrating to Nexo from ItemsAdder v4.\ If you are on ItemsAdder v3.x, you must update ItemsAdder before migrating to Nexo. {% endhint %} {% stepper %} {% step %} **Put Nexo JAR in your server's `plugins` folder** {% endstep %} {% step %} **Copy the contents of `plugins/ItemsAdder` into `plugins/Nexo/converter/ItemsAdder`** The `plugins/Nexo/converter/ItemsAdder` folder does not exist by default, so create the required folders yourself.\ Also make sure to keep the folder `plugins/ItemsAdder`, as this will be used later for the conversion process.\ On server reload, Nexo will empty the data from the `plugins/Nexo/converter/ItemsAdder` folder into a valid Nexo config and remove the folder.\ This step may be repeated for as many ItemsAdder packs as you would like to add, even at a future date. {% endstep %} {% step %} **Take a backup** It is recommended to make a backup of your server's world folders before swapping to Nexo, as there might be small oversights leading to minor loss of furniture/custom blocks.\\ {% endstep %} {% step %} **Remove ItemsAdder and LoneLibs .jar files** Make sure to only delete the jar files - keep the folder `plugins/ItemsAdder`.\\ {% endstep %} {% step %} **Start your server** {% endstep %} {% step %} **Check console for conversion issues. And finally, test that the migration has worked by testing items, glyphs, and anything else that may be on your server!** {% endstep %} {% endstepper %} ResourcePack content from ItemsAdder is all bundled into `Nexo/pack/external_packs/ItemsAdder/namespace/...`\ Items are moved into `Nexo/items/itemsadder/...`\ Glyphs/Font Images are moved in `Nexo/glyphs/itemsadder/namespace/...` ### Known issues Nexo won't be able to migrate everything, as some features are not compatible across both plugins.\ For example, non-Display Entity furniture placed in your world before conversion will NOT be automatically converted.\\ # Plugin settings Various options impacting the plugin in its generality ## Item configurations Nexo configuration is mainly divided into 3, items, resourcepack & glyphs.\ These folders contain the majority of custom configurations you need. ## Formatting Nexo has some settings for toggling its handling of various packets. Most of these are for transforming Glyph-Tags in packets that handle text or Items.\ Some of these can in some cases cause desync or other issues for some servers.\ These can be toggled of in such cases without much downside. ## ResourcePack ### Obfuscation Obfuscation works by renaming all models, textures and files into random namespaces and paths\ This is to make it very hard for someone to just download and use your pack outside of your server.\ It comes with three modes, SIMPLE, FULL & NONE\ \ There is also an option to cache the obfuscated pack.\ This makes it so unless there are changes, Nexo will not reobfuscate the ResourcePack.\ This makes it so players do not have to redownload the ResourcePack every time your server starts.\\ ```yaml Pack: obfuscation: type: FULL cache: true ``` **NONE** does no obfuscation on the ResourcePack ```makefile 📁ResourcePack └── 📁assets └── 📁custom_namespace └── 📁models └── 📑custom_model.json ``` **SIMPLE** only obfuscates individual filenames, but retains the original pack-structure ```makefile 📁ResourcePack └── 📁assets └── 📁custom_namespace └── 📑02a61ae4-2457-4dfa-91af-9598cd52fd9e.json ``` **FULL** obfuscates the entire path ``` 📁ResourcePack └── 📁assets └── 📁0d003f53-e176-4e74-a895-d392c82f50be └── 📁models └── 📑02a61ae4-2457-4dfa-91af-9598cd52fd9e.json ``` ### PackServer The ResourcePack Nexo generates needs to be hosted somewhere before it can be sent to players.\ Nexo has two built-in server-options, POLYMATH & SELFHOST **POLYMATH** is Nexo's own remote server\ It is located in Germany and can therefore be slower depending on your server's location and players download speed\ \ SELFHOST is a locally hosted server on the machine and can therefore be faster if your players are closer to it. You will need to manually configure the IP-address to your servers. ```yaml Pack: server: type: SELFHOST selfhost: public_address: 0.0.0.0 # Set to your server's IP port: 8082 # Set to a port you have opened on your server polymath: server: atlas.mineinabyss.com secret: mineinabyss ``` ### Dispatch This section is for handling when the pack should be sent to players. ```yaml Pack: dispatch: # Sends the Resourcepack before the players loads into the server # Might cause issues with large packs due to long download/load times send_pre_join: true send_on_join: false send_on_reload: true # Sends the pack to players after using reload-command delay: -1 # Delay before pack is sent, does not apply to PreJoin dispatches mandatory: true # If declining the ResourcePack should kick the player prompt: "<#fa4943>Accept the pack to enjoy a full Nexo<#fa4943>experience" ``` ## Misc ### Hiding Scoreboard & Tablist This option lets you hide the red scoreboard numbers. ```yaml hide_scoreboard_numbers: true hide_scoreboard_background: true ``` {% hint style="danger" %} This might not work for 1.21.8+ servers due to changes in core shaders by Mojang {% endhint %} ## Nexo Inventory Nexo has a `inventory.yml` which can be configured to tweak how the NexoInventory works.\ It lets you change between two types for sorting the inventory, FILE & DIRECTORY.\ FILE is the default and organized everything into one main-page where each item-config file is shown on the main menu.\ DIRECTORY organizes the menu into subpages, following the structure you have inside `plugins/Nexo/items` You can also specify the menu\_layout to tweak the individual buttons irrespective of the type above.\ This lets you set the slot a button is in, the icon/item to display with it and the title of the sub-page it opens. By default Nexo sorts slots by a-z of filenames & icon defaults to the first item in the config.\ You specify it like below, with it referencing the path to the item. The path depends on if you use FILE or DIRECTORY.\ If using FILE, the path is just the `filename`. If using DIRECTORY it is the entire path `folder.filename` ```yaml nexo_inventory: menu_title: search_title: NexoInventory Search style_default_names: true type: FILE menu_rows: 6 menu_layout: my_item: slot: 1 icon: itemid title: ItemID ``` The NexoInventory also has some other features & buttons which can be customized like below.\ This can reference a NexoItem or an ItemModel directly from the ResourcePack ```yaml next_page_icon: next_page_icon previous_page_icon: previous_page_icon exit_icon: cancel_icon search_icon: nexo:search_icon directory_icon: nexo:directory_icon ``` # ResourcePack {% hint style="info" %} If you are unsure how to reference a ResourcePack-file in a config-file [FAQ](/general-usage/faq#how-do-i-reference-a-resourcepack-file-in-a-config) {% endhint %} *** ## 🗂️ ResourcePack-Structure The ResourcePack in Nexo follows the vanilla structure but also letting you import and automatically merge full ResourcePacks\ This is in an effort to make importing third-party ResourcePacks a lot easier.\ Below is an example of the new structure. {% code title="" %} ``` 📁Nexo └── 📁pack └── 📁assets │ ├── 📁minecraft │ │ ├── 📁models │ │ │ ├── 📁item │ │ │ │ └── 📑paper.json │ │ │ └── 📑custom_model.json │ │ └── 📁textures │ │ └── 🖼️something.png │ └── 📁custom_namespace │ └── 📁models │ └── 📑custom.json │ └── 📁external_packs ├── 📁DefaultPack.zip ├── 📁custom_resourcepack.zip └── 📁custom_resourcepack2 └── 📁assets └── 📁custom_namespace2 ``` {% endcode %} Goal is to let users merge resourcepacks in via either ZIPs or directories, outside of the normal assets folder.\ This would dynamically merge in any conflicting files, like a paper.json or sounds.json, instead of migrating it to Nexo-configs to be generated.\ Meaning that pack-import instructions on your end now boils down to:\ Put `my_pack.zip` inside `Nexo/pack/external_packs` *** ## 🎭 Obfuscation Nexo has a built-in way to "obfuscate" the content of your resource-pack.\ This is done by randomizing all file-names in an attempt to make it very hard and annoying to try and take stuff from it for pirates.\ It comes with three modes, `NONE`, `SIMPLE`, `FULL`\ \ **NONE** - Self-explanatory, does not obfuscate pack in any way\ **SIMPLE** - Obfuscates filenames only\ `namespace:model/path.json` -> `namespace:bba2d60b-8e3e-4051-9734-fef92766777f`\ **FULL** - Obfuscates namespace & filename;\ `namespace:model/path.json` -> `c491303e-ba1e-4037-a59d-62b5fdfb6bb8:bba2d60b-8e3e-4051-9734-fef92766777f` *** ## 📦 PackSquash-Integration Nexo allows you to run PackSquash on the resourcepack without manually reuploading the pack.\ Simply download the latest [PackSquash](https://github.com/ComunidadAylas/PackSquash/releases) build and drop it in `plugins/Nexo/pack/packsquash` .\ Then drop your **packsquash.toml** in the same directory, an example can be found [here](https://gist.github.com/Boy0000/92149d2704b6086473fccb4d771c42b4).\ If you want it in another location, you can specify a path for the binary & settings ```yaml Pack: generation: packsquash: enabled: true executable_path: plugins/Nexo/pack/packsquash/packsquash settings_path: plugins/Nexo/pack/packsquash/packsquash.toml ``` To enable Nexo's PackSquash-integration simply enable `Pack.generation.packsquash.enabled` in settings.yml. Then when the pack generates, it will start the PackSquash process. If it suceeds you should see somehting like the below.

Example of successful PackSquash process

If it failed you should see some detailed info about which file and a reason for it.\ If Nexo's debug-mode is enabled, it will output info about all successful files aswell {% hint style="info" %} Depending on your TOML-configuration & ResourcePack size & complexity, the PackSquash process might take some time. Nexo will cache the output so that if the ResourcePack does not change, the PackSquash process will not need to be ran again {% endhint %} *** ## 🌐 PackServer Nexo supports several ways to upload & dispatch the ResourcePack it generates.\ Set the type via `Pack.server.type` in `settings.yml`. ### NONE Does not send any ResourcePack to players. Use this on backend servers that should not dispatch a pack. ### POLYMATH A dedicated upload server hosted by the Nexo team (Germany). The pack is uploaded and served automatically. ```yaml Pack: server: type: POLYMATH polymath: server: atlas.nexomc.com secret: nexomc ``` ### SELFHOST Hosts the ResourcePack directly from your server machine. Requires an open port and a reachable public address. ```yaml Pack: server: type: SELFHOST selfhost: port: 8082 public_address: "http://your.ip.or.domain" dispatch_threads: 10 ``` ### LOBFILE Uploads the pack to [LobFile](https://lobfile.com/). Requires an API key. ```yaml Pack: server: type: LOBFILE lobfile: api_key: YOUR-API-KEY ``` ### S3 Uploads the pack to any S3-compatible object storage (AWS S3, Cloudflare R2, Hetzner Object Storage, etc.). ```yaml Pack: server: type: S3 s3: public_url: "https://fsn1.your-objectstorage.com" endpoint_url: "https://fsn1.your-objectstorage.com" region: eu-central-1 bucket: nexo-storage access_key: ACCESS secret_key: SECRET url_expiration: 7d path_style: false chunked_encoding: true ``` ### Custom PackServer The `NexoPackServer` interface can be implemented by third-party plugins and registered via `PackServerRegistry`, allowing you to add your own upload/dispatch logic. *** ## 🔗 Cross-Server/Proxy ResourcePacks For Velocity proxy networks, use [NexoProxy](/addons/nexo-proxy) — a Velocity plugin that blocks duplicate ResourcePack sends when players switch between backend servers. *** ## 📥 Importing Nexo lets you import Third-Party ResourcePacks in several ways.\ The recommended one is shown above, by adding a directory or .zip to `plugins/Nexo/pack/external\_packs`\ There is also `Plugin.import.from_location` in settings.yml, letting you specify a directory/zip relative to your plugins folder\ There is also `Plugin.import.from_url` in settings.yml, letting you specify any url that Nexo will download a directory/zip from and include # MultiPack Feature The Multipack feature allows for sending additional ResourcePacks to players with the base-pack.\ Each pack is defined as a **template**, which can be required, optional, or enabled by default.\ Players can toggle optional templates on/off, and Nexo re-sends the appropriate packs automatically. ## How it works * Templates are standalone resource packs stored in `plugins/Nexo/pack/template_packs/` (or at a custom path). * On startup/reload, each template is read, built, and hosted alongside the main pack. * When a player joins, they receive the main Nexo pack plus any template packs that are enabled for them (required ones + their personal selections). * Templates can declare conflicts with each other, meaning enabling one automatically disables the conflicting template(s). *** ## Configuration All multipack configuration lives in `plugins/Nexo/multipack.yml`.\ Templates are defined under the `templates:` key, and the optional GUI menu under `menu:`. ```yaml templates: my_template: required: false # Always sent to all players, cannot be toggled default: true # Enabled by default for new players conflicts_with: # Disables these templates when this one is enabled - other_template path: "" # Optional: custom path to the pack folder or zip # Defaults to plugins/Nexo/pack/template_packs/ other_template: required: false default: false conflicts_with: my_template # Can also be a single string menu: # See the GUI / Menu section below ``` ### Template options
OptionTypeDefaultDescription
requiredbooleanfalseAlways sent to every player; cannot be toggled off
defaultbooleanfalseEnabled by default for players who have never toggled it
conflicts_withstring or list[]IDs of templates to disable when this one is enabled
pathstring""Path to the pack. Accepts absolute paths, paths relative to template_packs/, or paths relative to the Nexo data folder. Defaults to template_packs/<id>
## Pack folder structure Place each template pack as a folder or zip inside `plugins/Nexo/pack/template_packs`.\ This follows the same logic as [ResourcePack](/configuration/resourcepack#resourcepack-structure) If the pack has no `pack.mcmeta`, Nexo generates one based on the server's version. *** ## GUI / Menu Nexo includes a built-in inventory GUI for players to browse and toggle their template selections without needing commands. The menu is configured under the `menu:` key in `multipack.yml`. ### Opening the menu ``` /nexo multipack /nexo multipack menu /nexo multipack menu ``` * Permission: `nexo.command.multipack.menu` * Permission for opening for others: `nexo.command.multipack.menu.other` Changes made inside the GUI are **batched**, meaning packs are only re-sent once when the inventory is closed, not on every click. ### Menu configuration ```yaml menu: title: "My Resourcepack Menu" rows: 3 # 1–6 slots: my_slot: offset: 5,2 # Column (x: 1–9) and row (y: 1–) of the top-left cell size: 1,1 # How many cells wide/tall this slot occupies (defaults to 1×1) # Only the top-left cell is interactive, remaining cells show an invisible copy all_slots_except_first_empty: false base_item: # Fallback item shown when the action's state has no own item material: PAPER display_name: "My Pack" action: # See action types below ``` #### Slot options
OptionTypeDefaultDescription
offset.x / offset.yinteger1Column (1–9) and row (1–rows) of the top-left cell of the slot
size.x / size.yinteger1Width and height in cells. Useful for decorative multi-cell slots
all_slots_except_first_emptybooleanfalseWhen true, only the top-left cell is interactive; all others display an invisible placeholder that copies the base item's data components
base_itemitem section—Fallback item used when a state has no own item defined. Required unless every action state defines its own item
actionsection—Defines what happens when the slot is clicked (see below)
*** ### Action types #### TOGGLE Displays one of two items depending on whether the target template is currently enabled, and flips it on click. ```yaml action: type: TOGGLE target: my_template # Template ID to toggle enabled_item: # Item shown when the template is ON material: LIME_DYE display_name: "Music Pack | Enabled" disabled_item: # Item shown when the template is OFF material: GRAY_DYE display_name: "Music Pack | Disabled" ``` `enabled_item` and `disabled_item` are merged on top of `base_item` if one is defined, so shared properties (e.g. lore) can be put in `base_item` and only the differences in each state item. Required templates cannot be toggled — clicking their slot does nothing. #### CYCLING Cycles through a list of templates on each click, enabling exactly one at a time. Useful for mutually-exclusive choices like 2D vs 3D tools. **Simple form** — template IDs only, inherits `base_item` for the display: ```yaml action: type: CYCLING targets: - 2d_tools - 3d_tools ``` **Rich form** | each entry can carry its own item, merged on top of `base_item`: ```yaml action: type: CYCLING targets: - id: 2d_tools material: PAPER itemname: "2D Tools" - id: 3d_tools material: IRON_SWORD itemname: "3D Tools" ``` On click, the currently-enabled entry is disabled and the next one in the list is enabled (wrapping around). All other entries in the cycle are set to `false`. *** ### Item definition Items in `base_item`, `enabled_item`, `disabled_item`, and cycling entries support three formats: **Nexo item** | references an existing Nexo item by ID: ```yaml base_item: nexo_item: my_item_id ``` **Item model** | An ItemModelBuilder, refer to [ItemModel Builder](/configuration/items/itemmodel-builder) for details. Can be used to create simple custom items without needing to set up a full Nexo item. ```yaml base_item: item_model: type: "composite" models: - type: model model: "item/diamond_sword" - type: model model: "item/diamond" ``` **Inline item** | a standard Nexo `ItemParser` section (material, display\_name, lore, etc.): ```yaml base_item: material: PAPER itemname: "My Pack" lore: - "Click to toggle" ``` *** ## Commands MultiPack commands are under `/nexo multipack` and require the `nexo.command.multipack` permission. ### Open GUI ``` /nexo multipack /nexo multipack menu /nexo multipack menu ``` Opens the interactive template selection menu. If no `menu:` section is configured in `multipack.yml`, a warning is shown instead. * Permission: `nexo.command.multipack.menu` * Permission for targeting others: `nexo.command.multipack.menu.other` ### List templates ``` /nexo multipack list ``` Shows all configured templates and their current state (enabled/disabled) for the executing player.\ Required and default templates are labeled. ### Toggle a template ``` /nexo multipack toggle