NMLTutorial/Installation - Revision history

Marenamat: /* Compiling NML yourself */ The NML repository has apparently moved from Mercurial to Git

2024-12-30T10:54:30Z

Compiling NML yourself: The NML repository has apparently moved from Mercurial to Git

← Older revision		Revision as of 10:54, 30 December 2024
Line 27:		Line 27:

	==== Compiling NML yourself ====		==== Compiling NML yourself ====
	The other option to get NML is to compile it yourself. First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/ or via ~~Mercurial checkout~~ from ~~http~~://hg.~~openttdcoop.org~~/nml (<code>hg clone <nowiki>~~http~~://hg.~~openttdcoop.org~~/nml</nowiki></code>).		The other option to get NML is to compile it yourself. First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/ or via Git from https://github.com/OpenTTD/nml (<code>git clone <nowiki>https://github.com/OpenTTD/nml</nowiki></code>).

	Also, this time, you need the terminal as superuser. Then change directory to the (extracted) NML source and run <code>python setup.py install</code>. For example:		Also, this time, you need the terminal as superuser. Then change directory to the (extracted) NML source and run <code>python setup.py install</code>. For example:

Athenarises: /* Using NML */

2024-10-26T08:03:41Z

Using NML

← Older revision		Revision as of 08:03, 26 October 2024
Line 61:		Line 61:

	=== Using NML ===		=== Using NML ===
			As said before, NML is a command-line program and therefore does not have a GUI; much like GRFCodec, in fact. That means you need to run it from a command prompt window. You can start the command prompt by pressing <code>CMD+Space</code> to open Spotlight, and searching for "Terminal".
	Please add a detailed explanation if you know how to do this.

			Next, you need to change directory to the project folder which has your NML (code) file in it. Then run the nmlc program to compile your GRF. For example:

			~
			cd /Users/user/grfs/mygrf
			nmlc -c --grf mygrf.grf mygrf.nml

			This will encode the nml file <code>/Users/user/grfs/mygrf.nml</code> into the GRF file <code>/Users/user/grfs/mygrf/mygrf.grf</code>. The <code>-c</code> option is not mandatory, but crops extraneous blue from sprites, reducing the filesize of the grf file. Note that if you have any spaces in a directory or file name, you need to enclose that complete path or filename in double quotes, e.g.: <code>cd "/Users/user/My Documents/mygrf"</code>. It is therefore recommended not to have any spaces.

	== Windows ==		== Windows ==

Ikarus: /* Installing NML */ Update to latest instructions

2024-03-03T18:55:02Z

Installing NML: Update to latest instructions

← Older revision		Revision as of 18:55, 3 March 2024
Line 51:		Line 51:

	=== Installing NML ===		=== Installing NML ===
	First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/.
⚫	After that, run these commands ~~as superuser.~~

			Make sure you have python version 3.4 or higher and pip installed, as well as Setuptools.
	cd ~/Downloads/nml-rXXXX
	python setup.py install

		⚫	After that, run these commands:
	Before running these commands, you need to install Python, PLY, Pillow, Setuptools.

			pip3 install ply
			pip3 install Pillow
			pip3 install nml

	=== Using NML ===		=== Using NML ===

Ikarus: Add link to VS Code syntax

2024-02-02T23:27:17Z

Add link to VS Code syntax

← Older revision		Revision as of 23:27, 2 February 2024
Line 172:		Line 172:
	Syntax highlighting adds some colour to NML code, which makes it easier to read.		Syntax highlighting adds some colour to NML code, which makes it easier to read.

	At the #openttdcoop DevZone there are syntax highlighter extensions available for [http://dev.openttdcoop.org/documents/24 Notepad++] and [http://dev.openttdcoop.org/documents/26 Geany]. If you want to create your own syntax highlighter, there is a [http://dev.openttdcoop.org/documents/25 script] available as well that will help you create the keyword lists.		At the #openttdcoop DevZone there are syntax highlighter extensions available for [https://marketplace.visualstudio.com/items?itemName=PNDA.nml-language VS Code], [http://dev.openttdcoop.org/documents/24 Notepad++] and [http://dev.openttdcoop.org/documents/26 Geany]. If you want to create your own syntax highlighter, there is a [http://dev.openttdcoop.org/documents/25 script] available as well that will help you create the keyword lists.

	{{NMLTutorialNavbar\|\|Graphic files}}		{{NMLTutorialNavbar\|\|Graphic files}}

Shuntaro at 09:37, 24 November 2023

2023-11-24T09:37:19Z

← Older revision		Revision as of 09:37, 24 November 2023
Line 57:		Line 57:
	python setup.py install		python setup.py install

			Before running these commands, you need to install Python, PLY, Pillow, Setuptools.

	=== Using NML ===		=== Using NML ===

Shuntaro at 09:20, 24 November 2023

2023-11-24T09:20:11Z

