NMLTutorial - Revision history

FooBar: /* Image format support */ note on graphicstutorial

2011-08-28T21:08:04Z

Image format support: note on graphicstutorial

← Older revision		Revision as of 21:08, 28 August 2011
Line 28:		Line 28:
	NML supports every paletted image file supported by the Python Image Library. NFO (or rather GRFCodec) only supports PCX and PNG files. As the PNG image format is the recommended format for both methods of NewGRF creation, this can hardly be considered an advantage on the part of NML.		NML supports every paletted image file supported by the Python Image Library. NFO (or rather GRFCodec) only supports PCX and PNG files. As the PNG image format is the recommended format for both methods of NewGRF creation, this can hardly be considered an advantage on the part of NML.

	Graphic files used with NML or NFO code are in principle identical, so for graphic artists there is no difference when making a choice between NML or NFO.		Graphic files used with NML or NFO code are in principle identical, so for graphic artists there is no difference when making a choice between NML or NFO. How to draw graphics is not covered here, but in the [[GraphicsTutorial]].

	===Example===		===Example===

FooBar: sweeten the difference between NFO and NML a bit more in favour of NML

2011-08-28T19:26:27Z

sweeten the difference between NFO and NML a bit more in favour of NML

Show changes

FooBar: tutorial is not really under construction any more; some last bits need doing, but the majority is really usable

2011-08-27T22:00:58Z

tutorial is not really under construction any more; some last bits need doing, but the majority is really usable

← Older revision		Revision as of 22:00, 27 August 2011
Line 1:		Line 1:
	{{NMLTutorial}}		{{NMLTutorial}}

		⚫	Since June 2010 a new coding language for creating TTDpatch/OpenTTD GRF's exists: the NewGRF Meta Language or NML for short. It differs significantly from the old way of writing NewGRFs in NFO and although [http://newgrf-specs.tt-wiki.net/wiki/NML:Main documentation] is available it may still be a challenge for people interested in using NML code. After all NML is still a form of programming language and not a GUI-based editor.
	==Introduction==

⚫	Since ~~june~~ 2010 a new coding language for creating TTDpatch/OpenTTD GRF's exists: ~~Newgrf~~ Meta Language or NML. It differs significantly from the old way of ~~GRF~~ ~~editing~~ and although [http://newgrf-specs.tt-wiki.net/wiki/NML:Main documentation] is available it may still be a challenge for people interested in using NML code. After all NML is still a form of programming language and not a GUI-based editor.
			The NML tutorial aims at providing entry-level instructions and examples of how coding in NML works and hopefully inspires people who previously thought making a NewGRF themselves was impossible to give NML a whirl.

	There will be detailed examples of how coding in NML works on this new TT-wiki. Make sure to check the progress of this NML tutorial regularly.

	==NML vs. NFO==		==NML vs. NFO==

Planetmaker: slightly update language comparison

2011-08-22T19:18:24Z

slightly update language comparison

← Older revision		Revision as of 19:18, 22 August 2011
Line 11:		Line 11:

	===Language support===		===Language support===
	NML provides easy support for different languages in one GRF. This is achieved by creating language files (~~LNG~~). These language files follow the convention used for OpenTTD translation files. When compiling NML files a search for language files will automatically be performed. Even without providing additional translations at least one language file must be specified, called default.lng.		NML provides easy support for different languages in one GRF. This is achieved by creating language files (lng). These language files follow the convention used for OpenTTD translation files. When compiling NML files a search for language files will automatically be performed. Even without providing additional translations at least one language file must be specified, called default.lng.

	===Image format support===		===Image format support===
	One of the conveniences of NML is the possibility to read ~~other~~ image formats~~, most notably [http://en.wikipedia.org/wiki/Portable_Network_Graphics PNG]~~. Remember though that those images still need to supply the proper 8bpp palette and are supported by the python image library.		One of the conveniences of NML is the possibility to read various image formats. Remember though that those images still need to supply the proper 8bpp palette and are supported by the python image library.

	===Example===		===Example===
Line 25:		Line 25:
	<font size="3">'''NFO code snippet'''</font>		<font size="3">'''NFO code snippet'''</font>
	:// Automatically generated by GRFCODEC. Do not modify!		:// Automatically generated by GRFCODEC. Do not modify!
	:// (Info version 7)
	:// Escapes: 2+ = 71 = D= = DR 2- = 70 = D+ = DF 2< = 7= = D- = DC 2> = 7! = Du* = DM 2u< = 7< = D* = DnF 2u> = 7> = Du<< = DnC
	:2/ = 7G = D<< = DO 2% = 7g = D& 2u/ = 7gG = D\| 2u% = 7GG = Du/ 2* = 7gg = D/ 2& = 7c = Du% 2\| = 7C = D% 2^ 2sto = 2s 2rst = 2r 2+ 2ror = 2rot
	:// Format: spritenum pcxfile xpos ypos compression ysize xsize xrel yrel

	:0 * 4 \d416		:0 * 4 \d416

FooBar: note on how to read the tutorial and navbar

2011-08-22T18:35:13Z

note on how to read the tutorial and navbar

@@ Line 44: / Line 44: @@
 :STR_GRF_DESCRIPTION                                             :Swedish rails are a replacement for the default rails
 |}
 [[Category:NML]][[Category:Tutorials]]

