Modding Tutorial Book (new: Code architecture, unit testing)

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Post

A small announcement, the repo has been renamed to /minetest_modding_book/ (from /minetest_doc/). You should correct any links, however it doesn't matter, I've set up redirects. It is also being hosted on rubenwardy.com rather than rubenwardy.github.io, but that redirects too.

I have also fixed some typos and clarified things in node drawtypes. Not finished yet, though. I need nice renders of drawtypes. (see existing images)

User avatar
false_chicken
Member
Posts: 52
Joined: Wed Feb 04, 2015 23:41
GitHub: falsechicken
In-game: false_chicken
Location: Florida, USA

Re: Modding Tutorial Book - Creating Better Documentation

by false_chicken » Post

This played an essential role in teaching me to mod Minetest. Thanks rubenwardy! Great stuff here.
DISCLAIMER: I am probably wrong.

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Post

The folder structure chapter has been partially rewritten. All the examples in the book can downloaded or browsed in the GitHub branch. A feedback form is now on the homepage, to allow easier reporting of issues. I will be going through all the chapters and correcting mistakes tonight. Expect more chapters this week. I'm open to suggestions.

I'd love more contributors to this book.

User avatar
false_chicken
Member
Posts: 52
Joined: Wed Feb 04, 2015 23:41
GitHub: falsechicken
In-game: false_chicken
Location: Florida, USA

Re: Modding Tutorial Book - Creating Better Documentation

by false_chicken » Post

It would be awesome if this could be exported to EPUB. Probably not worth the work but I would enjoy it xD.
DISCLAIMER: I am probably wrong.

Amaz
Member
Posts: 354
Joined: Wed May 08, 2013 08:26
GitHub: Amaz1
IRC: Amaz
In-game: Amaz

Re: Modding Tutorial Book - Creating Better Documentation

by Amaz » Post

One epub conversion here! https://www.dropbox.com/s/qv730im2vidmy ... .epub?dl=0

I'm not really sure what this is like on an e-reader (I presume that is why you wanted it!), but it should work alright.
It wasn't that hard to make, and I'm sure that there are easier ways than what I did...

User avatar
Don
Member
Posts: 1643
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Post

This book is a great resource. Thanks again for your hard work.
Was wondering if you are planning on doing any chapters on methods and objects?
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here

User avatar
Don
Member
Posts: 1643
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Post

Just noticed that you do not have a section on adding sound.
Any chance of you adding a chapter on it. The wiki has a bit but I know there is more to sound then what the wiki says.
I have come to rely on your book and appreciate it very much.
Thanks for everything you do.
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here

User avatar
prestidigitator
Member
Posts: 640
Joined: Thu Feb 21, 2013 23:54

Re: Modding Tutorial Book - Creating Better Documentation

by prestidigitator » Post

MediaWiki also uses a form of markdown. Have you considered publishing the book to the developer wiki? That's already the modders' go-to reference, allows easy linking to API elements you are describing in the text, etc. I love the effort, but it'd be nice to have all of this type of thing in one place.

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Post

The rationale behind using a separate system:
  • Dictatorship. I can get to control what goes in. Spelling mistakes don't matter as much as lack of clarity and poor grammar. People on wikis seem to add irrelevant details which the reader doesn't need to know at that stage in learning.
  • Clean downloading as static HTML.
Typos do exist in the book, but nobody ever submits PRs to change this. It's probably because it's not worth git cloning, etc, just for a small change. A wiki would solve this. There has also been no help from others.

As for the argument about linking to dev wiki pages, I hadn't considered doing this. I'd like the book to link to more resources, and that's on the to do list.

User avatar
twoelk
Member
Posts: 1382
Joined: Fri Apr 19, 2013 16:19
GitHub: twoelk
IRC: twoelk
In-game: twoelk
Location: northern Germany

Re: Modding Tutorial Book - Creating Better Documentation

by twoelk » Post

rubenwardy wrote:...
There has also been no help from others.
...
and yet we are lurking with interest ;-P

good job so far

User avatar
Don
Member
Posts: 1643
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Post

