Modding Tutorial Book (new: BasicMapOps, AutoErrorChecking)

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

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Sun Feb 08, 2015 20:14

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: 45
Joined: Wed Feb 04, 2015 23:41
Location: Florida, USA
GitHub: falsechicken
In-game: false_chicken

Re: Modding Tutorial Book - Creating Better Documentation

by false_chicken » Thu Feb 12, 2015 07:36

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: 5244
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Thu Feb 19, 2015 15:34

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: 45
Joined: Wed Feb 04, 2015 23:41
Location: Florida, USA
GitHub: falsechicken
In-game: false_chicken

Re: Modding Tutorial Book - Creating Better Documentation

by false_chicken » Sat Feb 21, 2015 01:50

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: 341
Joined: Wed May 08, 2013 08:26
GitHub: Amaz1
IRC: Amaz
In-game: Amaz

Re: Modding Tutorial Book - Creating Better Documentation

by Amaz » Sat Feb 21, 2015 15:17

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: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Fri Mar 20, 2015 23:08

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: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Apr 13, 2015 04:58

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
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by prestidigitator » Mon Apr 13, 2015 05:10

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: 5244
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Apr 13, 2015 07:09

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.
 

twoelk
Member
 
Posts: 1202
Joined: Fri Apr 19, 2013 16:19
Location: northern Germany

Re: Modding Tutorial Book - Creating Better Documentation

by twoelk » Mon Apr 13, 2015 08:45

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: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Apr 13, 2015 12:36

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
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by prestidigitator » Mon Apr 13, 2015 21:26

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: 10
Joined: Wed Jun 24, 2015 18:44
IRC: freeemint_
In-game: aulin

Re: Modding Tutorial Book - Creating Better Documentation

by wintermute » Mon Jul 27, 2015 15:32

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: 5244
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Fri Sep 25, 2015 19:41

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: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

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

by Don » Fri Sep 25, 2015 19:50

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: 5244
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
 

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

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

Re: Modding Tutorial Book (new: Inventories)

by Evergreen » Tue Jan 05, 2016 19:41

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

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

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

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

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

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

Re: Modding Tutorial Book (new: Inventories)

by KCoombes » Thu Feb 11, 2016 12:43

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: 516
Joined: Sun Nov 22, 2015 21:36

Re: Modding Tutorial Book (new: Inventories)

by TheReaperKing » Fri Apr 08, 2016 18:58

Thank so much for your tutorial! I plan to use at school with the kiddos!
Resources on happiness and life management - http://MikesHappyPlace.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: 2322
Joined: Fri Feb 26, 2016 19:49
Location: in the dark recesses of the mind
GitHub: TumeniNodes
IRC: tumeninodes
In-game: TumeniNodes

Re: Modding Tutorial Book (new: Inventories)

by TumeniNodes » Fri Apr 15, 2016 22:58

It has definitely been a really big help for me as well. Thank you very much.
There is nothing closer to Hell on Earth, than peanut butter in your jelly jar.
 

PreviousNext

Return to Modding Discussion



Who is online

Users browsing this forum: No registered users and 1 guest