Spring - User contributions [en]

User:Andrej/Building Spring on Windows 2 temp

2013-12-03T15:13:30Z

Andrej: CMake issue resolved at Spring side, version juggling no longer necessary

= Source Code GIT URLs =
Modified Spring github URL: <code>https://github.com/nOOb3167/spring/tree/develop</code><br/>
Modified vclibs11 github URL: <code>https://github.com/nOOb3167/vclibs11/</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be set to where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be set to whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to change CMAKE_INSTALL_PREFIX from the default path
(Program Files, requiring admin access), the installation step will complain.

User:Andrej/Building Spring on Windows 2 temp

2013-12-03T07:59:17Z

Andrej: Update CMake note after having investigated the issue

= Source Code GIT URLs =
Modified Spring github URL: <code>https://github.com/nOOb3167/spring/tree/develop</code><br/>
Modified vclibs11 github URL: <code>https://github.com/nOOb3167/vclibs11/</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

The newest release of CMake at time of writing, 2.8.12.1, introduces a regression that breaks Spring's use of some obscure CMake construct. It therefore can not be used to Configure Spring. (I've reported the issue to CMake bug tracker: http://www.cmake.org/Bug/view.php?id=14619 )

The recommended CMake release is version 2.8.11.1. (Search for cmake-2.8.11.1-win32-x86.exe on the CMake download site: http://www.cmake.org/files/v2.8/ )

[[image:Spring_build_cmake05.png|200px]]

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be set to where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be set to whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to change CMAKE_INSTALL_PREFIX from the default path
(Program Files, requiring admin access), the installation step will complain.

User:Andrej/Building Spring on Windows 2 temp

2013-11-21T05:13:51Z

Andrej: Link directly to develop branch instead of master

= Source Code GIT URLs =
Modified Spring github URL: <code>https://github.com/nOOb3167/spring/tree/develop</code><br/>
Modified vclibs11 github URL: <code>https://github.com/nOOb3167/vclibs11/</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

I (Andrej) use version 2.8.11.1. Search for cmake-2.8.11.1-win32-x86.exe on the CMake download site: http://www.cmake.org/files/v2.8/

The newest release, 2.8.12.1, fails - If you already have the newest version , and are getting errors during CMake configure step, try an older release.

[[image:Spring_build_cmake05.png|200px]]

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be set to where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be set to whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to change CMAKE_INSTALL_PREFIX from the default path
(Program Files, requiring admin access), the installation step will complain.

User:Andrej/Building Spring on Windows 2 temp

2013-11-21T02:56:18Z

Andrej:

= Source Code GIT URLs =
Modified Spring github URL: <code>https://github.com/nOOb3167/spring/</code><br/>
Modified vclibs11 github URL: <code>https://github.com/nOOb3167/vclibs11/</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

I (Andrej) use version 2.8.11.1. Search for cmake-2.8.11.1-win32-x86.exe on the CMake download site: http://www.cmake.org/files/v2.8/

The newest release, 2.8.12.1, fails - If you already have the newest version , and are getting errors during CMake configure step, try an older release.

[[image:Spring_build_cmake05.png|200px]]

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be set to where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be set to whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to change CMAKE_INSTALL_PREFIX from the default path
(Program Files, requiring admin access), the installation step will complain.

User:Andrej/Building Spring on Windows 2 temp

2013-11-21T02:44:18Z

Andrej:

= Source Code GIT URLs =
Spring repo URI: <code>git://github.com/nOOb3167/spring.git</code><br/>
vclibs11 repo URI: <code>git://github.com/nOOb3167/vclibs11.git</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

I (Andrej) use version 2.8.11.1. Search for cmake-2.8.11.1-win32-x86.exe on the CMake download site: http://www.cmake.org/files/v2.8/

The newest release, 2.8.12.1, fails - If you already have the newest version , and are getting errors during CMake configure step, try an older release.

[[image:Spring_build_cmake05.png|200px]]

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be set to where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be set to whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to change CMAKE_INSTALL_PREFIX from the default path
(Program Files, requiring admin access), the installation step will complain.

User:Andrej/Building Spring on Windows 2 temp

2013-11-21T02:40:15Z

Andrej: Created page with "= Source Code GIT URLs = Spring repo URI: <code>git://github.com/nOOb3167/spring.git</code><br/> vclibs11 repo URI: <code>git://github.com/nOOb3167/vclibs11.git</code><br/> ..."

= Source Code GIT URLs =
Spring repo URI: <code>git://github.com/nOOb3167/spring.git</code><br/>
vclibs11 repo URI: <code>git://github.com/nOOb3167/vclibs11.git</code><br/>

= Prerequisites =

- Visual Studio 2012 (v11)

- Microsoft Visual C++ Compiler Nov 2012 CTP

Download link: http://www.microsoft.com/en-us/download/details.aspx?id=35515

How to tell if you have Nov 2012 CTP installed:
Start Visual Studio and open any Solution. Open the 'Property Pages' of any Project inside this solution, and check available values of 'Platform Toolset' under 'Configuration Properties -> General'. Nov 2012 CTP should be listed.

[[image:Spring_build_cmake09.png|500px]]

- GIT

If you can open command line and run git you should be fine.

[[image:Spring_build_cmake08.png|300px]]

- CMake

I (Andrej) use version 2.8.11.1. Search for cmake-2.8.11.1-win32-x86.exe on the CMake download site: http://www.cmake.org/files/v2.8/

The newest release, 2.8.12.1, fails - If you already have the newest version , and are getting errors during CMake configure step, try an older release.

[[image:Spring_build_cmake05.png|200px]]

= Building =

First clone the git repositories.

Second configure through CMake.

Third compile through Visual Studio.

== Cloning the git repositories ==
- Spring into any directory.
- vclibs11 into subdirectory of Spring, named 'vclibs'

<code><pre>
cd someEmptyDirectory
git clone git://github.com/nOOb3167/spring.git
cd spring
git clone git://github.com/nOOb3167/vclibs11.git vclibs
</pre></code>

- This is the only command line step.
The directory structure should end up looking like below.
A 'spring' directory with spring source, and a 'vclibs' subdirectory
inside.

[[image:Spring_build_cmake07.png|700px]]

== Configuring through CMake ==
Start CMake GUI.
- There should be a start menu shortcut if you used the CMake installer.

[[image:Spring_build_cmake10.png|150px]]

Set Source and Build paths.
- Source path should be where you cloned the Spring repository.
You should find a file CMakeLists.txt in that directory
- Build path can be whatever empty directory, or just same as Source path.
On the screenshot below, Build path is set to a subdirectory named 'Build'.

[[image:Spring_build_cmake00.png|700px]]

Set CMAKE_INSTALL_PREFIX to where you want Spring installed.
- This is necessary because the default, Program Files, requires
admin permissions to write.

[[image:Spring_build_cmake01.png|700px]]

Press Configure.
- The correct option to select for compiler is as shown below.
(Should be the default)

[[image:Spring_build_cmake02.png|200px]]

- For comparison, here is what is output for me after Configure.
The warnings shown here are normal / expected.

[[image:Spring_build_cmake03.png|700px]]

Press Generate.
- This should generate the Visual Studio solution and project files.
Those will be used to compile through Visual Studio next.

== Compiling Solution through Visual Studio ==

Open the solution file.
- There should be a Spring.sln file, in the location you set as the Build path CMake.

[[image:Spring_build_cmake04.png|300px]]

Select the INSTALL Project.
- Unfortunately I have not found a way to do this automatically.

[[image:Spring_build_cmake06.png|300px]]

Build Project
- There should be no compile / link errors (But many warnings).
If you forgot to set CMAKE_INSTALL_PREFIX from the default path
(In Program Files, requiring admin access), the installation step will complain.

File:Spring build cmake10.png

2013-11-21T02:33:42Z

Andrej:

File:Spring build cmake09.png

2013-11-21T02:25:27Z

Andrej:

File:Spring build cmake08.png

2013-11-21T02:20:16Z

Andrej:

File:Spring build cmake07.png

2013-11-21T02:13:55Z

Andrej:

File:Spring build cmake06.png

2013-11-21T01:58:49Z

Andrej:

File:Spring build cmake04.png

2013-11-21T01:57:22Z

Andrej:

File:Spring build cmake03.png

2013-11-21T01:53:09Z

Andrej:

File:Spring build cmake02.png

2013-11-21T01:51:49Z

Andrej:

File:Spring build cmake01.png

2013-11-21T01:51:12Z

Andrej:

File:Spring build cmake05.png

2013-11-21T01:50:05Z

Andrej:

File:Spring build cmake00.png

2013-11-21T01:42:40Z

Andrej:

Lua Beginners FAQ

2010-03-10T00:31:31Z

Andrej: Undo revision 18525, redo changing all headings, allows them to be linked as anchors or we/

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

==Q: I'm interested in learning to use Lua with Spring. Where should I start?==

A: You can start by reading the tutorial [http://lua-users.org/wiki/TutorialDirectory here]. The "Introductory topics" and "Programming in Lua" sections should suffice, in the beginning. After that, you can try editing simple LuaUI widgets, like snd_chatterbox.

==Q: Where can I find documentation?==

A: "Spring/LuaUI/widgets.lua" and "<modname>/LuaRules/gadgets.lua" contain the call-ins and their arguments. Almost all call-outs are documented in the following wiki articles: <br>
{{LuaInterfaces}}
You can also consult the [http://spring.clan-sy.com/wiki/Engine_Development#Obtaining_the_Source Spring source code].
<br>

==Q: What can't Lua do in the current version of Spring?==

A: You can't ...
*write to the metal/texture map.
*control the ground LOS (but you can set the los status of units!).

==Q: How do I open ".lua" files?==

A: Notepad or any text editor might be enough. If you are using windows and the text is all garbled, try a programmer's editor. [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] can read Lua files with syntax highlighting.

==Q: What is a call-in? And a call-out?==

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the gadget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

==Q: What is the difference between a widget and a gadget?==

A: A widget is a Lua script that works with LuaUI. A gadget works with LuaRules, LuaCob or LuaGaia. Widgets allow you to customize your interface, and must be unsynced. They can be bundled with the mod or you can save them in your "Spring/LuaUI/Wigets" directory. Gadgets can be synced or unsynced. LuaRules and LuaCob gadgets are usually part of a mod. LuaGaia gadgets should be part of a map. Gadgets can contain both synced and unsynced code.

==Q: Where can I find examples?==

A: The "Spring/LuaUI/Widgets" directory contains many examples. More can be found at [http://spring.jobjol.nl/files.php?subcategory_id=12 SpringFiles] or in the [http://www.caspring.org/ Complete Annihilation] mod.

==Q: Can I reload a script without restarting Spring?==

Yes, you can type "/luaui reload" or ".luarules reload". If you just need to check for syntax error, you can do it without having to load Spring by compiling the code. You can find a Lua compiler [http://luaforge.net/frs/?group_id=110&release_id=694 here]. [http://luaforge.net/frs/download.php/2218/lua5_1_2_Win32_bin.zip This] is the download for Windows users..

==Q: Why does the print function seem to do nothing?==

A: Its output is displayed in stdout. If you have no easy way to see it, you can is Spring.Echo which prints to the ingame chat and infolog.txt.

==Q: How do I print the "UnitDefs[unitDefID]" or "WeaponDefs[weaponDefID]" tables? "for k, v in ipairs(t) do print(k, v) end" does not behave as expected.==

A: Use "for k,v in UnitDefs[unitDefID]:pairs() do print(k, v) end" instead.

==Q: Where can I find help?==

A: There is a [http://spring.clan-sy.com/phpbb/viewforum.php?f=23 Lua section] in the Spring forums. Probably the most effective way, though, is to join #lua on the lobby.

==Q: Who implemented LuaUI, LuaRules and LuaGaia?==

A: They were written by trepan.

Lua Beginners FAQ

2010-03-10T00:27:10Z

Andrej:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

'''Q: I'm interested in learning to use Lua with Spring. Where should I start?'''

A: You can start by reading the tutorial [http://lua-users.org/wiki/TutorialDirectory here]. The "Introductory topics" and "Programming in Lua" sections should suffice, in the beginning. After that, you can try editing simple LuaUI widgets, like snd_chatterbox.

'''Q: Where can I find documentation?'''

A: "Spring/LuaUI/widgets.lua" and "<modname>/LuaRules/gadgets.lua" contain the call-ins and their arguments. Almost all call-outs are documented in the following wiki articles: <br>
{{LuaInterfaces}}
You can also consult the [http://spring.clan-sy.com/wiki/Engine_Development#Obtaining_the_Source Spring source code].
<br>

'''Q: What can't Lua do in the current version of Spring?'''

A: You can't ...
*write to the metal/texture map.
*control the ground LOS (but you can set the los status of units!).

'''Q: How do I open ".lua" files?'''

A: Notepad or any text editor might be enough. If you are using windows and the text is all garbled, try a programmer's editor. [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] can read Lua files with syntax highlighting.

'''Q: What is a call-in? And a call-out?'''

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the gadget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

==Q: What is the difference between a widget and a gadget?==

A: A widget is a Lua script that works with LuaUI. A gadget works with LuaRules, LuaCob or LuaGaia. Widgets allow you to customize your interface, and must be unsynced. They can be bundled with the mod or you can save them in your "Spring/LuaUI/Wigets" directory. Gadgets can be synced or unsynced. LuaRules and LuaCob gadgets are usually part of a mod. LuaGaia gadgets should be part of a map. Gadgets can contain both synced and unsynced code.

'''Q: Where can I find examples?'''

A: The "Spring/LuaUI/Widgets" directory contains many examples. More can be found at [http://spring.jobjol.nl/files.php?subcategory_id=12 SpringFiles] or in the [http://www.caspring.org/ Complete Annihilation] mod.

'''Q: Can I reload a script without restarting Spring?'''

Yes, you can type "/luaui reload" or ".luarules reload". If you just need to check for syntax error, you can do it without having to load Spring by compiling the code. You can find a Lua compiler [http://luaforge.net/frs/?group_id=110&release_id=694 here]. [http://luaforge.net/frs/download.php/2218/lua5_1_2_Win32_bin.zip This] is the download for Windows users..

'''Q: Why does the print function seem to do nothing?'''

A: Its output is displayed in stdout. If you have no easy way to see it, you can is Spring.Echo which prints to the ingame chat and infolog.txt.

'''Q: How do I print the "UnitDefs[unitDefID]" or "WeaponDefs[weaponDefID]" tables? "for k, v in ipairs(t) do print(k, v) end" does not behave as expected.'''

A: Use "for k,v in UnitDefs[unitDefID]:pairs() do print(k, v) end" instead.

'''Q: Where can I find help?'''

A: There is a [http://spring.clan-sy.com/phpbb/viewforum.php?f=23 Lua section] in the Spring forums. Probably the most effective way, though, is to join #lua on the lobby.

'''Q: Who implemented LuaUI, LuaRules and LuaGaia?'''

A: They were written by trepan.

FAQ:Content

2010-02-16T21:31:03Z

Andrej: http://springrts.com/phpbb/viewtopic.php?p=395299#p395299 there is a /packages/ but not a /content/ ?

= Spring Modification and Game Developement FAQ + Basics =
== How To Get Help ==
* '''Play Before You Ask Anything:''' If you found this site as part of you trying to figure out how to make your dream game that's awesome. Regardless of why you are here, if you want to design games you'll need to familiarize yourself with the engine's capabilities and the best way to do that is to play the games that already exist. As a basic rule, before posting a question, make sure you have at least learned how to download and install content packages and played a multi-player game... if you don't want to play a multi-player game you should at-least spectate a few of them.

* '''Don't Be Stupid:''' If You post in a forum and don't present yourself in an intelligent manner demonstrating commitment to your project in the form of actual work or demonstrating the intelligence needed to actually do what what you are asking for, most of the people who reply will be doing so to mock you/scare you away. There are many projects all in competition for help, your project will at many times be just you and you need to be able to do all project related tasks if you expect to reach completion.

* '''Figure Out What You Are Asking For:''' If you are unsure where to start, posting a "Where do I start?" topic without any details is not the right approach. Figure out what you want to do (make a new Game Type or Mutator, Make New Units, Make a New Map, Make a Mission or Campaign, Make an AI) and ask for that specifically.

* '''We Help Those Who Help Themselves:''' Don't post something like "I have this awesome Idea, help me make it!", without also posting what contributions you intend to provide to the project... if you are just posting an idea and intend to be "The Idea Guy" then you probably want to post it in the Off-Topic forums.

* '''Don't Take It Personally:''' Without exception, no matter how hard you try, no matter how awesome you are at modeling, scripting or game design... someone is going to try to "Help" you by being a jerk to you... These people have usually interpreted your behavior as being cocky or n00bish and want to tear you down as a way of weeding useless people out of the community. When this happens, just ignore them and press on or leave.

* '''If No One Helps You Don't Get Mad:''' If people don't respond to your post it's likely because the people who know the answer are busy working on their own projects and haven't taken the time to check the forums. First, be patient. Second, poke around with the documentation or crack open a pre-existing Package and try to figure out a better way to ask your question. Finally, you can also log in to the lobby software and ask there, check the list of available channels, there's usually one about the topic you are trying to learn... if all else fails just ask in #main.

== Stuff Everyone Should Know ==
Spring is an Engine designed to allow people to make real-time strategy games... It is not a game in itself. Unfortunately this has lead to a lot of very complex and bitter arguments on semantics, the results of which can be summarized as follows:

"Content" can be developed for Spring and distributed in "Content Packages" (namely SDZ, SD7 Files or SDD folders) or dumped into your Spring directory structure directly (a bad idea in many cases, as except for certain notable exceptions it will cause you to be unable to synchronize with other players). The content of these Packages can take the form of Units, Textures, Models (3DO or S30), Game Types and Maps... (Lua and COB Scripts along with other Data Files may also count in certain contexts...)

This leads to a bunch of quazi-defined meta-terminology:

=== General Terminology ===

'''TA-ist/TA-isms''': Spring was initially designed to play a Port of XTA, a Mod of Total Annihilation build for the original Total Annihilation engine. As such there are a number of things, like the resource structure, the general interface, unit tags (and to be honest nearly everything that isn't Lua) that are essentially extensions of this concept.

=== "Game Type" Terminology ===

'''Mods, Games and Mutators''' are all essentially synonyms for "A Content Package Containing At Least One Game Type". Colloquially speaking:

*'''Mods''' are modifications of existing games, in almost all cases these are a Derivative Work of Total Annihilation.

*'''Games''' Projects creating Original Works, independent of the aforementioned Total Annihilation data and Copyright.

*'''Mutators''' are new Game Types meant to be used in conjunction with an existing Package called a "dependency". They are not meant to be mods as they exist to facilitate the addition of features or the altering of gameplay for the core of a project. In the more common vernacular of video gaming these would have been mods.

'''Modders and (Mod-)Devs''' are interchangeable terms for the people working on a Project. Typically someone who is working with existing content developed by someone else falls into the '''"Modders"''' category and and those who are creating all new content are called '''"Content Developers"''', but most content developers tend to both create new content and modify existing content so the terms are really more a matter of preference.

'''Game Designers'''
Aka, idea men, most of us are intelligent enough to come up with the code to pull off these crazy ideas you suggest. Odds are that intellect also comes with the creativity to have our own ideas. Idea men are not needed here and will find themselves alone and without the ability to finish their project.

'''Units''' are entity templates defined in text files that reference Model, Other Text Files, Script and Texture files (sometimes this reference is inferred). Like most RTS Games, a Game Type in Spring will typically define one or more kind of starting unit which will be able to be given orders to do things like move, attack and build new other units. The term.

'''Features and Wreckage''' are special types of Units that are not owned by any player. These include things like rocks and trees as well as the corpses of fallen units.

=== Map Terminology ===
A map in Spring consist of a heightfield, environmental lighting and sky settings, type map, metal map and features.
the Map Data Files:
*(SMD), contains parameters that set things such as lighting and startpoints
*(SMT), Tiles File
*(SMF), '''Unsure needs more info'''

Maps may also include their own lua gadgets, which are to be stored in lua gaia. They may have their own feature models, units, effects and even map options which allow a host to change properties of the map.

=== Scripting Terminology ===

'''Synchronized Code'''
Lua Gadgets and Unit Scripts (Lua or COB) are what is refereed to as synchronized code. They define much of the behavior of all Games of a given Game Type and as such must act the same on all players computers. Because Unit animation is used for things like aiming speed, how long it takes a unit to open and close, or when it is able to shoot a specific weapon, all of the code for this behavior is synchronized.

'''Gadgets''' are Lua scripts that are inherent to a "Game Type", they can define pretty much anything from which units are available to custom resources to unit animations to GUI elements. If you ask a question like "Is it possible for the game I'm building to do X" the answer is most-probably, "Yes, with enough Lua". You could, for example, use Lua in conjunction with the Spring Engine to, build a first person shooter or turn based strategy game... though it would take an awful lot of creative Lua to do so.

'''Lua Unit Definitions and Scripts''' Lua can also be used within the traditional TA-ist framework to set the values of a Unit's tags and define the Unit's animation scripts.

'''Widgets'' are Lua scripts that are not inherent to <s>the</s> <s>a</s> yes "Game Type" (though they might be included along with a Game Type in a Package). They define things like custom GUI elements, macro-equivalent short-cut commands or pretty much anything that is specific to your individual client session and not the game simulation. Widgets are one of the few things you can drop relatively safely into your Spring directory structure without interfering with sync.

'''COB''' is a compiled script that is a derived form of the unit script files in Total Annihilation. Many Game Types still use COB to define how their units behave.

== General Development FAQ ==

This covers the basic concepts of Spring Content creation that are common to all Game Types, Maps or Content in general.

=== How I Mod?! ===
In general, the first thing you'll want to do is crack open an existing Package for the type of thing you want to modify.

Packages Will contain some or all of the following Files:
Data Files (Plain Text files with the extension .TDF for "Total Annihilation Data File)
Textures
Models (in 3DO or S3O format)
Scripts (in Lua or compiled COB format)
Map Tiles (Compiled SMT files (not human readable))
Map Data (Plain Text Files)
Map "Everything Else" Files (Compiled SMT files (not human readable))

These are all stored in either ZIP or 7zip Format and can both be opened with [http://www.7-zip.org/ 7zip]

=== So Really, How do I Mod the Spring Engine? ===
You Don't, see next section.
=== Okay... How do Create a new Project or Modify an existing Package For the Spring Engine? ===
That depends, do you want to:
* Make a New Unit
* Modify an Existing Game Type
* [[FAQ:Content:Mapping|Make a Map]]
* Script a Widget
* Make a New Game Type
=== Where do I put all these files? ===
The folder structure for a Package is the same for every Game Type:

First start with a ".SDD" folder or SDZ/SD7 Archive within the "Packages", "Maps" or "Mods" Folder chosen within your Spring Preferences:
* '''.SDD Folder:''' Create a folder called "ModName.SDD" containing your files
* '''SDZ:''' Create a ZIP file containing your files and rename it to ModName.SDZ
* '''SD7:''' Create a 7z file containing your files and rename it to ModName.SD7

Within your mod folder or archive you need to have the following folder structure:
{{Volatile_Documentation|date=Not Yet|user=No One}}

FAQ:Content

2010-02-16T21:29:02Z

Andrej: Improved GNU FSF Words to Avoid compliance: http://www.gnu.org/philosophy/words-to-avoid.html (#7 content) || http://www.linuxjournal.com/article/6366

= Spring Modification and Game Developement FAQ + Basics =
== How To Get Help ==
* '''Play Before You Ask Anything:''' If you found this site as part of you trying to figure out how to make your dream game that's awesome. Regardless of why you are here, if you want to design games you'll need to familiarize yourself with the engine's capabilities and the best way to do that is to play the games that already exist. As a basic rule, before posting a question, make sure you have at least learned how to download and install content packages and played a multi-player game... if you don't want to play a multi-player game you should at-least spectate a few of them.

* '''Don't Be Stupid:''' If You post in a forum and don't present yourself in an intelligent manner demonstrating commitment to your project in the form of actual work or demonstrating the intelligence needed to actually do what what you are asking for, most of the people who reply will be doing so to mock you/scare you away. There are many projects all in competition for help, your project will at many times be just you and you need to be able to do all project related tasks if you expect to reach completion.

* '''Figure Out What You Are Asking For:''' If you are unsure where to start, posting a "Where do I start?" topic without any details is not the right approach. Figure out what you want to do (make a new Game Type or Mutator, Make New Units, Make a New Map, Make a Mission or Campaign, Make an AI) and ask for that specifically.

* '''We Help Those Who Help Themselves:''' Don't post something like "I have this awesome Idea, help me make it!", without also posting what contributions you intend to provide to the project... if you are just posting an idea and intend to be "The Idea Guy" then you probably want to post it in the Off-Topic forums.

* '''Don't Take It Personally:''' Without exception, no matter how hard you try, no matter how awesome you are at modeling, scripting or game design... someone is going to try to "Help" you by being a jerk to you... These people have usually interpreted your behavior as being cocky or n00bish and want to tear you down as a way of weeding useless people out of the community. When this happens, just ignore them and press on or leave.

* '''If No One Helps You Don't Get Mad:''' If people don't respond to your post it's likely because the people who know the answer are busy working on their own projects and haven't taken the time to check the forums. First, be patient. Second, poke around with the documentation or crack open a pre-existing Package and try to figure out a better way to ask your question. Finally, you can also log in to the lobby software and ask there, check the list of available channels, there's usually one about the topic you are trying to learn... if all else fails just ask in #main.

== Stuff Everyone Should Know ==
Spring is an Engine designed to allow people to make real-time strategy games... It is not a game in itself. Unfortunately this has lead to a lot of very complex and bitter arguments on semantics, the results of which can be summarized as follows:

"Content" can be developed for Spring and distributed in "Content Packages" (namely SDZ, SD7 Files or SDD folders) or dumped into your Spring directory structure directly (a bad idea in many cases, as except for certain notable exceptions it will cause you to be unable to synchronize with other players). The content of these Packages can take the form of Units, Textures, Models (3DO or S30), Game Types and Maps... (Lua and COB Scripts along with other Data Files may also count in certain contexts...)

This leads to a bunch of quazi-defined meta-terminology:

=== General Terminology ===

'''TA-ist/TA-isms''': Spring was initially designed to play a Port of XTA, a Mod of Total Annihilation build for the original Total Annihilation engine. As such there are a number of things, like the resource structure, the general interface, unit tags (and to be honest nearly everything that isn't Lua) that are essentially extensions of this concept.

=== "Game Type" Terminology ===

'''Mods, Games and Mutators''' are all essentially synonyms for "A Content Package Containing At Least One Game Type". Colloquially speaking:

*'''Mods''' are modifications of existing games, in almost all cases these are a Derivative Work of Total Annihilation.

*'''Games''' Projects creating Original Works, independent of the aforementioned Total Annihilation data and Copyright.

*'''Mutators''' are new Game Types meant to be used in conjunction with an existing Package called a "dependency". They are not meant to be mods as they exist to facilitate the addition of features or the altering of gameplay for the core of a project. In the more common vernacular of video gaming these would have been mods.

'''Modders and (Mod-)Devs''' are interchangeable terms for the people working on a Project. Typically someone who is working with existing content developed by someone else falls into the '''"Modders"''' category and and those who are creating all new content are called '''"Content Developers"''', but most content developers tend to both create new content and modify existing content so the terms are really more a matter of preference.

'''Game Designers'''
Aka, idea men, most of us are intelligent enough to come up with the code to pull off these crazy ideas you suggest. Odds are that intellect also comes with the creativity to have our own ideas. Idea men are not needed here and will find themselves alone and without the ability to finish their project.

'''Units''' are entity templates defined in text files that reference Model, Other Text Files, Script and Texture files (sometimes this reference is inferred). Like most RTS Games, a Game Type in Spring will typically define one or more kind of starting unit which will be able to be given orders to do things like move, attack and build new other units. The term.

'''Features and Wreckage''' are special types of Units that are not owned by any player. These include things like rocks and trees as well as the corpses of fallen units.

=== Map Terminology ===
A map in Spring consist of a heightfield, environmental lighting and sky settings, type map, metal map and features.
the Map Data Files:
*(SMD), contains parameters that set things such as lighting and startpoints
*(SMT), Tiles File
*(SMF), '''Unsure needs more info'''

Maps may also include their own lua gadgets, which are to be stored in lua gaia. They may have their own feature models, units, effects and even map options which allow a host to change properties of the map.

=== Scripting Terminology ===

'''Synchronized Code'''
Lua Gadgets and Unit Scripts (Lua or COB) are what is refereed to as synchronized code. They define much of the behavior of all Games of a given Game Type and as such must act the same on all players computers. Because Unit animation is used for things like aiming speed, how long it takes a unit to open and close, or when it is able to shoot a specific weapon, all of the code for this behavior is synchronized.

'''Gadgets''' are Lua scripts that are inherent to a "Game Type", they can define pretty much anything from which units are available to custom resources to unit animations to GUI elements. If you ask a question like "Is it possible for the game I'm building to do X" the answer is most-probably, "Yes, with enough Lua". You could, for example, use Lua in conjunction with the Spring Engine to, build a first person shooter or turn based strategy game... though it would take an awful lot of creative Lua to do so.

'''Lua Unit Definitions and Scripts''' Lua can also be used within the traditional TA-ist framework to set the values of a Unit's tags and define the Unit's animation scripts.

'''Widgets'' are Lua scripts that are not inherent to <s>the</s> <s>a</s> yes "Game Type" (though they might be included along with a Game Type in a Package). They define things like custom GUI elements, macro-equivalent short-cut commands or pretty much anything that is specific to your individual client session and not the game simulation. Widgets are one of the few things you can drop relatively safely into your Spring directory structure without interfering with sync.

'''COB''' is a compiled script that is a derived form of the unit script files in Total Annihilation. Many Game Types still use COB to define how their units behave.

== General Development FAQ ==

This covers the basic concepts of Spring Content creation that are common to all Game Types, Maps or Content in general.

=== How I Mod?! ===
In general, the first thing you'll want to do is crack open an existing Package for the type of thing you want to modify.

Packages Will contain some or all of the following Files:
Data Files (Plain Text files with the extension .TDF for "Total Annihilation Data File)
Textures
Models (in 3DO or S3O format)
Scripts (in Lua or compiled COB format)
Map Tiles (Compiled SMT files (not human readable))
Map Data (Plain Text Files)
Map "Everything Else" Files (Compiled SMT files (not human readable))

These are all stored in either ZIP or 7zip Format and can both be opened with [http://www.7-zip.org/ 7zip]

=== So Really, How do I Mod the Spring Engine? ===
You Don't, see next section.
=== Okay... How do Create a new Project or Modify an existing Package For the Spring Engine? ===
That depends, do you want to:
* Make a New Unit
* Modify an Existing Game Type
* [[FAQ:Content:Mapping|Make a Map]]
* Script a Widget
* Make a New Game Type
=== Where do I put all these files? ===
The folder structure for a Package is the same for every Game Type:

First start with a ".SDD" folder or SDZ/SD7 Archive within the "Content", "Maps" or "Mods" Folder chosen within your Spring Preferences:
* '''.SDD Folder:''' Create a folder called "ModName.SDD" containing your files
* '''SDZ:''' Create a ZIP file containing your files and rename it to ModName.SDZ
* '''SD7:''' Create a 7z file containing your files and rename it to ModName.SD7

Within your mod folder or archive you need to have the following folder structure:
{{Volatile_Documentation|date=Not Yet|user=No One}}

Help:Editing

2010-02-16T20:32:23Z

Andrej: http://en.wikipedia.org/wiki/Conservation_of_energy

This page contains tips on editing wiki pages, for full details of editing the Wiki see [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide]

==Basic Editing==

*Choose what you want to do:
*# '''Make a new page'''<br>Type the URL of the page you want to create into the address bar. <br>EG: <nowiki>http://springrts.com/wiki/Page_that_doesnt_exist</nowiki>
*# '''Edit an existing page'''<br>Goto the page you want to edit, either through Links, or a URL.
*Then, click the 'Edit this page' link at the bottom.
*A page with a text box in the middle of it will appear.
*Enter text into this box.
*To insert formatting, click the formatting buttons above the text box.
*For a full list of formatting tags, and their effects, see below
*Click the 'Preview Page' button below the text box to preview the page.
*Fix any errors you spot.
*Click 'Save page' next to the Preview button.
*You're Done!

Dont worry if you stuff things up. Its very easy to fix. Any changes that are made are automatically logged, and we can easily revert to an old version if you totally screw a page up.
And if your still worried of messing something up, you can always play around in the [[sandbox]] first.

==Markup==
The following [[w:HTML element|HTML element]]s are currently permitted, however most of the useful ones have a convenient shorthand (see table below):

{| border="0" cellpadding="5"
| valign="top"|
* [[Wikipedia:HTML_element#Presentational_markup|<b>]]
* [[Wikipedia:HTML_element#Presentational_markup|<big>]]
* [[Wikipedia:HTML_element#Text_containers|<blockquote>]]
* [[Wikipedia:HTML_element#Others|<br>]]
* [[Wikipedia:HTML_element#Tables|<caption>]]
* <center>
* <cite>
* [[Wikipedia:HTML_element#Logical_markup|<code>]]
* [[Wikipedia:HTML_element#Lists|<dd>]]
* [[Wikipedia:HTML_element#Other_containers|<div>]]
* [[Wikipedia:HTML_element#Lists|<dl>]]
* [[Wikipedia:HTML_element#Lists|<dt>]]
* [[Wikipedia:HTML_element#Logical_markup|<em>]]
* [[Wikipedia:HTML_element#Presentational_markup|<font>]]
* [[Wikipedia:HTML_element#Headings|<h1>]]
| valign="top"|
* [[Wikipedia:HTML_element#Headings|<h2>]]
* [[Wikipedia:HTML_element#Headings|<h3>]]
* [[Wikipedia:HTML_element#Headings|<h4>]]
* [[Wikipedia:HTML_element#Headings|<h5>]]
* [[Wikipedia:HTML_element#Headings|<h6>]]
* [[Wikipedia:HTML_element#Other_containers|<hr>]]
* [[Wikipedia:HTML_element#Presentational_markup|<i>]]
* [[Wikipedia:HTML_element#Lists|<li>]]
* [[Wikipedia:HTML_element#Lists|<ol>]]
* [[Wikipedia:HTML_element#Text_containers|<p>]]
* [[Wikipedia:HTML_element#Text_containers|<pre>]]
* <rb>
* <rp>
* <rt>
* <ruby>
| valign="top"|
* [[Wikipedia:HTML_element#Presentational_markup|<s>]]
* [[Wikipedia:HTML_element#Presentational_markup|<small>]]
* [[Wikipedia:HTML_element#Presentational_markup|<strike>]]
* [[Wikipedia:HTML_element#Logical_markup|<strong>]]
* [[Wikipedia:HTML_element#Presentational_markup|<sub>]]
* [[Wikipedia:HTML_element#Presentational_markup|<sup>]]
* [[Wikipedia:HTML_element#Tables|<table>]]
* [[Wikipedia:HTML_element#Tables|<td>]]
* [[Wikipedia:HTML_element#Tables|<th>]]
* [[Wikipedia:HTML_element#Tables|<tr>]]
* [[Wikipedia:HTML_element#Presentational_markup|<tt>]]
* [[Wikipedia:HTML_element#Presentational_markup|<u>]]
* [[Wikipedia:HTML_element#Lists|<ul>]]
* [[Wikipedia:HTML_element#Logical_markup|<var>]]
* [[Wikipedia:HTML_element#Others|]]
|}

=== Sections, paragraphs, lists and lines ===
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>What it looks like</th>
<th>What you type</th>
</tr>
<tr>
<td>
Start your sections with header lines:

Note: Single equal signs work for formatting headings, however as a convention for this wiki, do not use them.






<b><font style="font-size:120%"> New section </font></b>

<b><font style="font-size:110%"> Subsection</font></b>

<b><font style="font-size:100%"> Sub-subsection</font></b>

</td>
<td><pre><nowiki>

== New section ==

=== Subsection ===

==== Sub-subsection ====
</nowiki></pre>
</td>
</tr>
<tr>
<td>
[[en:newline|Newline]]:

A single
newline
has no
effect on the
layout.

But an empty line
starts a new paragraph.

(<nowiki><p></nowiki> disables this paragraphing until <nowiki></p></nowiki> or the end of the section)

(in Cologne Blue two newlines and a div tag give just one newline; in the order newline, div tag, newline, the result is two newlines)

</td>
<td>
<pre><nowiki>

A single
newline
has no
effect on the
layout.

But an empty line
starts a new paragraph.</nowiki></pre>
</td>
</tr>
<tr valign="top"><td>You can break lines<br>
without starting a new paragraph.<p>
Sufficient as wikitext code is <nowiki><br></nowiki>, the XHTML code <nowiki><br /></nowiki> is not needed, the system produces this code.</p></td>
<td><pre><nowiki>You can break lines<br>
without starting a new paragraph.</nowiki></pre>
</td>
</tr>
<tr>
<td>
* [[Help:List|Lists]] are easy to do:
** start every line with a star
*** more stars means deeper levels
*A newline
*in a list
marks the end of the list.
*Of course
*you can
*start again.

</td>
<td><pre><nowiki>* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels
*A newline
*in a list
marks the end of the list.
*Of course
*you can
*start again.

</nowiki></pre>
</td>
</tr>
<tr>
<td>
# Numbered lists are also good
## very organized
## easy to follow
#A newline
#in a list
marks the end of the list.
#New numbering starts
#with 1.

</td>
<td><pre><nowiki># Numbered lists are also good
## very organized
## easy to follow
#A newline
#in a list
marks the end of the list.
#New numbering starts
#with 1.
</nowiki></pre>
</td>
</tr>
<tr>
<td>
* You can even do mixed lists
*# and nest them
*#* like this<br>or have newlines<br>inside lists
</td>
<td><pre><nowiki>* You can even do mixed lists
*# and nest them
*#* like this<br>or have newlines<br>inside lists</nowiki></pre>
</td>
</tr>
<tr>
<td>
* You can also
**break lines<br>inside lists<br>like this
</td>
<td><pre><nowiki>* You can also
**break lines<br>inside lists<br>like this</nowiki></pre>
</td>
</tr>
<tr>
<td>
; Definition list : list of definitions
; item : the item's definition
</td>
<td><pre><nowiki>; Definition list : list of definitions
; item : the item's definition</nowiki></pre>
</td>
</tr>
<tr>
<td>
:A colon indents a line or paragraph.
A manual newline starts a new paragraph.
* This is primarily for displayed material, but is also used for discussion on [[Help:Talk page|Talk page]]s.
</td>
<td><pre><nowiki>: A colon indents a line or paragraph.
A manual newline starts a new paragraph.
</nowiki></pre>
</td>
</tr>
<tr valign=top>
<td>
<pre><nowiki>IF a line of plain text starts
with a space THEN
it will be formatted exactly
as typed;
in a fixed-width font;
lines won't wrap;
ENDIF
this is useful for:
* pasting preformatted text;
* algorithm descriptions;
* program source code
* ASCII art;
* chemical structures;</nowiki></pre>

WARNING If you make it wide,
you [[en:page widening|force the whole page to be wide]] and
hence less readable. Never start ordinary lines with spaces.<br>
<center>(see also below)</center>
</td>
<td><pre><nowiki> IF a line of plain text starts
with a space THEN
it will be formatted exactly
as typed;
in a fixed-width font;
lines won't wrap;
ENDIF
this is useful for:
* pasting preformatted text;
* algorithm descriptions;
* program source code
* ASCII art;
* chemical structures;</nowiki></pre></td>
</tr>
<tr valign="top"><td><center>Centered text.</center>
</td>
<td><pre><nowiki><center>Centered text.</center></nowiki></pre>
</td>
</tr>
<tr>
<td>A [[en:horizontal dividing line|horizontal dividing line]]: above
----
and below.

(However, in most cases a section header is more useful. The horizontal dividing line should only be used if what follows is logically part of the same section; otherwise that part would be hidden in the TOC.)</td>
<td><pre><nowiki>A horizontal dividing line: above
----
and below. </nowiki></pre>
</td>
</tr>
</table>

Summarizing the effect of a single newline: no effect in general, but it ends a list item or indented part; thus changing some text into a list item, or indenting it, is more cumbersome if it contains newlines, they have to be removed; see also [http://en.wikipedia.org/wiki/Wikipedia:Don%27t_use_line_breaks Don't use line breaks] (wikipedia).