Spring - User contributions [en]

Uberserver

2016-06-17T10:34:12Z

Meltrax: updated offline LAN server instructions for 16.04

uberserver is a lobbyserver written in python for spring lobby clients.

its currently used as the main lobby server running at lobby.springrts.com port 8200.

see https://github.com/spring/uberserver for more details

= bugs / features=

please report bug / feature requests to the [https://github.com/spring/uberserver/issues bug tracker]

= set spring version =

with springlobby type this as admin user into the server window:
SETLATESTSPRINGVERSION 100.0

to make it persistent, edit /home/lobby/uberserver/args.txt:
--latestspringversion 100.0

= Offline LAN server =

This is not really the official way (because I didn't want 56 MiB for installing pip alone) but I started an offline LAN server on my Lubuntu 15.04/16.04 (32 bit) doing this:

First, download the latest uberserver:

<code>
wget https://github.com/spring/uberserver/archive/master.zip
unzip master.zip
cd uberserver-master
</code>

If you want to skip user registration and accepting the Terms of Use (it's your server after all), these ugly hacks should help:

You can check https://github.com/spring/uberserver/issues/16 first to see if it's officially supported by now.

<code>
sed -i "s#allowed = False#allowed = True#" protocol/Protocol.py
sed -Ei "s#(def in_LOGIN.*)#\1\n\t\tself.userdb.legacy_register_user(username, password, client.ip_address, client.country_code)#" protocol/Protocol.py
sed -i "s#(client.access == 'agreement'#(client.access == 'agreement_disabled'#" protocol/Protocol.py
</code>

Then install the required Python modules (geo IP stuff is not needed when on a LAN and/or offline) and start the server:

<code>
sudo apt-get install python-sqlalchemy python-pycryptopp python-twisted # for 15.04 (tested with Lubuntu 32 bit)
sudo apt install python-sqlalchemy python-crypto python-twisted # for 16.04 (tested with Lubuntu 32 bit)
./server.py
</code>

After that you can just launch a lobby client, connect to localhost (or the IP address of the server) with any username and password (empty might not work; didn't test; I use username == password) and you should be able to play.

You can see the expected output here (except that the packages were already installed): http://pastebin.com/ZTZzL1M9 
The line "[0] Successfully logged in static user <ChanServ>" takes a few seconds while the server initializes its database.
The two last lines should appear when your lobby client connects.
[[Category:Lobby]]

Uberserver

2015-07-12T11:24:09Z

Meltrax: /* Offline LAN server */

uberserver is a lobbyserver written in python for spring lobby clients.

its currently used as the main lobby server running at lobby.springrts.com port 8200.

see https://github.com/spring/uberserver for more details

uberserver currently doesn't work on windows/osx, any help is welcome!
see https://github.com/spring/uberserver/issues/70

= set spring version =

with springlobby type this as admin user into the server window:
SETLATESTSPRINGVERSION 96.0

to make it persistent, adjust the startup parameter:
./server.py --latestspringversion 96.0

= Offline LAN server =

This is not really the official way but I started an offline LAN server on my Lubuntu 15.04 doing this:

First, download the latest uberserver:

wget https://github.com/spring/uberserver/archive/master.zip
unzip master.zip
cd uberserver-master

If you will be offline, the public IP check crashes the server. This should disable it:

sed -i "s#urlopen('http://springrts.com/lobby/getip.php').read()#'8.8.8.8'#" DataHandler.py

If you want to skip user registration and accepting the Terms of Use (it's your server after all), these ugly hacks should help:

You can check https://github.com/spring/uberserver/issues/16 first to see if it's officially supported by now.

sed -i "s#allowed = False#allowed = True#" protocol/Protocol.py
sed -Ei "s#(def in_LOGIN.*)#\1\n\t\tself.userdb.legacy_register_user(username, password, client.ip_address, client.country_code)#" protocol/Protocol.py
sed -i "s#(client.access == 'agreement'#(client.access == 'agreement_disabled'#" protocol/Protocol.py

Then install the required Python modules (geo IP stuff is not needed when on a LAN and/or offline) and start the server:

sudo apt-get install python-sqlalchemy python-pycryptopp python-twisted
./server.py

After that you can just launch a lobby client, connect to localhost (or the IP address of the server) with any username and password (empty might not work; didn't test) and you should be able to play.

You can see the expected output here (except that the packages were already installed): http://pastebin.com/ZTZzL1M9 
The line "[0] Successfully logged in static user <ChanServ>" takes a few seconds while the server initializes its database.
The two last lines should appear when your lobby client connects.
[[Category:Lobby]]

Uberserver

2015-07-12T11:23:24Z

Meltrax: added description for an offline LAN server

uberserver is a lobbyserver written in python for spring lobby clients.

its currently used as the main lobby server running at lobby.springrts.com port 8200.

see https://github.com/spring/uberserver for more details

uberserver currently doesn't work on windows/osx, any help is welcome!
see https://github.com/spring/uberserver/issues/70

= set spring version =

with springlobby type this as admin user into the server window:
SETLATESTSPRINGVERSION 96.0

to make it persistent, adjust the startup parameter:
./server.py --latestspringversion 96.0

= Offline LAN server =

This is not really the official way but I started an offline LAN server on my Lubuntu 15.04 doing this:

First, download the latest uberserver:

wget https://github.com/spring/uberserver/archive/master.zip
unzip master.zip
cd uberserver-master

If you will be offline, the public IP check crashes the server. This should disable it:

sed -i "s#urlopen('http://springrts.com/lobby/getip.php').read()#'8.8.8.8'#" DataHandler.py

If you want to skip user registration and accepting the Terms of Use (it's your server after all), these ugly hacks should help:

You can check https://github.com/spring/uberserver/issues/16 first to see if it's officially supported by now.

sed -i "s#allowed = False#allowed = True#" protocol/Protocol.py
sed -Ei "s#(def in_LOGIN.*)#\1\n\t\tself.userdb.legacy_register_user(username, password, client.ip_address, client.country_code)#" protocol/Protocol.py
sed -i "s#(client.access == 'agreement'#(client.access == 'agreement_disabled'#" protocol/Protocol.py

Then install the required Python modules (geo IP stuff is not needed when on a LAN and/or offline) and start the server:

sudo apt-get install python-sqlalchemy python-pycryptopp python-twisted
./server.py

After that you can just launch a lobby client, connect to localhost (or the IP address of the server) with any username and password (empty might not work; didn't test) and you should be able to play.

You can see the expected output here (except that the packages were already installed): http://pastebin.com/ZTZzL1M9
The line "[0] Successfully logged in static user <ChanServ>" takes a few seconds while the server initializes its database.
The two last lines should appear when your lobby client connects.
[[Category:Lobby]]

User:MelTraX

2013-01-04T15:25:54Z

Meltrax:

== This is me ==

https://janholthusen.de/avatar-13/Jan.jpg Jan Holthusen

== My contribution to Spring ==

*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=8779 IceUI]
*[[MelBot]]
*[http://www.spring-league.com/ Ladder] (discontinued)

Development:Getting Started

2009-08-22T09:13:18Z

Meltrax:

=Starting Spring Development=
'''NOTE: Outlined below is information on assisting with the development of the Spring source itself. For information about developing a mod (units, widgets, maps, etc.) see the [[Mod_and_Unit_development]] page.'''

'''Even if you are developing a mod, it is highly recommended that you get the engine source. Engine source + full text search: DO IT.'''

==Overview==
To start development, you will need:
#To read the [[Coding_Standards]]
#The latest version of the source
#A good code manipulation program
#Compiling your modified source (see instructions above)

==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.

==Keep track what others do==
If you develop with others, you need to know what they do. You can browse the source [http://github.com/spring/spring/tree/master at our github-page], and there is a [http://github.com/feeds/spring/commits/spring/master commit newsfeed].

==Source Code Documentation==
The doxygen documentation can provide an overwiev about the source, directory structure and its dependencies. Unfortunately, there s no server runnign it, so you need to make them on your own, to do this, install doxygen and run "doxygen" in spring source directory (will take some time).

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

==Development Guidelines==
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 [[SpringEngineTODO]]. You can also check in the forums 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 report a "bug" in [http://spring.clan-sy.com/mantis/ mantis, our BTS]. Add your patch as attachment, and put "[patch]" in front of the subject, so it is easy for us to separate patches from bugs.

It's also considered standard practice to post one's modifications in the [http://spring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Buildbot and Stacktrace translator==
A buildbot server is available to automaticaly compile Spring, the default AIs and make the installer. It can also translate stacktraces directly from uploaded infolog.txt files. Join #buildserv on the lobby server and use !help to get all the available commands.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]. There is also a [http://spring.clan-sy.com/phpbb/viewforum.php?f=21 feature request forum], which may give you some ideas. Don't be overwhelmed by the sheer number of (silly) requests though!

==Development links==
* [http://github.com/spring/spring/ View the lastest source in a web browser]
* [http://buildbot.eat-peet.net/spring/ Automatic installer builds (crosscompiled, mingw)]
* [http://spring.jobjol.nl/show_file.php?id=860 Spring base content files]
* [http://developer.berlios.de/projects/taspring-linux BerliOS project page (OLD)]
* [http://springrts.com/mantis/ Bug Tracking System]
* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
* [http://springrts.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
* [http://spring.jobjol.nl/show_file.php?id=1102 Development libraries for MinGW]
* [http://sourceforge.net/projects/springrts SourceForge project page (OLD)]
* [http://springrts.com/svn/spring/ TASServer, TASClient and Web site Subversion repository]
* [http://springrts.com/websvn/ TASServer, TASClient and Web site WebSVN]
* [http://springrts.com/dl/docs/unitsync/group__unitsync__api.html Unitsync API docs]

Lua Widgets

2009-08-22T09:10:13Z

Meltrax:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===General===
'''[[Lua:WidgetDirectory|LuaUI Widget Directory]]''' - A list of cross-mod compatible LuaUI widgets 
'''[[Lua_Scripting|Lua Scripting and Development]]''' - Look here to get started with making your own Lua widgets and gadgets 
'''[http://spring.clan-sy.com/phpbb/viewforum.php?f=23&sid=83343bd3a47bc826fc973e4bd6a15f04 Spring Lua Forum]''' - Browse and discuss published widgets, or publish your own 
'''[http://spring.jobjol.nl/files.php?subcategory_id=12 JobJol's Lua Widget Section]''' - Popular Spring file host JobJol.nl Lua subsection
|}

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===Introduction===
LuaUI widgets are files containing Lua code that you can run while playing a Spring game in order to assist you with unit management, provide you with valuable information, or otherwise supplement the basic Spring user interface. They are easy to install, easy to run and manage ingame, and relatively easy to write should you choose to learn how to do so.
|}

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===Getting Widgets===
Widget code and files are quite often released as posts in the '''[http://spring.clan-sy.com/phpbb/viewforum.php?f=23&sid=83343bd3a47bc826fc973e4bd6a15f04 Spring Lua Forum]'''. In addition, they are also mirrored at popular Spring file sites such as '''[http://spring.jobjol.nl/files.php?subcategory_id=12 JobJol]'''.

It is also highly recommended that you visit the wiki's '''[[Lua:WidgetDirectory|LuaUI Widget Directory]]''', which contains a list of many widgets, along with mod compatibility information and possible additional installation instructions.
|}

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===Installing Widgets===
Widget files have the extension .lua, but only contain plain text. To install widgets you've downloaded, just move the .lua file to the LuaUI\Widgets folder in your Spring installation directory. Sometimes, a widget file may come in a zip archive, or be bundled with other dependent files. These files will need to be unarchived, then moved to their proper respective folders in the LuaUI folder. Look for a help or readme file included in the package, or read any installation instructions listed with the widget at the '''[[Lua:WidgetDirectory|LuaUI Widget Directory]]'''.
|}

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===Using Widgets===
'''NOTE:''' Before you can use widgets, you MUST make sure that you have checked the "Enable LuaUI widgets" box in SpringSettings.

To list/manage all available widgets, press F11 while ingame. Each widget is listed by name and sorted alphabetically, and mod included widgets appear first on the list with their names surrounded by asterisks. You may click on each widget name to enable/disable that widget. '''Green''' widgets are currently running, '''red''' widgets are currently disabled and '''orange''' widgets have malfunctioned or turned themselves off.

In the case that you begin to see Lua errors and/or your user interface inexplicably crashes or becomes "messed up", you can use the command '''/luaui reload''' in order to restart the Lua user interface. If for any reason you wish to shutdown the Lua user interface while ingame, you may issue the command '''/luaui disable'''.
|}