The dev wiki is a great resource but I find that it is written for programmers. People like myself need a tutorial that we can understand. This book does exactly that.
I have seen the spelling mistakes and I ignore them. Maybe I should help with that.
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here

User avatar
prestidigitator
Member
Posts: 640
Joined: Thu Feb 21, 2013 23:54

Re: Modding Tutorial Book - Creating Better Documentation

by prestidigitator » Post

Don wrote:The dev wiki is a great resource but I find that it is written for programmers. People like myself need a tutorial that we can understand. This book does exactly that.
Right. Well, that's why I think it would be good to add things to the wiki that aren't written just for programmers. To improve it, and make it more useful for all.

wintermute
Member
Posts: 13
Joined: Wed Jun 24, 2015 18:44
IRC: freeemint_
In-game: aulin

Re: Modding Tutorial Book - Creating Better Documentation

by wintermute » Post

You are encouraged use to my MinetestIDE in your book, its cross platform and makes the whole experience smoother.
Forum link: viewtopic.php?f=14&t=12923

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Post

New Chapters:
  • Creating Textures
  • Node Metadata
  • Chat and Commands
  • ItemStacks
  • Read More (list of resources)
Corrected multiple typos, grammatical and spelling mistakes.

Read Now | Download for offline use
Last edited by rubenwardy on Fri Sep 25, 2015 19:51, edited 1 time in total.

User avatar
Don
Member
Posts: 1643
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book (new: ItemStacks, Metadata, more)

by Don » Post

You are awesome!
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book (new: ItemStacks, Metadata, more)

by rubenwardy » Post

Added Inventories chapter.

Download

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book (new: Inventories)

by rubenwardy » Post

Added loads more anchor links to lua_api.html

Commit 47880

User avatar
Evergreen
Member
Posts: 2135
Joined: Sun Jan 06, 2013 01:22
GitHub: 4Evergreen4
IRC: EvergreenTree
In-game: Evergreen
Location: A forest in the midwest
Contact:

Re: Modding Tutorial Book (new: Inventories)

by Evergreen » Post

The link to the online version of the book no longer works.
Back from the dead!

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book (new: Inventories)

by rubenwardy » Post


User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book (new: Inventories)

by rubenwardy » Post

It may also be because I moved to www.rubenwardy.com from rubenwardy.com

User avatar
rubenwardy
Moderator
Posts: 6251
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

Re: Modding Tutorial Book (new: Inventories)

by rubenwardy » Post

Fixed, I think.

Arcelmi
Member
Posts: 68
Joined: Mon Dec 28, 2015 16:24
GitHub: Arcelmi
IRC: Arcelmi
In-game: Arcelmi
Location: Germany

RE: Modding Tutorial: THANK YOU!!!

by Arcelmi » Post

Thank you for this tutorial!

KCoombes
Member
Posts: 412
Joined: Thu Jun 11, 2015 23:19
In-game: Knatt
Location: SW Florida, USA

Re: Modding Tutorial Book (new: Inventories)

by KCoombes » Post

Typo:

Wear
ItemStacks also have wear on them. Wear is a number out of 65535, the higher is more warn.

worn, not warn

User avatar
TheReaperKing
Member
Posts: 531
Joined: Sun Nov 22, 2015 21:36
Contact:

Re: Modding Tutorial Book (new: Inventories)

by TheReaperKing » Post

Thank so much for your tutorial! I plan to use at school with the kiddos!
Become A Real Life Superhero - http://SuperheroHill.com
Project Lead of the Doom 3 Mod Last Man Standing - http://Doom3Coop.com
Project Lead of Platinum Arts Sandbox Free 3D Game Maker - http://SandboxGameMaker.com
Youtube Channel - https://www.youtube.com/user/PlatinumArtsKids

User avatar
TumeniNodes
Member
Posts: 2861
Joined: Fri Feb 26, 2016 19:49
GitHub: TumeniNodes
IRC: tumeninodes
In-game: TumeniNodes
Location: in the dark recesses of the mind
Contact:

Re: Modding Tutorial Book (new: Inventories)

by TumeniNodes » Post

It has definitely been a really big help for me as well. Thank you very much.
Ich mag keine grünen Eier und Schinken, ich mag sie nicht Sam I Am

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest