|
|
| (94 intermediate revisions by 19 users not shown) |
| Line 1: |
Line 1: |
| Outlined below is information on assisting with the development of the Spring source itself.
| | {|width="100%" style="border: 0px; border-spacing:0px" |
| | |width="500px" valign="top" style="padding-left:10px; padding-right:10px"| |
|
| |
|
| ::<small>NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.</small> | | '''[https://github.com/spring/spring GitHub and Source Code]''' |
|
| |
|
| 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"
| | Engine source code<br> |
|
| |
|
| ==Starting Development==
| | '''[[Links|Important Links]]''' |
| 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 ==
| | Important Community and Development links to git repos & subprojects.<br> |
| 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]]
| | '''[[Building spring|Compiling Engine]]''' |
| page.
| |
|
| |
|
| ===Obtaining the Source===
| | How to build the Spring engine from source.<br> |
|
| |
|
| 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.
| | '''[[Development:Getting_Started|Engine Development]]''' |
|
| |
|
| windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
| | Information regarding contributing to the source code of the Spring engine. |
| [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>
| | '''[[Lobby_Development|Lobby Development (Clients and Servers)]]''' |
|
| |
|
| 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
| | Information regarding contributing to the source code of the different lobby clients and servers available for Spring. |
|
| |
|
| ===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.
| | '''[[Gamedev:Main|Game Development]]''' |
|
| |
|
| ===Modifying and Compiling the Source===
| | Lots of links to valuable Articles and forum threads regarding Game, Mod & Unit Development. |
|
| |
|
| 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.
| | '''[[Mapdev:Main|Map Development]]''' |
|
| |
|
| 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.
| | Tutorials and other useful information for creating maps. |
| 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].
| | '''[[Lua_Scripting|Lua Development]]''' |
| *[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)
| | Information regarding the use of the supplementary Lua scripting language for Widgets and beyond. |
| *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
| |
|
| |
|
| | '''[[AI:Development|AI Development]]''' |
|
| |
|
| '''The following are for building with SCONS/MinGW'''
| | All you ever wanted to know about Skirmish AI Development for Spring, and more. This includes Skirmish and Lua AIs. |
|
| |
|
| *[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====
| | '''[[Infrastructure:Development|Infrastructure Development]]''' |
|
| |
|
| 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.
| | Information about springs infrastructure |
|
| |
|
| *Make sure C:\Python24 and C:\Dev-Cpp\bin are in your PATH environment variable.
| | |valign="top" style="padding:0px"| |
| *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==== | | == Quick Links == |
|
| |
|
| *Open a console (Start -> Run -> cmd.exe -> Run)
| | {|width="100%" class="" |
| *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
| | ! '''[http://spring.clan-sy.com/phpbb/viewforum.php?f=12 Development forums]''' |
| *type "scons configure"<enter>
| | |- |
| | | Look at the development forums for ongoing progress and discussion |
| | |} |
|
| |
|
| 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:
| | {|width="100%" class="" |
| "Everything seems OK. Run `scons' now to build."
| | ! '''[http://springrts.com/mantis/ Report Bugs]''' |
| | |- |
| | | Submit patches and bug reports here |
| | |} |
|
| |
|
| ====Compiling Spring====
| |
|
| |
|
| * Open a console (Start -> Run -> cmd.exe -> Run)
| | {|width="100%" class="" |
| * 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
| | ! '''[https://github.com/spring/spring/ Source Code]''' |
| * type '''scons configure'''<enter>, followed by '''scons'''<enter>
| | |- |
| ** Refer to '''scons --help''' for options that can be passed to scons configure
| | | View and fork the project on GitHub. |
| * 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.
| | {|width="100%" class="" |
| | ! '''[https://github.com/spring/spring/commits/develop.atom Commit Newsfeed]''' |
| | |- |
| | |View git commits as they happen. |
| | |} |
|
| |
|
| ===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]] | | [[Category: Development]] |