FooBar: Add nav template

2011-08-22T11:18:16Z

Add nav template

← Older revision		Revision as of 11:18, 22 August 2011
Line 1:		Line 1:
			{{NMLTutorial}}
	__TOC__

	==Introduction==		==Introduction==

FooBar: update link to documentation

2011-08-21T18:37:17Z

update link to documentation

← Older revision		Revision as of 18:37, 21 August 2011
Line 2:		Line 2:

	==Introduction==		==Introduction==
	Since june 2010 a new coding language for creating TTDpatch/OpenTTD GRF's exists: Newgrf Meta Language or NML. It differs significantly from the old way of GRF editing and although [http://hg.~~openttdcoop~~.~~org~~/~~nml/raw-file~~/~~tip/docs/index.html~~ documentation] is available it may still be a challenge for people interested in using NML code.		Since june 2010 a new coding language for creating TTDpatch/OpenTTD GRF's exists: Newgrf Meta Language or NML. It differs significantly from the old way of GRF editing and although [http://newgrf-specs.tt-wiki.net/wiki/NML:Main documentation] is available it may still be a challenge for people interested in using NML code. After all NML is still a form of programming language and not a GUI-based editor.

	There will be detailed examples of how coding in NML works on this new TT-wiki. Make sure to check the progress of this NML tutorial regularly.		There will be detailed examples of how coding in NML works on this new TT-wiki. Make sure to check the progress of this NML tutorial regularly.
Line 39:		Line 39:
	::desc : string(STR_GRF_DESCRIPTION);		::desc : string(STR_GRF_DESCRIPTION);
	:}		:}
	<font size="3">'''NML ~~laguage~~ file snippet'''</font>		<font size="3">'''NML language file snippet'''</font>
	:<nowiki>##</nowiki>grflangid 0x01		:<nowiki>##</nowiki>grflangid 0x01
	:STR_GRF_NAME :Swedish Rails {VERSION}		:STR_GRF_NAME :Swedish Rails {VERSION}

Yexo: /* Example */

2011-06-21T20:11:40Z

Example

← Older revision		Revision as of 20:11, 21 June 2011
Line 40:		Line 40:
	:}		:}
	<font size="3">'''NML laguage file snippet'''</font>		<font size="3">'''NML laguage file snippet'''</font>
			:<nowiki>##</nowiki>grflangid 0x01
	:lang: 7F
	:STR_GRF_NAME :Swedish Rails {VERSION}		:STR_GRF_NAME :Swedish Rails {VERSION}
	:STR_GRF_DESCRIPTION :Swedish rails are a replacement for the default rails		:STR_GRF_DESCRIPTION :Swedish rails are a replacement for the default rails

Hyronymus: Fixed missing code

2011-06-21T18:24:41Z

Fixed missing code

← Older revision		Revision as of 18:24, 21 June 2011
Line 42:		Line 42:
	:lang: 7F		:lang: 7F
	:STR_GRF_NAME :Swedish Rails {VERSION}		:STR_GRF_NAME :Swedish Rails {VERSION}
			:STR_GRF_DESCRIPTION :Swedish rails are a replacement for the default rails
	:STR_GRF_DESCRIPTION
	\|}		\|}
	[[Category:NML]][[Category:Tutorials]]		[[Category:NML]][[Category:Tutorials]]

Hyronymus: Expanded the NML vs. NFO stub

2011-06-21T18:23:34Z

Expanded the NML vs. NFO stub

@@ Line 7: / Line 7: @@
 ==NML vs. NFO==
 |- valign="top"
@@ Line 36: / Line 44: @@
 :STR_GRF_DESCRIPTION
 |}
 [[Category:NML]][[Category:Tutorials]]