Modding Tutorial Book (new: Privileges)

leeminer
Member
 
Posts: 90
Joined: Mon Aug 11, 2014 21:29

Re: Modding Tutorial Book - Creating Better Documentation

by leeminer » Mon Dec 15, 2014 03:53

Don wrote:I don't mean this to be rude but maybe start a new topic to debate the best code. This is a thread about the book. Let's discuss the content of the book. I think Rubenwardy could use help.



I've been reviewing the doc and giving feedback. Always helps to have others look at it from another angle.

I think Rubenwardy is looking for translators eventually. Sadly my Spanish and French is dismal :(
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Dec 15, 2014 20:18

Added a ( (very) short) chapter on ABMs. I will probably write a chapter on node drawtypes next. That's probably the next important thing. I'm also going to draw up a long list of what should be in there, and logically organise it for the best teaching experience.

I don't need it to be translated yet, it is currently quite unstable (it changes a lot).
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Dec 15, 2014 21:37

An explanation of why you need to do things would be nice. For example in your formspec chapter you have

minetest.show_formspec(playername, formname, formspec)

If you could explain it like this;

you need minetest because it tells the engine where to get the info
show_formspec tells engine to show the formspec that you specify below
playername is need for...
etc

This is one of the things that confused me at first. I am not sure if the info above is correct or not. As someone who does not know programming and just wants to make mods this type of info is important. I don't think you would have to do it for everything but if you explain some of it then with a little logic the rest could be figured out.
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: 1641
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Dec 15, 2014 21:38

Another idea might be itemstack and how it works.

EDIT - forgot to say that you are doing a great job! Thanks
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: 1641
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Dec 15, 2014 21:45

Another idea is what different symbols do
Examples

== means is equal too
~= means is not equal too
-- means a comment and is not read by the engine. It is for 1 line only
--[[ ]] means a block comment for more than 1 line
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
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Dec 15, 2014 22:15

I don't want to do a programming tutorial, that is beyond the scope of the book. I will search for a nice tutorial on Lua. Short.

Hoodedice is creating a getting started chapter which will be a much easier entry point.
 

User avatar
philipbenr
Member
 
Posts: 1665
Joined: Fri Jun 14, 2013 01:56
GitHub: philipbenr
IRC: philipbenr
In-game: WisdomFire or philipbenr

Re: Modding Tutorial Book - Creating Better Documentation

by philipbenr » Mon Dec 15, 2014 22:18

@Don: That is something I might get into. The tutorials want to do will include videos as well.
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Mon Dec 15, 2014 22:29

@ rubenwardy - I am throwing ideas out there simply because I am trying to learn and these are things that I got stuck on. Thought it might help to get the perspecive of someone that wants to learn how to mod.

@ philipbenr - That it awesome. Videos will be a big help too.
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
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Tue Dec 16, 2014 07:57

the Minetest namespace, ie minetest.*, will be explained in the first chapter, and itemstacks is a planned chapter. I didn't intend to sound like I was rejecting your ideas.

As for videos, they take a lot of effort to get to the same quality, although they are better at communicating harder things that would need a huge and confusing list in a tutorial if done right. Good luck.
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Tue Dec 16, 2014 13:35

rubenwardy wrote:the Minetest namespace, ie minetest.*, will be explained in the first chapter, and itemstacks is a planned chapter. I didn't intend to sound like I was rejecting your ideas.

As for videos, they take a lot of effort to get to the same quality, although they are better at communicating harder things that would need a huge and confusing list in a tutorial if done right. Good luck.

I took no offence. I was just letting you know why I was giving ideas. As someone who knows almost nothing about programing I know some of my ideas will be rejected or considered dumb.
Keep up the good work
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
 

leeminer
Member
 
Posts: 90
Joined: Mon Aug 11, 2014 21:29

Re: Modding Tutorial Book - Creating Better Documentation

by leeminer » Tue Dec 16, 2014 15:08

Don wrote:
rubenwardy wrote:the Minetest namespace, ie minetest.*, will be explained in the first chapter, and itemstacks is a planned chapter. I didn't intend to sound like I was rejecting your ideas.

As for videos, they take a lot of effort to get to the same quality, although they are better at communicating harder things that would need a huge and confusing list in a tutorial if done right. Good luck.

I took no offence. I was just letting you know why I was giving ideas. As someone who knows almost nothing about programing I know some of my ideas will be rejected or considered dumb.
Keep up the good work



Find a good tutorial for OOP programming. I think it would benefit you. One I liked was How to think like a computer scientist.

http://www.greenteapress.com/thinkpython/

It would be very difficult to understand modding without this sort of knowledge. For LUA, not sure what the best resource is. I've only scratched the surface on Lua. Perhaps someone could point us both in a good direction for that.

Anyway on with the ON TOPIC discussion ;)
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Tue Dec 16, 2014 15:43

Thanks. After 5 minutes reading I have already learned a few things. I love the open source community. In a world of greed, open source proves that humanity still exists.
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
Gael de Sailly
Member
 
Posts: 475
Joined: Sun Jan 26, 2014 17:01
GitHub: Gael-de-Sailly
IRC: Gael-de-Sailly
In-game: Gael-de-Sailly

Re: Modding Tutorial Book - Creating Better Documentation

