Amethyst-Template

Opinionated template for an Amethyst Mod, will be the base mod used in all amethyst guides! Follow the steps below to build the mod

How to configure

1. Open xmake.lua and configure the mod options:

-- Mod Options
local mod_name = "Amethyst-Template" -- Replace with the name of your mod

2. Open data/packs/RP/manifest.json and replace the name, and generate the two new UUIDv4s here

3. Open .github/build.yml and replace the mod name

env:
    MOD_NAME: Amethyst-Template # Replace with your mod name

4. Open mod.json and fill in all the mod options there too.

{
    "meta": {
        "name": "Amethyst-Template",
        "version": "1.0.0",
        "namespace": "amethyst_template",
        "author": "FrederoxDev"
    }
}

5. Open data/packs/RP/textures/item_texture.ts and edit the project namespace to match the mod.json

const projectNamespace = "amethyst_template";

Building

1. To generate a visual studio solution run the command:

xmake project -k vsxmake -m "release"

2. Open the .sln file in ./vsxmake2022

3. To build your project, either press Ctrl+Shift+B in visual studio OR run the xmake command

4. To build your RP/BP run these commands

cd data
rgl watch

Mod Build Config

extra_deps - An array of projects to add with add_deps() extra_links - An array of projects to link with your mod using add_links() extra_include_dirs - An array of extra directories to include extra_header_files - An array of extra header files to include extra_files - An array of extra files to use

Additional Information

Any textures placed into the textures/items will automatically be included into an item_textures.json file that is generated by data/packs/RP/textures/item_texture.ts.

The icon identifier is determined by the file name, i.e. textures/items/example_item.png will become amethyst_template:example_item