Page 3 of 7

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Dec 29, 2014 13:43
by rubenwardy
That Lua_api.HTML was from lua api.txt translated into markdown by wuzzy and shadowninja and translated into HTML by python's markdown and table of contents modules.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Dec 29, 2014 19:41
by rubenwardy
Added a Node Drawtype chapter. It isn't complete yet, some are missing.

Node Drawtypes

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Dec 29, 2014 20:05
by TG-MyinaWD
Should also we make an Minetest History Book like Since first day started Minetest being made all the way to now?

I just know might got do an Q&A with C55 for most the Answers.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Dec 29, 2014 20:11
by rubenwardy
There wouldn't be much to write about, you might as well just write a wiki page about it. celeron55 has a blog from the early days of development, that could help

Anyway, this is the n topic to discuss this.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Tue Dec 30, 2014 15:59
by MrNomNom111
Thanks so much for the time you put into these resources. These help immensely!

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Tue Dec 30, 2014 16:06
by MrNomNom111
How do I contact you to contribute? I would love to help

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Tue Dec 30, 2014 16:42
by rubenwardy
Send emails to me at rubenwardy on gmail.com
<-- Or PM me.

I am on free node IRC (#minetest) from 5-8pm GMT.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Thu Jan 01, 2015 17:45
by rubenwardy
Add anchor links to headings and printable version (click link in navbar).

Added a chapter on the HUD: http://rubenwardy.github.io/minetest_do ... s/hud.html
It's fairly basic as HUD is subject to change. It's really just to explain positioning.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Thu Jan 01, 2015 22:27
by Don
rubenwardy wrote:Add anchor links to headings and printable version (click link in navbar).

Added a chapter on the HUD: http://rubenwardy.github.io/minetest_do ... s/hud.html
It's fairly basic as HUD is subject to change. It's really just to explain positioning.
Thanks again for your hard work!

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Thu Jan 01, 2015 22:47
by Linuxdirk
Don wrote:Thanks again for your hard work!
I second that. Finally an understandable description.

… but to me HUD elements and placing of them is still a chaotic mess :)

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 03, 2015 16:23
by Jordach
If anyone asks why that Dropbox link leads to BiomeAPI.odf, that's my segment for this, as there isn't any decent Biome API documentation, so I'm writing it.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 03, 2015 16:31
by rubenwardy
Thank you Jordach. I'll edit that and convert it tomorrow - I'm away from my computer this evening, doing real life things D:

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 03, 2015 18:40
by leeminer
I'm sure you all knew, but I see your tutorial on the wiki!!

http://dev.minetest.net/Intro

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 03, 2015 21:34
by Jordach
rubenwardy wrote:Thank you Jordach. I'll edit that and convert it tomorrow - I'm away from my computer this evening, doing real life things D:
Still not finished. Don't even bother. :3

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sun Jan 04, 2015 10:35
by Gael de Sailly
Started to draft the mapgen/ores/LVM tuto. Not finished. Today is the lastest day of the holidays, so you will probably wait for the next weekend.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sun Jan 11, 2015 20:15
by rubenwardy
Added a chapter on releasing a mod to the forum.


Read the 'Releasing a Mod' chapter - Download Book

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sun Jan 11, 2015 21:33
by Gael de Sailly
For the mapgen tuto : sorry, not finished yet ; I'm not lazy, but I have a lot of projects (Minetest and not only). Too many projects for me, I have not a lot of time because of school.
Maybe, one day, I will finish it.
If someone else is good in mapgen, and have more free time than me, he can make this tuto himself.

It's not so easy, there are a lot of complex features to explain. I was naive at first, I thought I could finish it in 1 or 2 hours !

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sun Jan 11, 2015 21:40
by rubenwardy
Try spitting it into smaller chapters.
  • Mapgen - explain about the structure of map gen, flags
  • Biomes. (Done by Jordach)
  • Ores and Decoration.
  • Mapgen and LVM -Create lua Mapgen in single node using noise. Basic stuff.
It takes me 2 hours on average to make a chapter. 'Releasing a Mod' has taken the longest so far, at 3 hours.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Jan 12, 2015 06:17
by Gael de Sailly
rubenwardy wrote:It takes me 2 hours on average to make a chapter. 'Releasing a Mod' has taken the longest so far, at 3 hours.
Yes but I write it in French, and it will take me a lot of time to translatein English.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 24, 2015 19:07
by rubenwardy
Added Player Physics chapter

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Sat Jan 24, 2015 23:22
by Don
rubenwardy wrote:Added Player Physics chapter
+1
I have been busy but I am going to get back into studying. Thank you so much for your hard work. It will help me a lot.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Mon Jan 26, 2015 21:20
by Wuzzy
Wow!
I am seriously impressed by the documents so far. It's not really useful for me, however, because I already know most of that stuff. :D It is still unfinished so far, but I already have a first good impression.

I am happy to see a section about drawtypes. It was about time these things got documented. IMO this stuff is so important it should go into the dev wiki as well. The allfaces and allfaces_optional drawtype is poorly documented and the image does not match the description.
The nodebox section needs serious expansion, maybe some screenshots might help. I think a newbie might not find that section particulary useful. Same for torchlike, I find the torchlike example a bit too overwhelming (it uses animated tiles, a concept which should be taught somewhere else).
And please mind the correct casing. It's “torchlike”, not “Torchlike” or “TorchLike”.

But on the other hand, this section is incomplete anyways, so no reason to complain (yet). :P
Minetest 0.4.11 also introduced a couple of new drawtypes, like firelike and mesh and probably more, please don't forget to include them.

I really hope you manage to finish this!
I am looking forward to see the chapter about LuaVoxelManipulator, because this is one thing I still have trouble understanding. I know it is already on your to-do list, this is just my personal view here.
It is not the functions which confuse me, it is how these functions interact, also I like to know the underlying concepts and how to use the LuaVoxelManipulator efficiently. With some realistic examples and a few hints and tips added, this chapter would already be very good.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Wed Jan 28, 2015 23:56
by Evergreen
Once this is finished, I hope to see it go in the minetest source under the docs folder. This should be included with the source once it is complete, and it should be updated like lua_api.txt whenever there are changes.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Fri Jan 30, 2015 16:28
by ExeterDad
It's been awhile so I decided to visit your book again. I am very impressed with everything about it! Programmers rarely write documentation that typical folks can understand. And it's usually so dry interest is lost very quickly.
I know little of lua. But here and there I've hit a few tutorials attempting to learn. I've found myself confused trying to apply what I learned to Minetest. A quick glance of your book turned into me reading all that you've written thus far. Things really started clicking when I read your examples and explanations. I also learned many details I never noticed while pouring over the api many, many times.
Thank you for your efforts. They will benefit many more people aside from myself.

Re: Modding Tutorial Book - Creating Better Documentation

Posted: Wed Feb 04, 2015 20:38
by Fox
Gael de Sailly wrote:
rubenwardy wrote:It takes me 2 hours on average to make a chapter. 'Releasing a Mod' has taken the longest so far, at 3 hours.
Yes but I write it in French, and it will take me a lot of time to translatein English.
Gael de Sailly,

Feel free to share it in as little or big of chunks as you'd like. :) Doesn't have to be perfect. Some of what's up now seems to still be under construction.

Do whatever works for you though. I look forward to what comes of it. :) Thanks for your work on it so far.

Thanks to everyone for their work so far.