NML:Getting started - Revision history

Andythenorth: /* pip */

2022-02-25T10:44:28Z

pip

← Older revision		Revision as of 10:44, 25 February 2022
Line 8:		Line 8:
	If you are familiar with python and pip then you can just use		If you are familiar with python and pip then you can just use
	pip-3.2 install nml		pip-3.2 install nml
	This will install the required ~~dependancies~~. Note that you may need administrator privileges for this to work.		This will install the required dependencies. Note that you may need administrator privileges for this to work.

	=== Windows ===		=== Windows ===

Andythenorth: /* Windows */

2022-02-25T10:44:01Z

Windows

← Older revision		Revision as of 10:44, 25 February 2022
Line 11:		Line 11:

	=== Windows ===		=== Windows ===
	Windows users can install the [~~http~~://~~bundles~~.~~openttdcoop.org~~/nml/~~nightlies/LATEST~~/ windows binary] which contains a binary which bundles (most) required libraries.		Windows users can install the [https://github.com/OpenTTD/nml/tags/ windows binary] which contains a binary which bundles (most) required libraries.

	If execution fails due to missing MSVCR libraries or due to an invalid application configuration or similar error, you need to install [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 this package from Microsoft].		If execution fails due to missing MSVCR libraries or due to an invalid application configuration or similar error, you need to install [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 this package from Microsoft].

Andythenorth: /* macOS */

2022-02-25T10:43:34Z

macOS

← Older revision		Revision as of 10:43, 25 February 2022
Line 40:		Line 40:

	=== macOS ===		=== macOS ===
	macOS users have two choices: install the dependencies manually as described in the Linux section above, for use with the python version that ships with ~~OS X~~. Or install everything from brew or macports, including a new python version (using brew or macports eases upgrading). Using a python virtualenv for nml is optional, but recommended.		macOS users have two choices: install the dependencies manually as described in the Linux section above, for use with the python version that ships with macOS. Or install everything from brew or macports, including a new python version (using brew or macports eases upgrading). Using a python virtualenv for nml is optional, but recommended.

	=== Installing manually (any system) ===		=== Installing manually (any system) ===

Andythenorth: /* macOS */

2022-02-25T10:43:19Z

macOS

← Older revision		Revision as of 10:43, 25 February 2022
Line 39:		Line 39:
	sudo /usr/bin/pip-3.2 install pillow		sudo /usr/bin/pip-3.2 install pillow

	=== ~~OSX~~ ===		=== macOS ===
	~~OS X~~ users have two choices: install the dependencies manually as described in the Linux section above, for use with the python version that ships with OS X. Or install everything from macports, including a new python version (using macports eases upgrading). ~~However~~ ~~using~~ ~~macports~~ ~~to install the dependencies~~ for ~~the bundled system python~~ is ~~likely~~ to ~~fail~~.		macOS users have two choices: install the dependencies manually as described in the Linux section above, for use with the python version that ships with OS X. Or install everything from brew or macports, including a new python version (using brew or macports eases upgrading). Using a python virtualenv for nml is optional, but recommended.

	=== Installing manually (any system) ===		=== Installing manually (any system) ===

Erato: NML moved to github

2021-03-13T21:37:31Z

NML moved to github

← Older revision		Revision as of 21:37, 13 March 2021
Line 29:		Line 29:
	** downloadable from http://www.dabeaz.com/ply/		** downloadable from http://www.dabeaz.com/ply/
	* '''NML itself'''		* '''NML itself'''
	** the latest (nightly) build can be downloaded from ~~http~~://~~bundles~~.~~openttdcoop.org~~/nml/~~push/LATEST/~~		** the latest (nightly) build can be downloaded from https://github.com/OpenTTD/nml/tags

	If you don't install these with the packet manager of your choice (or there is none like on windows and you don't use the pre-compiled binary file), you should install these libraries as well as NML itself using <code style="color:darkgreen">python setup.py install</code> from your command prompt.		If you don't install these with the packet manager of your choice (or there is none like on windows and you don't use the pre-compiled binary file), you should install these libraries as well as NML itself using <code style="color:darkgreen">python setup.py install</code> from your command prompt.

Frosch: package name is python3-pip

2015-04-11T12:16:40Z

package name is python3-pip

← Older revision		Revision as of 12:16, 11 April 2015
Line 7:		Line 7:
	=== pip ===		=== pip ===
	If you are familiar with python and pip then you can just use		If you are familiar with python and pip then you can just use
	pip install nml		pip-3.2 install nml
	This will install the required dependancies. Note that you may need administrator privileges for this to work.		This will install the required dependancies. Note that you may need administrator privileges for this to work.

Line 36:		Line 36:
	sudo apt-get install python3		sudo apt-get install python3
	sudo apt-get install python3-ply		sudo apt-get install python3-ply
	sudo apt-get install pip		sudo apt-get install python3-pip
	sudo /usr/bin/pip-3.2 install pillow		sudo /usr/bin/pip-3.2 install pillow

Line 88:		Line 88:
	Now, that you have installed ply and pil, then you can install NML from the unpacked nml directory:		Now, that you have installed ply and pil, then you can install NML from the unpacked nml directory:
	sudo python setup.py install		sudo python setup.py install



	== Testing the installation ==		== Testing the installation ==