by Gael de Sailly » Wed Dec 17, 2014 14:15

Is it possible to make a feature to change the language ?
I could translate it into French.

I really like the project. I've already thought about writing a tuto in French.
I think it's really what we lack : a good documentation in others languages than English.
Very busy this year too, so do not expect me to be very active on the forum or in game. But I'm not about to drop Minetest forever :)
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Wed Dec 17, 2014 15:52

Do you mean computer langauges? You could use a language interpreter written in Lua. Or you can add a new langauge to the core code. But the forner is slow and the latter won't be merged into Minetest, the core devs won't like it. You could use a language like moon script, I think it is called, to translate into Lua.

Or do you mean tutorial language? That's fairly easy, but requires restructuring of files.
 

User avatar
Evergreen
Member
 
Posts: 2131
Joined: Sun Jan 06, 2013 01:22
GitHub: 4Evergreen4
IRC: EvergreenTree
In-game: Evergreen

Re: Modding Tutorial Book - Creating Better Documentation

by Evergreen » Wed Dec 17, 2014 19:52

rubenwardy wrote:Do you mean computer langauges? You could use a language interpreter written in Lua. Or you can add a new langauge to the core code. But the forner is slow and the latter won't be merged into Minetest, the core devs won't like it. You could use a language like moon script, I think it is called, to translate into Lua.

Or do you mean tutorial language? That's fairly easy, but requires restructuring of files.

Rubenwardy, he means translate to another real world language (eg. French)
"Help! I searched for a mod but I couldn't find it!"
http://krock-works.16mb.com/MTstuff/modSearch.php
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Wed Dec 17, 2014 19:53

Okay. So the latter. I won't accept any translations at the moment, as the chapters are too volatile - they will probably be edited for quite a while before they reach a fixed state.
 

User avatar
Gael de Sailly
Member
 
Posts: 475
Joined: Sun Jan 26, 2014 17:01
GitHub: Gael-de-Sailly
IRC: Gael-de-Sailly
In-game: Gael-de-Sailly

Re: Modding Tutorial Book - Creating Better Documentation

by Gael de Sailly » Fri Dec 19, 2014 20:08

I could also contribute to the project, especially about mapgen.

There are the 4 basics chapters, I think we can add more specialized chapters on more complex features (entities, mapgen, treegen, metadata, schematics, …).
I will have a lot of free time the next 2 weeks.
Very busy this year too, so do not expect me to be very active on the forum or in game. But I'm not about to drop Minetest forever :)
 

grey
Member
 
Posts: 19
Joined: Fri Jan 03, 2014 18:51

Re: Modding Tutorial Book - Creating Better Documentation

by grey » Sun Dec 28, 2014 01:52

This would be so amazing.
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Sun Dec 28, 2014 20:16

No more linking to line numbers with the risk of them changing.

lua_api.html
 

leeminer
Member
 
Posts: 90
Joined: Mon Aug 11, 2014 21:29

Re: Modding Tutorial Book - Creating Better Documentation

by leeminer » Mon Dec 29, 2014 13:13

Wow, there is a lot of content here now! Everybody look at this so far.
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Dec 29, 2014 13:43

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.
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Dec 29, 2014 19:41

Added a Node Drawtype chapter. It isn't complete yet, some are missing.

Node Drawtypes
 

User avatar
TG-MyinaWD
Member
 
Posts: 355
Joined: Thu May 08, 2014 21:22
GitHub: Maddie-Myina
IRC: Maddie-Myina
In-game: .

Re: Modding Tutorial Book - Creating Better Documentation

by TG-MyinaWD » Mon Dec 29, 2014 20:05

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.
I'm a Transgender no shame about it.
I prefer to be considered as a "Girl/Lady/Miss/Madam/Female" for now on.
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Mon Dec 29, 2014 20:11

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.
 

MrNomNom111
New member
 
Posts: 6
Joined: Sun Nov 30, 2014 10:36
GitHub: Modjular

Re: Modding Tutorial Book - Creating Better Documentation

by MrNomNom111 » Tue Dec 30, 2014 15:59

Thanks so much for the time you put into these resources. These help immensely!
 

MrNomNom111
New member
 
Posts: 6
Joined: Sun Nov 30, 2014 10:36
GitHub: Modjular

Re: Modding Tutorial Book - Creating Better Documentation

by MrNomNom111 » Tue Dec 30, 2014 16:06

How do I contact you to contribute? I would love to help
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Tue Dec 30, 2014 16:42

Send emails to me at rubenwardy on gmail.com
<-- Or PM me.

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

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: Modding Tutorial Book - Creating Better Documentation

by rubenwardy » Thu Jan 01, 2015 17:45

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.
 

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

Re: Modding Tutorial Book - Creating Better Documentation

by Don » Thu Jan 01, 2015 22:27

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!
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
Linuxdirk
Member
 
Posts: 497
Joined: Wed Sep 17, 2014 11:21
GitHub: dsohler
In-game: Linuxdirk

Re: Modding Tutorial Book - Creating Better Documentation

by Linuxdirk » Thu Jan 01, 2015 22:47

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 :)
 

PreviousNext

Return to Minetest-Related

Who is online

Users browsing this forum: No registered users and 25 guests

cron