← Older revision		Revision as of 09:20, 24 November 2023
Line 52:		Line 52:
	=== Installing NML ===		=== Installing NML ===
	First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/.		First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/.
	After ~~getting the source~~, run ~~"make"~~ ~~command~~.		After that, run these commands as superuser.

			cd ~/Downloads/nml-rXXXX
			python setup.py install


	=== Using NML ===		=== Using NML ===

Shuntaro at 09:14, 24 November 2023

2023-11-24T09:14:22Z

← Older revision		Revision as of 09:14, 24 November 2023
Line 51:		Line 51:

	=== Installing NML ===		=== Installing NML ===
			First, you need to get the source from http://bundles.openttdcoop.org/nml/nightlies/LATEST/.
	Please add a detailed explanation if you know how to do this.
			After getting the source, run "make" command.

	=== Using NML ===		=== Using NML ===

Probablyidiot: Added visual studio code in the list of text editors.

2023-08-12T18:13:32Z

Added visual studio code in the list of text editors.

← Older revision		Revision as of 18:13, 12 August 2023
Line 152:		Line 152:
	; Cross-platform		; Cross-platform
	* [http://www.geany.org/ Geany]		* [http://www.geany.org/ Geany]
			* [https://code.visualstudio.com/ VS Code]
	; Linux		; Linux
	* [http://kate-editor.org/get-it/ Kate], vim		* [http://kate-editor.org/get-it/ Kate], vim

Donald duck: /* Text editor */ Added the text editor I use since it says I'm welcome to add it.

2021-03-02T18:36:44Z

Text editor: Added the text editor I use since it says I'm welcome to add it.

← Older revision		Revision as of 18:36, 2 March 2021
Line 158:		Line 158:
	; Windows		; Windows
	* [http://notepad-plus-plus.org/ Notepad++]		* [http://notepad-plus-plus.org/ Notepad++]
			* [https://www.sublimetext.com/ Sublime Text]

	If you use an editor which you think is quite good and not listed here, you are welcome to add it.		If you use an editor which you think is quite good and not listed here, you are welcome to add it.

Javelinnl: Updated the precompiled windows binaries location to Github page and made some changes to the instructions because python libraries are now integrated.

2020-12-24T23:30:53Z

Updated the precompiled windows binaries location to Github page and made some changes to the instructions because python libraries are now integrated.

← Older revision		Revision as of 23:30, 24 December 2020
Line 58:		Line 58:

	== Windows ==		== Windows ==
	NML is available as pre-built (32-bit) Windows executable from ~~the #openttdcoop DevZone~~, so there is no need to compile it yourself.		NML is available as pre-built (64-bit) Windows executable from Github, so there is no need to compile it yourself.

	=== Installing NML ===		=== Installing NML ===
			Go to https://github.com/OpenTTD/nml/releases to find the latest release, click on assets and download nml-standalone-XXXX-win64.zip
	~~Go to http://bundles.openttdcoop.org/nml/nightlies/LATEST/ and download nml-rXXXX-windows-win32.zip~~, replacing XXXX with the actual version number of the package. The ZIP file contains a number of files ~~that all need to stay together~~. Where these files go depends on whether you want to take the easy route or do it properly.		, replacing XXXX with the actual version number of the package. The ZIP file contains a number of files. Where these files go depends on whether you want to take the easy route or do it properly.

	==== Easy route ====		==== Easy route ====
	The easy route is to extract ~~all~~ the NML program ~~files~~ in the same directory as your NML project (where your file with the NML code and the directories with language and graphics files will go later). With this, you can use the NML program for this project alone. If you want to work on multiple NewGRF projects coded in NML, you need to copy the NML program ~~files~~ to each of these project directories.		The easy route is to extract the NML program file in the same directory as your NML project (where your file with the NML code and the directories with language and graphics files will go later). With this, you can use the NML program for this project alone. If you want to work on multiple NewGRF projects coded in NML, you need to copy the NML program file to each of these project directories.

	==== Proper route ====		==== Proper route ====
	If you want to run NML from any directory, you need to add the directory containing the nmlc.exe executable ~~(and related files)~~ to your PATH environment variable. This can break Windows if you do not do it correctly, so follow the instructions carefully.		If you want to run NML from any directory, you need to add the directory containing the nmlc.exe executable to your PATH environment variable. This can break Windows if you do not do it correctly, so follow the instructions carefully.

	First, extract the NML program ~~files~~ to a directory of your choice, e.g. C:\tools\NML. It is preferred that you do not have spaces in the directory path, so avoid the "Program Files" directory. Once you have that, remember the directory path and follow these steps carefully:		First, extract the NML program file to a directory of your choice, e.g. C:\tools\NML. It is preferred that you do not have spaces in the directory path, so avoid the "Program Files" directory. Once you have that, remember the directory path and follow these steps carefully:

	'''Windows 7 or earlier:'''		'''Windows 7 or earlier:'''