Spring - User contributions [en]

Map development

2008-08-18T19:53:59Z

Zyzy: /* Tools */

=Map making SM3=

SM3 (Spring Mapformat 3) is getting allong nicely and maps using this format can be made. The following is documented so far.

*[[SM3_Map_Format|jcnossen's brief description on how this mapformat works.]]
*[[SM3_FAQ|The first FAQ for the new mapformat.]]

[[Image:sm3-minimap-thumb.jpg]]

=Map making, SMF=
Maps, are a complex mixture of heightmaps and textures.
Fortunately, there are several people who share their knowledge with us.
There few tutorials will make your life as mapper a lot better.

=Skyboxes=
*[[Skyboxcreation|Notes about skyboxes]] notes on a prerendered sky box or cube map.

== Full Guides For Map Making ==

*[[Create_maps|aGorm's map creating Guide]]
*[[Map_Making_Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick_Map_Design_Help|IceXuicks Map creating Guide]]
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A_Complete_Map_Making_Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[[Zorbawic%27s_Map_Design_Help_in_Polish_language_%28Jak_zrobi%C4%87_mape_do_Springa_-_po_Polsku%29| Zorbawic's Map Design Help in Polish language (Jak zrobiÃ„â€¡ mape do Springa - po Polsku)]]
*[http://modinfo.adune.nl/map_making_guide.php Simple map making guide]

== Specific Guides ==

*[[Quanto_OTAMAP_Guide|Quanto's Guide to OTA Porting and Small Maps]]
*[[Maps:SMD|Everything about .SMD]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create_map_texture_with_povray|Basic howto: create map texture with Povray]]

Features. Stones, rocks, trees, for your map can be found in [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=4047 This thread] 

== Tools ==

*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420 Maelstrom's SMD Generator]
*[http://www.fileuniverse.com/?p=show&a=it&id=1507 Mother's Mapconv]
*[http://user.supradigital.org/jcnossen/FeaturePlacer.zip Jnossen's SM3 feature placer]
*[[Maps:Map Designer]] Hugh's 3D map designer. Splatting, heightmap editing, splat painting, SM3
*[http://modinfo.unknown-files.net/coord/mapcoords.php Online starting position creator(dead link)]
: You can always find out which x/y coordinates are good while starting spring and having a look at the mouse cursor coordinates.

== Mappers Clan ==
[[Map Making Guild]]: That weird fish aGorm set up a clan for poor mappers that can't get into a clan on there gaming merit... (Mainly for himself therefor...)

== Reference and FAQs ==

* [[Maps:Noob Mistakes]]
* [[Water Height: Mapconv vs. Heightmap]]

----
TIPS:

A useful tip, on almost every map in a 1v1 you will start opposite your opponent unless you choose your position. this is because random order simply randomly distributes players at the default start points which in almost every map are opposite each other. One exception that I know of is flooded desert where you both start on the left hand island.
----
Make sure that your map's ideas and game-play is sound before you release it for good. Do a lot of beta testing and learn about good level design! You can learn about what makes a good map by playing on good maps, so play often and map well. -url00
----

''' [[Main_Page|<- Back to Main page]]'''

[[Category:Map development]]

Development:Main

2007-12-07T16:50:39Z

Zyzy: /* Modifying and Compiling the Source */

Outlined below is information on assisting with the development of the Spring source itself.

::NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.

Below you can find information on how to work with the Spring source in the current mainline (Windows platform) if you like to work on another platform (Linux & Mac) please look at the bottem of this page under "Multiplatform development"

==Starting Development==
To start development, you will need
#The latest version of the source
#A good code manipulation program
#Compiling your modified source

== Keep track what others do ==
If you develop with others, you need to know what they do. Fisheye is a very handy svn helper, we currently use:
http://spring.clan-sy.com/fisheye

===Source Code Documentation===
A good place to start is the source code documentation, which can be found here: [http://taspring.clan-sy.com/doxygen/ doxygen] need to be change, osrts is out

An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]
page.

===Obtaining the Source===

Update: the latest SVN is at: [https://taspring.clan-sy.com/svn/spring https://taspring.clan-sy.com/svn/spring]

Another option is to manually download it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with SVN access.

windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
[http://www.syntevo.com/smartsvn/index.jsp SmartSVN] (Java) and [http://tortoisesvn.tigris.org TortoiseSVN] (MSI).

assuming that you are using the Subversion svn client you can download the latest SVN source with

<code>svn.exe checkout https://taspring.clan-sy.com/svn/spring/trunk</code>

it will create a trunk subdirectory in the directory from where you ran it, which will contain the source code root directory which will be later referred to as /taspring

===Learning C++===
You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]

However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

===Modifying and Compiling the Source===

See [[Development_IDEs]].
You have either to use the SCons build system that is multi platform, or use Microsoft Visual Studio for building spring.

A list of required libraries as well as pre-built packages of these follows:
*[http://www.boost.org Boost C++ library]
*[http://www.openal.org OpenAL Audio library]
*[http://glew.sf.net GLEW (OpenGL extension loading)]
*[http://www.winimage.com/zLibDll/ zlib + minizip]
*[http://www.libsdl.org SDL]
*[http://openil.sf.net DevIL (Image loading)]
*[http://www.freetype.org Freetype font rendering]

*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=49257#49257 Pre-Built packages of most of the dependencies].
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=56846#56846 Pre-Built boost for VS8]. *note - probably not needed

*[http://msdn.microsoft.com/directx/sdk/ DirectX SDK] (Windows, Visual Studio C++ only)
*PlatformSDK (Windows, Visual Studio C++ Only)
I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download.
Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
After installing them, open Visual C++.
Click Tools >> Options >> Projects and Solutions >> VC++ Directories.

Add these entries to the corresponding sections (paths just a reference, yours may be different):
*Include files:
**$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
**$(ProgramFiles)\Microsoft Platform SDK\include
*Library files:
**$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86
***Might need \x64 on a 64-bit platform, I don't know.
**$(ProgramFiles)\Microsoft Platform SDK\lib

'''The following are for building with SCONS/MinGW'''

*[http://prdownloads.sourceforge.net/dev-cpp/devcpp-4.9.9.2_setup.exe Dev-Cpp installer] / [MinGW] Though I would not advise mingw because you have to set it up your self, and this is harder than it sounds. Note that Code:Blocks mingw setup is not sufficient. *note - dev-cpp seems to have been abandoned
*[http://www.python.org/ftp/python/2.4.2/python-2.4.2.msi Python 2.4 installer]
*[http://prdownloads.sourceforge.net/pywin32/pywin32-208.win32-py2.4.exe?download Python win32 extensions installer]
*[http://prdownloads.sourceforge.net/scons/scons-0.96.1.win32.exe Scons installer]

====Development System Setup====

See [http://spring.clan-sy.com/phpbb/viewtopic.php?p=49257 Compiling spring (mingw and visual studio 7/8)] and [[Installing Visual C plus plus]] for instructions.

*Make sure C:\Python24 and C:\Dev-Cpp\bin are in your PATH environment variable.
*Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (Change paths where appropriate.)
**Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP).
*Checkout the TA Spring SVN repository into your working area.
*You will also need the [http://spring.clan-sy.com/dl/spring-mingwlibs.exe MinGW/DevCPP libs] extracted to your source directory obtained from SVN. ie your-working-path/source/trunk/mingwlibs. Therefore mingwlibs is at the same directory level as AI, lua and the omni directories.

====Running SCONS Configure====

*Open a console (Start -> Run -> cmd.exe -> Run)
*cd /where you checked it out in the previous step, if you checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
*type "scons configure"<enter>

Gotchas:
*if you get an error message starting with "EOFError: : env = Environement...", try deleting the file build/scons_signatures.dblite
*if you get an error message stating "ImportError: No module named win32file:", you have probably not installed the python-win32-extensions.

If all proceeds as intended you will see a message similar to:
"Everything seems OK. Run `scons' now to build."

====Compiling Spring====

* Open a console (Start -> Run -> cmd.exe -> Run)
* cd /path-to-where you checked it out in the previous step, if you use checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
* type '''scons configure'''<enter>, followed by '''scons'''<enter>
** Refer to '''scons --help''' for options that can be passed to scons configure
* Wait, this will take a while
* Copy over data files and stuff from official spring to the game dir (where spring.exe is created)
* Copy missing DLLs from mingwlibs/dll
* Start developing

If you are using Linux, refer to the [[SetupGuide]] to build Spring and get it running.

==Development Suggestions==

Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at the list of [[example projects]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

===How to get your code included===
If you create something that you think should be included in the official source tree, you can send an email to the development mailing list shown at [[Linux]] page. Sending your code in the form of a patch (also known as a .diff file), will make the chances of including it in the main code. Many patches are submitted to [http://spring.clan-sy.com/mantis Mantis].
It's also considered standard practice to post one's modifications in the [http://taspring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]

See [[Glossary]]

==Development links==
* [http://buildbot.no-ip.org/~buildbot/spring/executable/ Automatic builds (crosscompiled, mingw)]
* [http://buildbot.no-ip.org/~buildbot/spring/installer/ Automatic installer builds (crosscompiled, mingw)]
* [http://developer.berlios.de/projects/taspring-linux BerliOS project page (OLD)]
* [http://spring.clan-sy.com/mantis Bug Tracking System]
* [http://buildbot.no-ip.org:8010/ Buildbot]
* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
* [http://spring.clan-sy.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
* [http://www.unknown-files.net/spring/3801/mingwlibsv9/ Development libraries for MinGW]
* [http://lolut.utbm.info/cgi-bin/mailman/listinfo/taspring-linux Developers mailing list (practically dead, use this forum instead) (DOWN)]
* [http://buildbot.no-ip.org/~buildbot/spring/doxygen Doxygen pages of the latest source (regenerated nightly)]
* [http://spring.clan-sy.com/fisheye Fisheye interface to SVN]
* [http://sourceforge.net/projects/springrts SourceForge project page (OLD)]
* [http://buildbot.no-ip.org/~buildbot/spring/stacktraceTranslator.php StackTrace Translator]
* [https://spring.clan-sy.com/svn/spring/trunk/ Subversion repository]
* [http://spring.clan-sy.com/websvn/listing.php?repname=spring&path=%2F&sc=0 WebSVN]
* [http://spring.clan-sy.com/websvn/log.php?repname=spring&path=%2F&rev=0&sc=0&isdir=1 WebSVN link to "development log"]
* [http://spring.clan-sy.com/websvn/filedetails.php?repname=spring&path=%2Ftrunk%2FDocumentation%2Fchangelog.txt&rev=0&sc=0 WebSVN link to the most recent changelog.txt]

[[Category:Development]] [[Category:Source development]]

Development:Main

2007-10-28T16:58:54Z

Zyzy: /* Source Code Documentation */

Outlined below is information on assisting with the development of the Spring source itself.

::NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.

Below you can find information on how to work with the Spring source in the current mainline (Windows platform) if you like to work on another platform (Linux & Mac) please look at the bottem of this page under "Multiplatform development"

==Starting Development==
To start development, you will need
#The latest version of the source
#A good code manipulation program
#Compiling your modified source

== Keep track what others do ==
If you develop with others, you need to know what they do. Fisheye is a very handy svn helper, we currently use:
http://spring.clan-sy.com/fisheye

===Source Code Documentation===
A good place to start is the source code documentation, which can be found here: [http://taspring.clan-sy.com/doxygen/ doxygen] need to be change, osrts is out

An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]
page.

===Obtaining the Source===

Update: the latest SVN is at: [https://taspring.clan-sy.com/svn/spring https://taspring.clan-sy.com/svn/spring]

Another option is to manually download it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with SVN access.

windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
[http://www.syntevo.com/smartsvn/index.jsp SmartSVN] (Java) and [http://tortoisesvn.tigris.org TortoiseSVN] (MSI).

assuming that you are using the Subversion svn client you can download the latest SVN source with

<code>svn.exe checkout https://taspring.clan-sy.com/svn/spring/trunk</code>

it will create a trunk subdirectory in the directory from where you ran it, which will contain the source code root directory which will be later referred to as /taspring

===Learning C++===
You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]

However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

===Modifying and Compiling the Source===

The build environment on Windows changed a few releases ago to SCONS/mingw

If you will be developing on Windows you are recommended to use SCONS/mingw, using the SVN version.

See [[Development_IDEs]]. You have either to use the SCons build system that is multi platform, or use the vcproj for building spring in Visual Studio 2003 or Visual Studio 2005.
A list of required libraries as well as pre-built packages of these follows.

*[http://www.boost.org Boost C++ library]
*[http://www.openal.org OpenAL Audio library]
*[http://glew.sf.net GLEW (OpenGL extension loading)]
*[http://www.winimage.com/zLibDll/ zlib + minizip]
*[http://www.libsdl.org SDL]
*[http://openil.sf.net DevIL (Image loading)]
*[http://www.freetype.org Freetype font rendering]

*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=49257#49257 Pre-Built packages of most of the dependencies].
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=56846#56846 Pre-Built boost for VS8]. *note - probably not needed

*[http://msdn.microsoft.com/directx/sdk/ DirectX SDK] (Windows, Visual Studio C++ only)
*PlatformSDK (Windows, Visual Studio C++ Only)
I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download.
Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
After installing them, open Visual C++.
Click Tools >> Options >> Projects and Solutions >> VC++ Directories.

Add these entries to the corresponding sections (paths just a reference, yours may be different):
*Include files:
**$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
**$(ProgramFiles)\Microsoft Platform SDK\include
*Library files:
**$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86
***Might need \x64 on a 64-bit platform, I don't know.
**$(ProgramFiles)\Microsoft Platform SDK\lib

'''The following are for building with SCONS/MinGW'''

*[http://prdownloads.sourceforge.net/dev-cpp/devcpp-4.9.9.2_setup.exe Dev-Cpp installer] / [MinGW] Though I would not advise mingw because you have to set it up your self, and this is harder than it sounds. Note that Code:Blocks mingw setup is not sufficient. *note - dev-cpp seems to have been abandoned
*[http://www.python.org/ftp/python/2.4.2/python-2.4.2.msi Python 2.4 installer]
*[http://prdownloads.sourceforge.net/pywin32/pywin32-208.win32-py2.4.exe?download Python win32 extensions installer]
*[http://prdownloads.sourceforge.net/scons/scons-0.96.1.win32.exe Scons installer]

====Development System Setup====

See [http://spring.clan-sy.com/phpbb/viewtopic.php?p=49257 Compiling spring (mingw and visual studio 7/8)] and [[Installing Visual C plus plus]] for instructions.

*Make sure C:\Python24 and C:\Dev-Cpp\bin are in your PATH environment variable.
*Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (Change paths where appropriate.)
**Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP).
*Checkout the TA Spring SVN repository into your working area.
*You will also need the [http://spring.clan-sy.com/dl/spring-mingwlibs.exe MinGW/DevCPP libs] extracted to your source directory obtained from SVN. ie your-working-path/source/trunk/mingwlibs. Therefore mingwlibs is at the same directory level as AI, lua and the omni directories.

====Running SCONS Configure====

*Open a console (Start -> Run -> cmd.exe -> Run)
*cd /where you checked it out in the previous step, if you checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
*type "scons configure"<enter>

Gotchas:
*if you get an error message starting with "EOFError: : env = Environement...", try deleting the file build/scons_signatures.dblite
*if you get an error message stating "ImportError: No module named win32file:", you have probably not installed the python-win32-extensions.

If all proceeds as intended you will see a message similar to:
"Everything seems OK. Run `scons' now to build."

====Compiling Spring====

* Open a console (Start -> Run -> cmd.exe -> Run)
* cd /path-to-where you checked it out in the previous step, if you use checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
* type '''scons configure'''<enter>, followed by '''scons'''<enter>
** Refer to '''scons --help''' for options that can be passed to scons configure
* Wait, this will take a while
* Copy over data files and stuff from official spring to the game dir (where spring.exe is created)
* Copy missing DLLs from mingwlibs/dll
* Start developing

If you are using Linux, refer to the [[SetupGuide]] to build Spring and get it running.

==Development Suggestions==

Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at the list of [[example projects]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

===How to get your code included===
If you create something that you think should be included in the official source tree, you can send an email to the development mailing list shown at [[Linux]] page. Sending your code in the form of a patch (also known as a .diff file), will make the chances of including it in the main code. Many patches are submitted to [http://spring.clan-sy.com/mantis Mantis].
It's also considered standard practice to post one's modifications in the [http://taspring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]

See [[Glossary]]

[[Category:Development]] [[Category:Source development]]