Template

Go to file Use this template

AliasAlreadyTaken 31ffbe2fe6 your-land/yl_template#15 Disallow overwriting a different namespace		2024-08-29 14:44:51 +02:00
dev	Basic structure	2021-06-16 17:51:26 +02:00
.luacheckrc	your-land/yl_template#15 Disallow overwriting a different namespace	2024-08-29 14:44:51 +02:00
api.lua	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00
chatcommand_admin.lua	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00
chatcommand_player.lua	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00
chatcommands.lua	Split chatcommands player and admin	2022-02-19 04:28:40 +01:00
config.lua	Fixes boolean settings	2024-07-13 21:19:14 +02:00
globalsteps.lua	Globalstep	2021-08-15 03:45:54 +02:00
information.lua	Adds clarification on what's suposed to be yl_template.information.name	2024-05-27 23:10:11 +02:00
init.lua	Replace all references to core with minetest	2024-05-27 23:01:26 +02:00
initialize.lua	Adds api example, initialze and documentation	2024-05-12 12:14:16 +02:00
internal.lua	Replace all references to core with minetest	2024-05-27 23:01:26 +02:00
LICENSE-CC0	your-land/yl_template#9 Adds example licenses	2024-06-04 01:40:31 +02:00
LICENSE-MIT	your-land/yl_template#9 Adds example licenses	2024-06-04 01:40:31 +02:00
LICENSE.md	Minor fixes (luacheckrc, settings, license)	2024-06-12 18:23:57 +02:00
mod.conf	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00
priv_example.lua	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00
privs.lua	One priv per file	2021-11-06 10:38:43 +01:00
README.md	Fixes link to dependency section again	2024-07-02 16:14:04 +02:00
screenshot.png	Basic structure	2021-06-16 17:51:26 +02:00
settingtypes.txt	Minor fixes (luacheckrc, settings, license)	2024-06-12 18:23:57 +02:00
setup.lua	Adds api example, initialze and documentation	2024-05-12 12:14:16 +02:00
texts.lua	your-land/yl_template#6 Move all strings into separate file	2024-05-27 22:51:49 +02:00

README.md

yl_template

Purpose

This mod is not meant to bring functionality by itself, but to serve as a template you can base your mod on. Remove the components you do not want and expand on those you want.

Download

Get it from https://gitea.your-land.de/your-land/yl_template

Dependencies

Delete the Dependency section if your mod has no dependencies

See mod.conf

modname_of_dependency

Installation

Copy the "yl_template" folder to your mod directory.
Make sure the dependencies are satisfied, if any.
Enable the mod in your world.mt file.

Configuration

yl_template.debug = false

Set to true to enable debug mode

yl_template.save_path

Set this to where in the worldfolder you want the JSON files stored.

Usage

This mod targets [servers|singleplayer|...], but should work in [[servers|singleplayer|...], too. It comes with no direct content but exposes functions you can use in your mod.

Chatcommands

Modmakers

Use the following public functions to [achieve your goals]

Limitations

Alternatives

Supported versions

If you use yl_template, but something is wrong, please file a bug. PRs also welcome.

There is no reason to believe it doesn't work anywhere, but you never know.

Allied projects

If you know a project that uses this mod tell us and we will add it to the list.

Uninstall

Remove it from your mod folder or deactivate it in your world.mt

Mods that depend on it will cease to work, if the mod is removed without proper replacement.

License

[Shorthand of your chosen license: MIT, LGPLv3+, GPLv3+, AGPL, ...]. Please choose one of the major license that is compatible with as much of the MT universe over some obscure and incompatible license. If you use the screenshot.png, keep Styxcolor in there because she made that screenshot.png, if you add your own, replace the line with whoever made it. Example for MIT and CC0:

See LICENSE.md

Code MIT Developername
Screenshot CC0 Styxcolor