Planetmaker: /* Syntax highlighting */ Update links

2015-04-11T07:35:39Z

Syntax highlighting: Update links

← Older revision		Revision as of 07:35, 11 April 2015
Line 149:		Line 149:

	== Syntax highlighting ==		== Syntax highlighting ==
	For ~~a few~~ editors ~~there~~ ~~exist~~ syntax highlighting ~~rules,~~ ~~see~~ ~~the~~ ~~[http://dev.openttdcoop.org/projects/home/documents~~ ~~DevZone~~ ~~documents]~~ ~~for~~ ~~details.~~		For some editors a matching syntax highlighting file is generated for each build of NML:

	There are rules for
		⚫	* [http://bundles.openttdcoop.org/nml/push/LATEST/nml_notepadpp.xml Notepad++]
		⚫	* [http://bundles.openttdcoop.org/nml/push/LATEST/nml_kate.xml Kate]

			For a few editors there exist syntax highlighting rules, made at a certain point, see the [http://dev.openttdcoop.org/projects/home/documents DevZone documents] for details. These files might be more or less outdated and not support the full syntax of NML:
	* [http://dev.openttdcoop.org/documents/26 Geany]		* [http://dev.openttdcoop.org/documents/26 Geany]
			Please make available to us any updates you might have made. If you want the highlighting files automatically generated for your editor, we'll happily accept patches. See [https://hg.openttdcoop.org/nml/files/tip/nml/editors here] for the existing generation scripts.
⚫	* [http://~~dev~~.openttdcoop.org/~~documents~~/24 Notepad++]
⚫	* [http://~~dev~~.openttdcoop.org/~~documents~~/38 Kate]

Planetmaker: /* Windows */ some hint on python 32bit vs 64 bit

2015-04-11T07:26:37Z

Windows: some hint on python 32bit vs 64 bit

← Older revision		Revision as of 07:26, 11 April 2015
Line 14:		Line 14:

	If execution fails due to missing MSVCR libraries or due to an invalid application configuration or similar error, you need to install [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 this package from Microsoft].		If execution fails due to missing MSVCR libraries or due to an invalid application configuration or similar error, you need to install [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 this package from Microsoft].


			If you go for a python install and the packages themselves (e.g. mingw or msys) instead of the pre-compiled binary: Apparently you can prevent a lot of problems by installing the 32bit version of python, even if you have a 64bit windows installation. Installing PIL might be troublesome if you do install the 64bit version of python.

	=== Linux ===		=== Linux ===

Planetmaker: /* Linux */ rework linux instructions slightly

2015-04-11T07:25:08Z

Linux: rework linux instructions slightly

← Older revision		Revision as of 07:25, 11 April 2015
Line 19:		Line 19:

	* '''python'''		* '''python'''
		⚫	** python 3.2 or newer (for nightly builds or NML 0.4.0 or newer, earlier versions require python 2.6 or 2.7)
	** any version from 2.6 through 2.7 will do, but not 3.x (NML 0.3.x or older)
⚫	** python 3.2 or newer (nightly builds or NML 0.4.0 or newer)
	** downloadable from from http://www.python.org/)		** downloadable from from http://www.python.org/)
	** Advise for windows users: apparently you can prevent a lot of problems by installing the 32bit version of python, even if you have a 64bit windows installation. Installing PIL might be troublesome if you do install the 64bit version of python.
	* '''python image library'''		* '''python image library'''
	** downloadable from https://pypi.python.org/pypi/Pillow/		** downloadable from https://pypi.python.org/pypi/Pillow/
Line 31:		Line 29:

	If you don't install these with the packet manager of your choice (or there is none like on windows and you don't use the pre-compiled binary file), you should install these libraries as well as NML itself using <code style="color:darkgreen">python setup.py install</code> from your command prompt.		If you don't install these with the packet manager of your choice (or there is none like on windows and you don't use the pre-compiled binary file), you should install these libraries as well as NML itself using <code style="color:darkgreen">python setup.py install</code> from your command prompt.

			For debian or ubunutu you might try to use pip for PIL/pillow when it is not in the package manager for python3:
			sudo apt-get install python3
			sudo apt-get install python3-ply
			sudo apt-get install pip
			sudo /usr/bin/pip-3.2 install pillow

	=== OSX ===		=== OSX ===

Frosch: alternative error message

2015-01-04T19:11:11Z

alternative error message

← Older revision		Revision as of 19:11, 4 January 2015
Line 13:		Line 13:
	Windows users can install the [http://bundles.openttdcoop.org/nml/nightlies/LATEST/ windows binary] which contains a binary which bundles (most) required libraries.		Windows users can install the [http://bundles.openttdcoop.org/nml/nightlies/LATEST/ windows binary] which contains a binary which bundles (most) required libraries.

	If execution fails due to missing MSVCR libraries or similar, you ~~can~~ ~~get~~ ~~them~~ [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 ~~here~~ from Microsoft].		If execution fails due to missing MSVCR libraries or due to an invalid application configuration or similar error, you need to install [http://www.microsoft.com/en-gb/download/details.aspx?id=5555 this package from Microsoft].

	=== Linux ===		=== Linux ===