https://github.com/frederoxdev/tutorial-mod
https://github.com/frederoxdev/tutorial-mod
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/frederoxdev/tutorial-mod
- Owner: FrederoxDev
- Created: 2025-09-30T13:49:57.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-10T12:45:31.000Z (8 months ago)
- Last Synced: 2025-10-18T23:42:50.615Z (8 months ago)
- Language: Xmake
- Size: 15.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://www.uuidgenerator.net/version4)
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
```
## 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`