Spring - User contributions [en]

Lobby Development

2011-01-08T00:47:23Z

Agon:

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The official lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

You can [http://cgit.springlobby.info/cgit/aegis/uberserver.git/ browse the sources] or download them using its git repository (git://springlobby.info/git/aegis/uberserver.git).

[[Category: Lobbies]]

Lobby Development

2011-01-08T00:46:15Z

Agon: Add PythonBotFramework and GoSLC

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The official lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

You can [http://cgit.springlobby.info/cgit/aegis/uberserver.git/ browse the sources] or download them using its git repository (git://springlobby.info/git/aegis/uberserver.git).

[[Category: Lobbies]]

Linux:Packaging

2010-09-09T22:10:30Z

Agon: /* OpenSuSe */ Agon is back with updated packages

[[Linux_Page|Linux]] < {{FULLPAGENAME}}

= Linux Packaging =

== Packagers ==

Nicknames and how to best contact them.

=== [[Ubuntu_install|Ubuntu]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-ubuntu.png|link=Ubuntu_install}}
'''Tobi''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=596 Forum:''Tobi''], Lobby:''[RoX]Tobi''

'''det''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=1213 Forum:''det''], Lobby:''*det*??''

'''YokoZar''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5670 Forum:''YokoZar''], Lobby:''*YokoZar*??''

=== [[Debian_install|Debian]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-debian.png|link=Debian_install}}
'''mammadori''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=9045 Forum:''mammadori''], Lobby:''*mammadori*??''

'''jandd''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=9301 Forum:''jandd''], Lobby:''*jandd*??''

=== [[Slackware_install|Slackware]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-slackware.png|link=Slackware_install}}
(no one)

=== [[Mandriva_install|Mandriva]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-mandriva_linux.png|link=Mandriva_install}}
(no one?)

=== [[OpenSUSE_install|OpenSuSe]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-opensuse_linux.png|link=OpenSUSE_install}}
'''Agon''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5514 Forum:''Agon''], Lobby:''*Agon|*basket''

