Remake: README.txt -> LICENSE.txt + README.md
Add folders for media; the folder for schematics is called schems not schematics (I trust the engine more than MTG) Please comment, if wrong Add a guide how to create a mod with this mod template Add screenshot.pngmaster
parent
0f8dc73fd6
commit
866f6c8e26
|
@ -0,0 +1,102 @@
|
|||
Guide for creating your Minetest mod
|
||||
====================================
|
||||
|
||||
1. Create all needed files and folders
|
||||
|
||||
We are using the mod template, so we have the following
|
||||
folder structure:
|
||||
|
||||
mod_template/
|
||||
.git/
|
||||
...
|
||||
models/
|
||||
models_here.txt
|
||||
schems/
|
||||
schematics_here.txt
|
||||
sounds/
|
||||
sounds_here.txt
|
||||
textures/
|
||||
textures_here.txt
|
||||
depends.txt
|
||||
description.txt
|
||||
GUIDE.txt
|
||||
init.lua
|
||||
LICENSE.txt
|
||||
mod.conf
|
||||
README.md
|
||||
screenshot.png
|
||||
|
||||
Rename the folder (mod_template) with your mod's name.
|
||||
|
||||
Delete the .git folder (on *nix-systems you mostly have
|
||||
to enable 'Show hidden files' or something like that,
|
||||
or try to press Ctrl+h or Alt+.).
|
||||
|
||||
|
||||
2. Customize files
|
||||
|
||||
depends.txt:
|
||||
------------
|
||||
Add all mod names, your mod is depending on in a
|
||||
separate line. If your mod has no dependencies, then
|
||||
we don't have to do here anything.
|
||||
|
||||
description.txt:
|
||||
----------------
|
||||
Add a short description about what your mod does and
|
||||
remove the existing one.
|
||||
|
||||
init.lua:
|
||||
---------
|
||||
Replace 'modname' with your mod's name (ll. 1,5).
|
||||
|
||||
If you spilt your code into multiple files, check that
|
||||
the 'header' (ll. 1-3) is existing (and fits to the
|
||||
name).
|
||||
|
||||
LICENSE.txt:
|
||||
------------
|
||||
Follow the insturctions on the comment lines (--).
|
||||
|
||||
mod.conf:
|
||||
---------
|
||||
Replace 'modname' with your mod's name.
|
||||
|
||||
README.md:
|
||||
----------
|
||||
Follow the insturctions on the comment lines (--).
|
||||
|
||||
screenshot.png:
|
||||
---------------
|
||||
Replace with your one. It's pxiel aspect ratio has to be
|
||||
3:2, common resolutions are 360x240 and 480x320.
|
||||
|
||||
The black border in the example is optional of course.
|
||||
|
||||
It's recommended to optimize your screenshot with eg.
|
||||
optipng and advpng (yes, both), to decrease the
|
||||
file size.
|
||||
|
||||
|
||||
3. Write the code and add media
|
||||
|
||||
|
||||
4. Clean up
|
||||
|
||||
Remove these files:
|
||||
|
||||
modname/
|
||||
models/
|
||||
models_here.txt
|
||||
schems/
|
||||
schematics_here.txt
|
||||
sounds/
|
||||
sounds_here.txt
|
||||
textures/
|
||||
textures_here.txt
|
||||
GUIDE.txt
|
||||
|
||||
And now remove all folders that are empty.
|
||||
|
||||
|
||||
5. Publish
|
|
@ -1,71 +1,56 @@
|
|||
Minetest mod: "Template"
|
||||
========================
|
||||
Version 0.1, Status: alpha
|
||||
|
||||
License of source code:
|
||||
-----------------------
|
||||
Copyright (C) 2016 LNJ <git@lnj.li>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
|
||||
License of media (textures, sounds, meshes):
|
||||
--------------------------------------------
|
||||
(by Authors)
|
||||
|
||||
LNJ (CC BY-SA 3.0):
|
||||
template_new_item.png
|
||||
|
||||
|
||||
Details of Licenses:
|
||||
--------------------
|
||||
|
||||
CC BY-SA 3.0:
|
||||
Attribution-ShareAlike 3.0 Unported
|
||||
http://creativecommons.org/licenses/by-sa/3.0/
|
||||
|
||||
|
||||
|
||||
Description:
|
||||
------------
|
||||
|
||||
Template is a mod for Minetest, it doesn't add anything, it's just a template.
|
||||
|
||||
|
||||
How to use this mod:
|
||||
--------------------
|
||||
|
||||
See the Minetest Wiki page of this mod:
|
||||
https://wiki.minetest.net/Mods/Mod_Template
|
||||
|
||||
|
||||
Notes:
|
||||
------
|
||||
|
||||
This mod has no dependencies and should be playable with Minetest 0.4.14 or above.
|
||||
|
||||
|
||||
Links:
|
||||
------
|
||||
|
||||
GitHub:
|
||||
https://github.com/lnj2/mod_template
|
||||
|
||||
Minetest Forum:
|
||||
https://forum.minetest.net/viewtopic.php?id=15041
|
||||
|
||||
Minetest Wiki:
|
||||
https://wiki.minetest.net/Mods/Mod_Template
|
||||
|
||||
License of source code:
|
||||
-----------------------
|
||||
Copyright (C) YearStart-YearEnd YourNameOrNickName <YourEMailAddress>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
--
|
||||
-- You can also use other licenses as well, but that's the recommended one by Minetest.
|
||||
-- If you want, you can add the very complete license to a new file: LICENSE.<license name>.txt
|
||||
|
||||
|
||||
License of media (textures, sounds, meshes):
|
||||
--------------------------------------------
|
||||
(by Authors)
|
||||
|
||||
AuthorName (LicenseName):
|
||||
texture.png
|
||||
mesh.obj
|
||||
mesh.b3d
|
||||
sound.ogg
|
||||
schematic.mts
|
||||
|
||||
-- Here is an example:
|
||||
LonelyShark (CC BY-SA 3.0):
|
||||
building_pick_ruby.png
|
||||
building_pick_break.*.ogg
|
||||
building_cottage.mts
|
||||
|
||||
|
||||
-- Pay attention that at the beginning of every line with a media name,
|
||||
-- has to start with two normal blanks, no tabs.
|
||||
|
||||
|
||||
Details of Licenses:
|
||||
--------------------
|
||||
|
||||
CC BY-SA 3.0:
|
||||
Attribution-ShareAlike 3.0 Unported
|
||||
http://creativecommons.org/licenses/by-sa/3.0/
|
||||
|
||||
-- Replace YearStart, YearEnd, YourNameOrNickName, YourEMailAddress,
|
||||
-- AuthorName, LicenseName
|
||||
-- Add all media files, your mod has
|
||||
-- Remove the examples
|
||||
-- REMOVE EVERY LINE THAT STARTS WITH A DOUBLE HYPHEN (--)!
|
|
@ -0,0 +1,53 @@
|
|||
# Minetest Mod YourModName
|
||||
Version 1.0, Status: alpha/beta/stable, License: LGPLv2.1/CC BY-SA 3.0
|
||||
|
||||
-- Replace Version, Status and License, if necessary.
|
||||
-- Status can be removed
|
||||
|
||||
![Screenshot](https://github.com/lnj2/mod_template/raw/master/screenshot.png "Screenshot")
|
||||
|
||||
-- A screenshot for the mod. The link can be from an external source, too. (optional)
|
||||
|
||||
## Description
|
||||
YourModName adds some building blocks to the game, there are also stair and slab versions of them available.
|
||||
With these new materials you can build more individual buildings, a scary dungeon, a small medival village or a big futuristic city. With this mod, everything is possible!
|
||||
|
||||
-- A short introduction to your mod. It should explain what is the main idea of your mod and what it does.
|
||||
|
||||
## Notes
|
||||
YourModName can be played with Minetest 0.4.14 or above.
|
||||
It has no dependencies.
|
||||
|
||||
-- All Notes about depends.
|
||||
|
||||
## List of features
|
||||
|
||||
-- This heading can be renamed or splitted.
|
||||
-- Please add here everything that the user should know about this mod (like crafting recipies and such things).
|
||||
|
||||
## FAQ
|
||||
Here are some Frequently Asked Questions!
|
||||
|
||||
### Can I use texture xyz for my own mod?
|
||||
Yes, you can under certain conditions, see LICENSE.txt in the mod directory.
|
||||
|
||||
### Question 2?
|
||||
Answer 2.
|
||||
|
||||
-- Frequently Asked Questions (optional)
|
||||
|
||||
## Bug reports and suggestions
|
||||
You can report bugs or suggest ideas on [GitHub](http://github.com/lnj2/mod_template/issues/new), in the [Minetest Forum](http://forum.minetest.net/viewtopic.php?id=15041) or just [email](mailto:example@example.com) me.
|
||||
|
||||
-- Replace all links and the mail address.
|
||||
|
||||
## Links
|
||||
* [GitHub](http://github.com/lnj2/mod_template/)
|
||||
* [Minetest Forum](http://forum.minetest.net/viewtopic.php?id=15041)
|
||||
* [Website](http://lnj2.github.io/mod_template)
|
||||
* [Minetst Wiki](http://wiki.minetest.net/Mods/Mod Template/)
|
||||
|
||||
-- All links are optional, except one to the source code (on eg. GitHub/GitLab/...)
|
||||
|
||||
-- Replace YouModName with your mod's name or It/it (everything capitalized)
|
||||
-- REMOVE EVERY LINE THAT STARTS WITH A DOUBLE HYPHEN (--)!
|
|
@ -0,0 +1 @@
|
|||
Adds some modern building blocks, stairs and slabs.
|
|
@ -1,6 +1,5 @@
|
|||
-- mods/template/init.lua
|
||||
-- ======================
|
||||
-- See README.txt for licensing and other information.
|
||||
|
||||
template = {}
|
||||
-- mods/modname/init.lua
|
||||
-- =====================
|
||||
-- See LICENSE.txt for licensing and README.md for other information.
|
||||
|
||||
modname = {}
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 78 KiB |
Loading…
Reference in New Issue