'''cghislai''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=10114 Forum:''cghislai'']

=== [http://projects.springlobby.info/projects/springlobby/wiki/Install#Fedora-10 Fedora] ===
{{navimg|xsize=48|ysize=48|image=Distributions-fedora.png|link=http://projects.springlobby.info/projects/springlobby/wiki/Install#Fedora-10}}
(unknown)

=== [[Gentoo_install|Gentoo]] ===
{{navimg|xsize=48|ysize=48|image=Distributions-gentoo.png|link=Gentoo_install}}
'''Auswaschbar''' - [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5613 Forum:''Auswaschbar''], Lobby:''*Auswaschbar''

'''iElectric''', #sy@quakenet:''iElectric''

== Guidelines ==

''Note:'' This section is only of interest for Linux package maintainers.

Here we outline the packaging scheme currently recommended by the engine development team.

=== Binary Distros ===

We recommend using <code>CMAKE_BUILD_TYPE=RELWITHDEBINFO</code>, and later splitting the debug symbols off into separate files with a command like this:

<code>##STUB##</code>

'''main packages (''package'' ~ ''deps''):'''
<pre>
springrts-gamedata
springrts-engine-default ~ springrts-gamedata
springrts-engine-default-dbg ~ springrts-engine
springrts-engine-dedicated
springrts-engine-dedicated-dbg ~ springrts-engine-dedicated
springrts-engine-multithreaded ~ springrts-gamedata
springrts-engine-multithreaded-dbg ~ springrts-engine-multithreaded
springrts-engine-headless ~ springrts-gamedata
springrts-engine-headless-dbg ~ springrts-engine-headless
springrts-unitsync ~ springrts-gamedata
springrts-unitsync-dbg ~ springrts-unitsync
</pre>

'''meta packages:'''
<pre>springrts-engine ~ springrts-engine-default springrts-engine-multithreaded
springrts-engine-dbg ~ springrts-engine springrts-engine-default-dbg springrts-engine-multithreaded-dbg
springrts ~ springrts-engine unitsync
springrts-dbg ~ springrts springrts-engine-dbg unitsync-dbg
</pre>

=== Source Distros ===

<pre>
springrts [default -dedicated -headless multithreaded unitsync]
</pre>

AI:Development:Interface

2010-03-12T16:11:33Z

Agon: Mono interface is in inactive development, lowercase some words

== AI interfaces and wrappers ==

==== Introduction ====
For an explanation of what AI interfaces and wrappers are,
have a look at the [[AI:Development:System|AI Interface system]] page.

==== In active development ====

; '''[[AIInterface:C|C & C++ AI ''Interface'']]''' : ~stable, basically just a stub plugin, forwarding the plain C AI Interface, do not use directly, but through a wrapper 
; '''[[AIWrapper:LegacyCpp|Legacy C++ AI Wrapper]]''' : deprecated, ensures AIs written for springs old C++ AI interface can still be used 
; '''[[AIWrapper:Cpp|New C++ AI Wrapper]]''' : alpha, allows writing C++ AIs using the new OO structure and all possibilities of the C Interface 
; '''[[AIInterface:Java|Java AI ''Interface'']]''' : ~stable, loads AIs written in any language supported by the JVM 
; '''[[AIWrapper:ModularAI|ModularAI ''Wrapper'']]''' : beta, simplifies handling of Units and provides a lot of common functionality for Java AIs 

==== In inactive development ====

; '''[[AIInterface:Mono|Mono AI ''Interface'']]''' : beta, will support loading AIs written in a '''[http://en.wikipedia.org/wiki/Common_Language_Infrastructure CLI]''' language 

''' [[AIs|<- Back to AI page]]'''

[[Category: AI]]
[[Category: Development]]

GSoC New map format

2010-03-11T22:56:26Z

Agon: GSoC New map format page

= GSoC idea: A new map format. =

== Why ==
Spring has at the moment two map formats. SM2 which is used mostly but old and requires a lot of storage. SM3 is newer but still isn't perfect and doesn't have brand new technologies included, like most new commercial map formats have.

== Required skills ==
* C++
* OpenGL

== Difficulty ==
Estimated: medium to hard

* Design a new map format, communicate with the community
* Implement a first draft
* Extend the draft until the map format is playable
* Add visual improvements to the map format

== Possible Mentor(s) ==

[http://springrts.com/phpbb/viewtopic.php?f=61&t=21910 FORUMLINK]

[[Google_Summer_of_Code_2010]]

Google Summer of Code 2010

2010-03-11T22:50:42Z

Agon: GSoC New map format

[[Image:GSOC.png]]

= Project proposals =

This is the list of project ideas for students willing to work on the Spring engine during the Google Summer of Code 2010.

== New map format ==

Estimated difficulty: medium to hard

Spring has at the moment two map formats. SM2 which is used mostly but old and requires a lot of storage. SM3 is newer but still isn't perfect and doesn't have brand new technologies included, like most new commercial map formats have.

The goal of this proposal would be a map format that doesn't consist of a giant texture layered on top of a basic height mesh, but something smarter. Look at e.g. DOW2 for inspiration. Not supporting heightmap deformation is acceptable, provided the pros outweigh the cons.

[[GSoC_New_map_format]]

== An IDE for Spring game developing ==

Estimated difficulty: medium

At the moment Spring as a game engine project has no dedicated IDE for developing Spring games which would allow easier developing of Spring games.
A new IDE or plugins/addins for an existing IDE like Eclipse would lower the barrier for new developers. Speeding up the developing process and managing the huge amount of files which come with most games would allow developers to focus more on the content than on organization.

The IDE should handle most of the typical Spring files like Lua files, textures and models. A few templates for project startups and Spring file types should be created.
Syntax highlighting, auto-completion (including Spring functions) and text snippets for Lua should be included in the IDE. A texture and model editor which can export/import and modify simple options would be nice, too.

[[GSoC_Spring_IDE]]

== Limited play area ==

Estimated difficulty: medium

Current spring map formats have an harcoded rectangle geometry, also they provide very limited support for defining aestetics of the surrounding environment outside the play area.

The new system should allow the map to restrict the playable area to a subset of the global area, possibly adding support for multiple shapes and/or non rectangular shape restrictions.

The restriction shapes should be readable and changeable mid-game trough the engine's Lua API. Proper handling of units which are suddenly off-map needs to be implemented.

[[GSoC_Limited_play_area]]

== Sensor handling redesign / simplification ==

Estimated difficulty: hard

Currently there are a number of different "sensor" systems in the engine: LineOfSight, Radar, Sonar, Seismic. Some can be jammed, some can not. Some respect terrain, and some are always circular.

A new sensor system should integrate the current LOS, Radar, Sonar, Seismic systems, to reduce amount of code per functionality, and eventually add additional features wich would be then available for all types.

Preferably this all should also be faster than the current system, or a compelling argument/experiment should be made that shows there can not be a faster system with the same features.

[[GSoC_Sensor_handling_redesign]]

== Engine level abstraction of resources ==

Estimated difficulty: medium to hard

The Spring engine has it's roots in being a Total Annihilation clone; even if such intent has been dropped since quite some time, the TA resource system is largely present in the codebase being hardcoded in a lot of critical places.

The old system needs to be replaced, the new one should be enough flexible to reproduce everything that the old system did and be able to imitate the behaviour of most common RTS game titles.

The engine's Lua API to fetch resources will have to be adapted to the new system, and new calls will have to be added to edit it.

[[GSoC_Engine_resource_abstraction]]

== Basic ingame lobby ==

Estimated difficulty: hard

All existing Spring interfaces (lobbies) are either difficult to customize for game developers or have a different look 'n feel from the game itself and require focus switch from the game itself to operate.

A new, Lua scriptable lobby should be implemented with customization and control in the mind, possibly integrated with spring codebase and/or running as a separate process overlaying to the game's UI.

Optionally, the engine's start screen should be replaced and integrated with it.

[[GSoC_Ingame_lobby]]

== Smarter pathfinder ==

Estimated difficulty: hard

Spring's pathfinder uses a 2d grid and is somewhat limited in functionality.
A partial/full rewrite should be introduced to add support for navigating using more than 8 primary directions and selectively ignore certain unit types for performance reasons.

Spring's Lua API should be extended to allow game developers to push new nodes/links and be able to alter or delete existing ones. (for pathfinder-aware tunnels/teleporting/etc.)

Preferably this all should also be faster then the current system, or a compelling argument/experiment should be made that shows there can not be a faster system with the same features.

[[GSoC_Smarter_pathfinder]]

== More AI interfaces ==

Estimated difficulty: medium

The Spring engine's AI interface supports bindings for multiple languages, currently legacy C++, C and java are supported.

Bindings for more languages and/or virtual machines should be added to allow broader AI developing audience (for example: Ruby, Perl, JavaScript, Python, D, Go, Mono, LLVM, Parrot).

[[GSoC_More_AI_interfaces]]

== New Rendering System ==

Estimated difficulty: below medium

The Spring rendering engine uses a lot of FFP (fixed function pipeline) OpenGL functions. This model is becoming deprecated and is generally slower than shader usage and less flexible.

The rendering code should get a complete overhaul using modern graphic programming techniques such as shaders, implement load support for more standardized model formats (backwards compatibility with current available formats is mandatory either trough direct load or automatic conversion to the new types) and eventually introduce some graphic enhancing features (bump mapping, normal mapping, multitexturing, etc.)

OpenGL ES 2.0 compatibility should be aimed at where possible.

[[GSoC_New_rendering_system]]

== Reconnect / Host change during a match ==

Estimated difficulty: medium to hard

Spring's network model implies the existance of a server to host a battle. For various reasons the network link between host and clients can die, so a system should be designed to allow manual and/or automatic switching of the game's host (possibly using an existing player after testing load handling capabilities) and manual and/or automatic reconnection from client side if host remains the same.

[[GSoC_Reconnect_Host_change]]

GSoC Spring IDE

2010-03-11T22:37:23Z

Agon: GSoC Spring IDE page

= GSoC idea: An IDE for Spring game developing. =

== Why ==
At the moment Spring as a game engine project has no dedicated IDE for developing Spring games which would allow easier developing of Spring games. A new IDE or plugins/addins for an existing IDE like Eclipse would lower the barrier for new developers. Speeding up the developing process and managing the huge amount of files which come with most games would allow developers to focus more on the content than on organization.

== Required skills ==
* An understanding of Springs file types.
* A knowledge of a programming language or the language of the targeted IDE

== Difficulty ==
Estimated: medium

* Use an existing cross platform IDE (or create a new IDE)
* Add a plugin which handles common Spring file types
* A Lua plugin should handle syntax highlighting, auto-completion (including Spring functions) and text snippets
* A texture and mode editor (import/export/modify)
* Templates for projects and file types related to Spring

== Possible Mentor(s) ==

[http://springrts.com/phpbb/viewtopic.php?f=61&t=22428 FORUMLINK]

[[Google_Summer_of_Code_2010]]

Google Summer of Code 2010

2010-03-11T22:30:09Z

Agon: GSoC Spring IDE

[[Image:GSOC.png]]

= Project proposals =

This is the list of project ideas for students willing to work on the Spring engine during the Google Summer of Code 2010.

== An IDE for Spring game developing ==

Estimated difficulty: medium

At the moment Spring as a game engine project has no dedicated IDE for developing Spring games which would allow easier developing of Spring games.
A new IDE or plugins/addins for an existing IDE like Eclipse would lower the barrier for new developers. Speeding up the developing process and managing the huge amount of files which come with most games would allow developers to focus more on the content than on organization.

The IDE should handle most of the typical Spring files like Lua files, textures and models. A few templates for project startups and Spring file types should be created.
Syntax highlighting, auto-completion (including Spring functions) and text snippets for Lua should be included in the IDE. A texture and model editor which can export/import and modify simple options would be nice, too.

[[GSoC_Spring_IDE]]

== Limited play area ==

Estimated difficulty: medium

Current spring map formats have an harcoded rectangle geometry, also they provide very limited support for defining aestetics of the surrounding environment outside the play area.

The new system should allow the map to restrict the playable area to a subset of the global area, possibly adding support for multiple shapes and/or non rectangular shape restrictions.

The restriction shapes should be readable and changeable mid-game trough the engine's Lua API. Proper handling of units which are suddenly off-map needs to be implemented.

[[GSoC_Limited_play_area]]

== Sensor handling redesign / simplification ==

Estimated difficulty: hard

Currently there are a number of different "sensor" systems in the engine: LineOfSight, Radar, Sonar, Seismic. Some can be jammed, some can not. Some respect terrain, and some are always circular.

A new sensor system should integrate the current LOS, Radar, Sonar, Seismic systems, to reduce amount of code per functionality, and eventually add additional features wich would be then available for all types.

Preferably this all should also be faster than the current system, or a compelling argument/experiment should be made that shows there can not be a faster system with the same features.

[[GSoC_Sensor_handling_redesign]]

== Engine level abstraction of resources ==

Estimated difficulty: medium to hard

The Spring engine has it's roots in being a Total Annihilation clone; even if such intent has been dropped since quite some time, the TA resource system is largely present in the codebase being hardcoded in a lot of critical places.

The old system needs to be replaced, the new one should be enough flexible to reproduce everything that the old system did and be able to imitate the behaviour of most common RTS game titles.

The engine's Lua API to fetch resources will have to be adapted to the new system, and new calls will have to be added to edit it.

[[GSoC_Engine_resource_abstraction]]

== Basic ingame lobby ==

Estimated difficulty: hard

All existing Spring interfaces (lobbies) are either difficult to customize for game developers or have a different look 'n feel from the game itself and require focus switch from the game itself to operate.

A new, Lua scriptable lobby should be implemented with customization and control in the mind, possibly integrated with spring codebase and/or running as a separate process overlaying to the game's UI.

Optionally, the engine's start screen should be replaced and integrated with it.

[[GSoC_Ingame_lobby]]

== Smarter pathfinder ==

Estimated difficulty: hard

Spring's pathfinder uses a 2d grid and is somewhat limited in functionality.
A partial/full rewrite should be introduced to add support for navigating using more than 8 primary directions and selectively ignore certain unit types for performance reasons.

Spring's Lua API should be extended to allow game developers to push new nodes/links and be able to alter or delete existing ones. (for pathfinder-aware tunnels/teleporting/etc.)

Preferably this all should also be faster then the current system, or a compelling argument/experiment should be made that shows there can not be a faster system with the same features.

[[GSoC_Smarter_pathfinder]]

== More AI interfaces ==

Estimated difficulty: medium

The Spring engine's AI interface supports bindings for multiple languages, currently legacy C++, C and java are supported.

Bindings for more languages and/or virtual machines should be added to allow broader AI developing audience (for example: Ruby, Perl, JavaScript, Python, D, Go, Mono, LLVM, Parrot).

[[GSoC_More_AI_interfaces]]

== New Rendering System ==

Estimated difficulty: below medium

The Spring rendering engine uses a lot of FFP (fixed function pipeline) OpenGL functions. This model is becoming deprecated and is generally slower than shader usage and less flexible.

The rendering code should get a complete overhaul using modern graphic programming techniques such as shaders, implement load support for more standardized model formats (backwards compatibility with current available formats is mandatory either trough direct load or automatic conversion to the new types) and eventually introduce some graphic enhancing features (bump mapping, normal mapping, multitexturing, etc.)

OpenGL ES 2.0 compatibility should be aimed at where possible.

[[GSoC_New_rendering_system]]

== Reconnect / Host change during a match ==

Estimated difficulty: medium to hard

Spring's network model implies the existance of a server to host a battle. For various reasons the network link between host and clients can die, so a system should be designed to allow manual and/or automatic switching of the game's host (possibly using an existing player after testing load handling capabilities) and manual and/or automatic reconnection from client side if host remains the same.

[[GSoC_Reconnect_Host_change]]

SpringEngineTODO

2009-03-10T21:04:25Z

Agon: format fix

A collection of ideas which could improve Spring.

* add general serializing to the engine, which touches the following:
** Implement saving/loading. There are a lot of direct LoadSave() functions in the game code, but the easier way would probably to finish the serialization in the class registration type interfaces (rts/System/creg), so everything can be serialized automatically.
*** Requires: C/C++
*** Time: ~3 months
*** Level of difficulty: medium - hard
** [[Syncing System|Implement re-sync]]. After a sync problem is detected, and a re-sync of the random seed does not fix it the game would pause and use the rsync to adjust game state (current plan if for float3 data) to resync. After using rsync on it should be able to continue normally until the next sync error is detected.
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard
** Joining the game while it is running (probably need one of those 2 mentioned above: save/load or resync)
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

* Implement a general sensor system replacing the radars, as described in http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6105
** Requires: C/C++, 3D/2D math (Lua knowledge not required, but prefered)
** Time: ~2 months
** Level of difficulty: Medium

* Add a dynamic-lighting system: Allow units to have dynamic lights on them that affect lighting of other units and landscape, with sort of "approximating lights" for cases where a lot of units get close together. This is a big thing, but it would improve spring graphics a lot if done well. Or Deferred Lighting/Shading?
** Requires: C/C++, 3D math(, GLSL) (Lua knowledge not required, but prefered)
** Time: ~3 months
** Level of difficulty: Medium-hard

* Get a mac version working. Contact the developers on the forums for this, as there are people who build and run it successfully. Still need proper packaging and maintaining,
** Requires: C/C++, CMake and MacOS
** Time: < 1 month
** Level of difficulty: Medium

* Extending the resource system to allow more than two resources (metal/energy)
** Requires: C/C++ (Lua knowledge not required, but prefered)
** Time: ~1-3 months
** Level of difficulty: Easy-Medium

* Expand Springs script abilities by adding new languages for mods/games, maps, player helpers (widgets).
** Requires: C/C++, CMake and another language
** Time: ~3< months (depends on the language/goal)
** Level of difficulty: Medium

* Exposing more Spring functions to the Lua world (command AIs, move types) or/and small frameworks
** Requires: basic C/C++, Lua
** Time: ~1-3< months (depends on the goal)
** Level of difficulty: Easy-medium

* Implement MD5 as a model format or add other model formats.
** Requires: C/C++, 3D math (Lua knowledge not required, but prefered)
** Time: ~1-3 months
** Level of difficulty: Medium

* Fix SM3 or develop a new mapping format
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

* Add p2p/round-robin for hosting (so host exit doesn't stop the game)
** Requires: C/C++, network programming
** Time: ~3< months
** Level of difficulty: Medium

* Proper GUI for spring.exe with extended singleplayer abilities, better map/mod browsing, adding Bots (AIs), selecting start positions, choosing color, selecting map/mod options.
** Requires: C/C++, 3D math, GUI programming, OpenGL programming, Lua
** Time: ~1-3 moths (depends on the amount of functions)
** Level of difficulty: Medium

* Fix bugs, extend and improve functionality, etc.

Even though this isn't really about the Spring engine:

* SpringLobby is a cross-platform lobby client, implemented in C++ and wxWidgets. We encourage you to look into our todo list on http://springlobby.info and see what you could do for it.

Lua:

* Create a Mission Development Kit: ie, do whatever it takes to make it easy to create campaign missions, eg create a gui tool that makes it easy to place units on the map, create triggers, and so on.

[[Category:Source development]]

SpringEngineTODO

2009-03-10T20:54:55Z

Agon: format fix

A collection of ideas which could improve Spring.

* add general serializing to the engine, which touches the following:
** Implement saving/loading. There are a lot of direct LoadSave() functions in the game code, but the easier way would probably to finish the serialization in the class registration type interfaces (rts/System/creg), so everything can be serialized automatically.
*** Requires: C/C++
*** Time: ~3 months
*** Level of difficulty: medium - hard

** [[Syncing System|Implement re-sync]]. After a sync problem is detected, and a re-sync of the random seed does not fix it the game would pause and use the rsync to adjust game state (current plan if for float3 data) to resync. After using rsync on it should be able to continue normally until the next sync error is detected.
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

** Joining the game while it is running (probably need one of those 2 mentioned above: save/load or resync)
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

* Implement a general sensor system replacing the radars, as described in http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6105
** Requires: C/C++, 3D/2D math
** Time: ~2 months
** Level of difficulty: Medium

* Add a dynamic-lighting system: Allow units to have dynamic lights on them that affect lighting of other units and landscape, with sort of "approximating lights" for cases where a lot of units get close together. This is a big thing, but it would improve spring graphics a lot if done well. Or Deferred Lighting/Shading?
** Requires: C/C++, 3D math(, GLSL)
** Time: ~3 months
** Level of difficulty: Medium-hard

* Get a mac version working. Contact the developers on the forums for this, as there are people who build and run it successfully. Still need proper packaging and maintaining,
** Requires: C/C++, CMake and MacOS
** Time: -
** Level of difficulty: Medium

* Extending the resource system to allow more than two resources (metal/energy)
** Requires: C/C++
** Time: ~1-3 months
** Level of difficulty: Easy-Medium

* Expand Springs script abilities by adding new languages for mods/games, maps, player helpers (widgets).
** Requires: C/C++, CMake and another language
** Time: ~3< months (depends on the language/goal)
** Level of difficulty: Medium

* Exposing more Spring functions to the Lua world (command AIs, move types) or/and small frameworks
** Requires: basic C/C++, Lua
** Time: ~1-3< months (depends on the goal)
** Level of difficulty: Easy-medium

* Implement MD5 as a model format or add other model formats.
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

* Fix SM3 or develop a new mapping format
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

* Add p2p/round-robin for hosting (so host exit doesn't stop the game)
** Requires: C/C++, network programming
** Time: ~3< months
** Level of difficulty: Medium

* Proper GUI for spring.exe with extended singleplayer abilities, better map/mod browsing, adding Bots (AIs), selecting start positions, choosing color, selecting map/mod options.
** Requires: C/C++, 3D math, GUI programming, OpenGL programming
** Time: ~1-3 moths (depends on the amount of functions)
** Level of difficulty: Medium

* Fix bugs, extend and improve functionality, etc.

Even though this isn't really about the Spring engine:

* SpringLobby is a cross-platform lobby client, implemented in C++ and wxWidgets. We encourage you to look into our todo list on http://springlobby.info and see what you could do for it.

Lua:

* Create a Mission Development Kit: ie, do whatever it takes to make it easy to create campaign missions, eg create a gui tool that makes it easy to place units on the map, create triggers, and so on.

[[Category:Source development]]

SpringEngineTODO

2009-03-10T20:54:07Z

Agon: removed small ai framework idea

A collection of ideas which could improve Spring.

* add general serializing to the engine, which touches the following:
** Implement saving/loading. There are a lot of direct LoadSave() functions in the game code, but the easier way would probably to finish the serialization in the class registration type interfaces (rts/System/creg), so everything can be serialized automatically.
*** Requires: C/C++
*** Time: ~3 months
*** Level of difficulty: medium - hard

** [[Syncing System|Implement re-sync]]. After a sync problem is detected, and a re-sync of the random seed does not fix it the game would pause and use the rsync to adjust game state (current plan if for float3 data) to resync. After using rsync on it should be able to continue normally until the next sync error is detected.
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

** Joining the game while it is running (probably need one of those 2 mentioned above: save/load or resync)
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

* Implement a general sensor system replacing the radars, as described in http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6105
** Requires: C/C++, 3D/2D math
** Time: ~2 months
** Level of difficulty: Medium

* Add a dynamic-lighting system: Allow units to have dynamic lights on them that affect lighting of other units and landscape, with sort of "approximating lights" for cases where a lot of units get close together. This is a big thing, but it would improve spring graphics a lot if done well. Or Deferred Lighting/Shading?
** Requires: C/C++, 3D math(, GLSL)
** Time: ~3 months
** Level of difficulty: Medium-hard

* Get a mac version working. Contact the developers on the forums for this, as there are people who build and run it successfully. Still need proper packaging and maintaining,
** Requires: C/C++, CMake and MacOS
** Time: -
** Level of difficulty: Medium

* Extending the resource system to allow more than two resources (metal/energy)
** Requires: C/C++
** Time: ~1-3 months
** Level of difficulty: Easy-Medium

* Expand Springs script abilities by adding new languages for mods/games, maps, player helpers (widgets).
** Requires: C/C++, CMake and another language
** Time: ~3< months (depends on the language/goal)
** Level of difficulty: Medium

* Exposing more Spring functions to the Lua world (command AIs, move types) or/and small frameworks
** Requires: basic C/C++, Lua
** Time: ~1-3< months (depends on the goal)
** Level of difficulty: Easy-medium

* Implement MD5 as a model format or add other model formats.
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

** Fix SM3 or develop a new mapping format
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

* Add p2p/round-robin for hosting (so host exit doesn't stop the game)
** Requires: C/C++, network programming
** Time: ~3< months
** Level of difficulty: Medium

* Proper GUI for spring.exe with extended singleplayer abilities, better map/mod browsing, adding Bots (AIs), selecting start positions, choosing color, selecting map/mod options.
** Requires: C/C++, 3D math, GUI programming, OpenGL programming
** Time: ~1-3 moths (depends on the amount of functions)
** Level of difficulty: Medium

* Fix bugs, extend and improve functionality, etc.

Even though this isn't really about the Spring engine:

* SpringLobby is a cross-platform lobby client, implemented in C++ and wxWidgets. We encourage you to look into our todo list on http://springlobby.info and see what you could do for it.

Lua:

* Create a Mission Development Kit: ie, do whatever it takes to make it easy to create campaign missions, eg create a gui tool that makes it easy to place units on the map, create triggers, and so on.

[[Category:Source development]]

SpringEngineTODO

2009-03-10T20:51:11Z

Agon: requires knowledge, time, difficulty added

A collection of ideas which could improve Spring.

* add general serializing to the engine, which touches the following:
** Implement saving/loading. There are a lot of direct LoadSave() functions in the game code, but the easier way would probably to finish the serialization in the class registration type interfaces (rts/System/creg), so everything can be serialized automatically.
*** Requires: C/C++
*** Time: ~3 months
*** Level of difficulty: medium - hard

** [[Syncing System|Implement re-sync]]. After a sync problem is detected, and a re-sync of the random seed does not fix it the game would pause and use the rsync to adjust game state (current plan if for float3 data) to resync. After using rsync on it should be able to continue normally until the next sync error is detected.
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

** Joining the game while it is running (probably need one of those 2 mentioned above: save/load or resync)
*** Requires: C/C++, network programming
*** Time: ~3< months
*** Level of difficulty: Hard

* Implement a general sensor system replacing the radars, as described in http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6105
** Requires: C/C++, 3D/2D math
** Time: ~2 months
** Level of difficulty: Medium

* Add a dynamic-lighting system: Allow units to have dynamic lights on them that affect lighting of other units and landscape, with sort of "approximating lights" for cases where a lot of units get close together. This is a big thing, but it would improve spring graphics a lot if done well. Or Deferred Lighting/Shading?
** Requires: C/C++, 3D math(, GLSL)
** Time: ~3 months
** Level of difficulty: Medium-hard

* Get a mac version working. Contact the developers on the forums for this, as there are people who build and run it successfully. Still need proper packaging and maintaining,
** Requires: C/C++, CMake and MacOS
** Time: -
** Level of difficulty: Medium

* Extending the resource system to allow more than two resources (metal/energy)
** Requires: C/C++
** Time: ~1-3 months
** Level of difficulty: Easy-Medium

* Expand Springs script abilities by adding new languages for mods/games, maps, player helpers (widgets).
** Requires: C/C++, CMake and another language
** Time: ~3< months (depends on the language/goal)
** Level of difficulty: Medium

* Exposing more Spring functions to the Lua world (command AIs, move types) or/and small frameworks
** Requires: basic C/C++, Lua
** Time: ~1-3< months (depends on the goal)
** Level of difficulty: Easy-medium

* Implement MD5 as a model format or add other model formats.
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

** Fix SM3 or develop a new mapping format
** Requires: C/C++, 3D math
** Time: ~1-3 months
** Level of difficulty: Medium

* Add p2p/round-robin for hosting (so host exit doesn't stop the game)
** Requires: C/C++, network programming
** Time: ~3< months
** Level of difficulty: Medium

* Proper GUI for spring.exe with extended singleplayer abilities, better map/mod browsing, adding Bots (AIs), selecting start positions, choosing color, selecting map/mod options.
** Requires: C/C++, 3D math, GUI programming, OpenGL programming
** Time: ~1-3 moths (depends on the amount of functions)
** Level of difficulty: Medium

* Fix bugs, extend and improve functionality, etc.

* Implement a small AI framework for general used functions like gathering nearest and best metal spots, detecting map type (land, land/water, water) or a unit group manager.
** Requires: C/C++, 3D/2D math
** Time: ~1-3< months (depends on the amount of functions)
** Level of difficulty: Medium

Even though this isn't really about the Spring engine:

* SpringLobby is a cross-platform lobby client, implemented in C++ and wxWidgets. We encourage you to look into our todo list on http://springlobby.info and see what you could do for it.

Lua:

* Create a Mission Development Kit: ie, do whatever it takes to make it easy to create campaign missions, eg create a gui tool that makes it easy to place units on the map, create triggers, and so on.

[[Category:Source development]]

SpringEngineTODO

2009-03-09T20:14:57Z

Agon: updated page + more ideas

A collection of ideas which could improve Spring.

* Implement saving/loading. There are a lot of direct LoadSave() functions in the game code, but the easier way would probably to finish the serialization in the class registration type interfaces (rts/System/creg), so everything can be serialized automatically.

* [[Syncing System|Implement re-sync]]. After a sync problem is detected, and a re-sync of the random seed does not fix it the game would pause and use the rsync to adjust game state (current plan if for float3 data) to resync. After using rsync on it should be able to continue normally until the next sync error is detected.

* Implement a general sensor system replacing the radars, as described in http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6105

* Add a dynamic-lighting system: Allow units to have dynamic lights on them that affect lighting of other units and landscape, with sort of "approximating lights" for cases where a lot of units get close together. This is a big thing, but it would improve spring graphics a lot if done well. Or Deferred Lighting/Shading?

* Get a mac version working. Contact the developers on the forums for this, as there are people looking into this already.

* Extending the resource system to allow more than two resources (metal/energy)

* Expand Springs script abilities by adding new languages or extending the available languages. Exposing more Spring functions to the Lua world (command AIs, move types).

* Implement MD5 as a model format or add other model formats.

* Extend SM3 (map format)

* Add p2p/round-robin for hosting (so host exit doesn't stop the game)

* Joining the game while it is running

* Proper GUI for spring.exe with extended singleplayer abilities, better map/mod browsing, adding Bots (AIs), selecting start positions, choosing color, selecting map/mod options.

* Implement a small AI framework for general used functions like gathering nearest and best metal spots, detecting map type (land, land/water, water) or a unit group manager.

Even though this isn't really about the Spring engine:

* SpringLobby is a cross-platform lobby client, implemented in C++ and wxWidgets. We encourage you to look into our todo list on http://springlobby.info and see what you could do for it.

Lua:

* Create a Mission Development Kit: ie, do whatever it takes to make it easy to create campaign missions, eg create a gui tool that makes it easy to place units on the map, create triggers, and so on.

[[Category:Source development]]

Google Summer of Code

2009-03-09T19:37:02Z

Agon: Initial add of gsoc information page

Spring is a open source real time strategy (rts) engine for Windows/Linux.
[http://spring.clan-sy.com/wiki/About More information about Spring]

= Introduction =

Possible projects for Google Summer of Code can be find in different locations.

* [[SpringEngineTODO]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=17627 GSoC forum topic]
* You can also come up with your own ideas

Please include the following in your proposal:

# A detailed description or design document of your project proposal
# A approximate schedule/time-line
# A short list with descriptions of past projects that you have participated in
# Short introduction of yourself
# Contact information

== Some selection criteria ==
* Proposals are longer than a few sentences
* The proposal is written in good and understandable English

* The student knows the appropriate programming language(s)
* The student is familiar with the process of creating software

The following are conditions that result in automatic rejection:
* Google has specified that groups are not allowed. Individuals only.

= Contact list =
* [http://spring.clan-sy.com/phpbb/ Spring forum]
* IRC at Freenode in channel #taspring or at Quakenet in channel #sy
* On Springs lobby server in channel #sy

Please read [http://code.google.com/soc/2009/faqs.html Google's Summer of Code FAQ] for more informations.

OpenSUSE install

2009-02-18T12:48:31Z

Agon: links to repo and wiki for opensuse

A list of various packages for openSUSE and other distributions related to spring are located here:[http://download.opensuse.org/repositories/home:/accAgon/]

openSUSE wiki for spring: [http://en.opensuse.org/Spring]

SetupGuide

2009-02-18T12:45:44Z

Agon: added openSUSE to the list

'''Please click on your distribution to continue''':

* http://img301.imageshack.us/img301/158/debiansmalluk0.jpg [[Debian_etch_install|Debian Etch]]

* http://img301.imageshack.us/img301/158/debiansmalluk0.jpg [[Debian_unstable_install|Debian Unstable]]

* http://img383.imageshack.us/img383/2653/ubuntulogowq2.png [[Ubuntu_install| Ubuntu]] - updated 9/19/08

* http://www.winehq.org/images/distro/slackware.png [[Slackware12_install|Slackware 12]]

* http://img301.imageshack.us/img301/7263/gentoosmallsq9.jpg [[Gentoo_install|Gentoo]]

* http://upload.wikimedia.org/wikipedia/en/thumb/9/95/Mandriva_logo.png/96px-Mandriva_logo.png [[Mandriva_install|Mandriva]]

* http://files.opensuse.org/opensuse/en/2/2d/Opensuse_2.gif [[openSUSE_install|openSUSE]]

* [[Other_distros_install|Binary for Other Linux Systems]]

* [[Build_from_source|Build From Source]]

AIInterface:Mono

2009-02-15T14:32:18Z

Agon: updated page to fit current status of the MonoAIInterface

{{AIInterface|Mono|Agon|v0.5 (local copy)|CLI languages|beta|LGPL v2.1+ and MIT}}

=== Forum threads ===
*[http://spring.clan-sy.com/phpbb/viewtopic.php?f=15&t=16872 Mono AI Interface for Spring]

=== Description ===
This AI interface is written in C and allows spring to load AIs written in a CLI compatible language.

The source of this AI interface library can be found here: ''{spring_source}/AI/Interfaces/Mono/''

=== Currently supported AIs ===
* MonoNullAI
* CSharpSampleAI

=== Download ===
!NO PUBLIC CODE AVAILABLE YET!

=== Known Crashes ===
* Description in AIInfo.lua does not fit to the AI.

=== How to compile and install the interface ===
* Configure with: "cmake -i" or "cmake-gui"
* make (optional with -j<number for jobs>)
* make install (optional with -j<number for jobs>)

=== Required software ===
* Mono 2.0<
* GLib2 (required for Mono)

''' [[AIs|<- Back to AI page]]'''
[[Category:AIInterface]]

AIInterface:Mono

2008-11-23T13:55:08Z

Agon: initial version of MonoAIInterface

{{AIInterface|Mono|Agon|v0.1 (local copy)|Mono|pre alpha|GNU GPL v2+ and MIT}}

=== Forum threads ===
*[http://spring.clan-sy.com/phpbb/viewtopic.php?f=15&t=16872 Mono AI Interface for Spring]

=== Description ===
!NO CODE AVAILABLE YET!

This AI interface is written in C and allows spring to load AIs written in a CLI compatible language.
These AIs consist of a ''.dll'' file, which contains at least one class with the name of the tag shortName described in a AIInfo.lua file.

The source of this AI interface library can be found here: ''{spring_source}/AI/Interfaces/Mono/''

=== Currently supported AIs ===
!NO AIS SUPPORTED YET!

=== Download ===
!NO CODE AVAILABLE YET!

=== Known Crashes ===
*Wrong class name

=== How to compile ===
C part:
* cmake
* make

=== How to install/use ===
Additional software you need to have installed to be able to use CLI AIs:
* Mono >2.0
* GLib2 (required for Mono)
* AWK (for generating C# wrapper code)

''' [[AIs|<- Back to AI page]]'''
[[Category:AIInterface]]