Liquid War 6, a unique multiplayer wargame.
Introduction
User's manual
Hacker's guide
Reference
C API
Appendices
Read this chapter to discover Liquid War 6.
Liquid War 6 is a unique multiplayer wargame. Your army is a blob of liquid and you have to try and eat your opponents. Rules are very simple yet original, they have been invented by Thomas Colcombet. It is possible to play alone against the computer but the game is really designed to be played with friends, on a single computer, on a LAN, or on Internet.
An older version, Liquid War 5, is available, but is not part of the GNU Project. Only Liquid War 6 is part of the GNU Project, it is a complete rewrite.
The official page of Liquid War 6 is http://www.gnu.org/software/liquidwar6/. For more information, you can read the Wikipedia article about Liquid War.
As of today, the game is in beta state. It can be installed, and you can toy arround with. You can even play with. It is still far from being complete as some key features are still missing.
What works:
In the near future:
In the long run:
You might be interested in checking the following URLs, which give a view on opened tasks and bugs:
Liquid War 6 is a complete rewrite of Liquid War 5. The rewrite started in 2005. So a good question is “was the rewrite worth it?”...
Here's a list of key improvements:
The most interesting change is still to come, and concerns network games.
Stay tuned.
Liquid War 6 releases are “codenamed” after famous, historical,
real or mythical characters. Here is a short revision history.
For details, see the ChangeLog
and NEWS files distributed with the game. Additionnally, there's
an ever-increasing “stamp” number which is incremented each time
a build is done with a different source.
The game will probably be labelled “6.0.0” when network mode is up and running. Until then there will probably be other improvements concerning gameplay and appearance (“eye candy”). There's a balance to keep between the major goals such as “make that network thingy work” and the very real fact that “hacking must be fun”.
Please remember that development of Liquid War 6 is a volunteer effort, and you can also contribute to its development. For information about contributing to the GNU Project, please read How to help GNU.
Here's a short list of todo items. It is probably too early to start hacking the core engine itself, for it is still under heavy development, might undergo major rewrites, and it's hard for documentation to keep up with the reality of the code. However, there are still many things to do.
Feel free to join the mailing-lists, this is clearly the best place to start with.
There's also a list of opened tasks on Savannah at http://savannah.gnu.org/task/?group=liquidwar6 which you can browse online. Maybe there's some task for you!
Alternatively, you can contact Christian Mauduit.
The Liquid War 6 user's manual hopefully contains any usefull information to install the program and play the game. If you just want to enjoy Liquid War 6 without diving into map creation and programming, this is just for you.
The main discussion list is <help-liquidwar6@gnu.org>, and is used to discuss all aspects of Liquid War 6, including installation, development, game strategies, and whatever subject players and hackers might want to talk about, provided it is Liquid War 6 related. If you don't know on which list to subscribe, this is the one.
To subscribe to it, please send an empty mail with a Subject: header line of just "subscribe" to the -request list, that is
<help-liquidwar6-request@gnu.org>.
You can also subscribe to the list using the Mailman web interface for help-liquidwar6 and consult help-liquidwar6 archives.
Announcements about LiquidWar 6 are made on <info-liquidwar6@gnu.org>. Subscribe to it to be informed of major releases, and other significant news.
To subscribe to it, please send an empty mail with a Subject: header line of just "subscribe" to the -request list, that is
<info-liquidwar6-request@gnu.org>.
You can also subscribe to the list using the Mailman web interface for info-liquidwar6 and consult info-liquidwar6 archives.
Please also consider reading the latest news on Savannah.
There is also a special list used for reporting bugs, <bug-liquidwar6@gnu.org>. Please try and describe the bug as precisely as possible. The more accurate the description, the more chances it will get to be fixed.
While this is the standard GNU way of reporting bugs, modern SPAM standards make it very hard to filter real bug reports from junk on this list. It is more convenient to use a web interface, the URL is: http://savannah.gnu.org/bugs/?func=additem&group=liquidwar6 and you're really encouraged to use it instead of sending emails.
Please take a look at the bug list before submitting new bugs.
Liquid War 6 can be found on http://download.savannah.gnu.org/releases/liquidwar6/ and http://www.ufoot.org/download/liquidwar/v6/.
Downloading the latest file from this place, and compile
it yourself on your computer with a classical
./configure && make && make install is the recommended
way to install Liquid War 6.
Some binary packages might be available. Your mileage may vary.
GNU/Linux based systems are supported, through
Debian .deb and
Red Hat RPM packages.
There is also a Microsoft Windows installer.
However these binaries are not necessarly available for every single version of the game.
Latest work in progress versions can be obtained with GIT. Here's the typicall command which will fetch the latest version:
git clone git://git.sv.gnu.org/liquidwar6.git
If you are behing a firewall and can't use the native GIT protocol, you can rely on the (slower) http protocol:
git clone http://git.sv.gnu.org/r/liquidwar6.git
You can browse the code online, consult log summary, and in a general manner “follow” the project on http://git.savannah.gnu.org/gitweb/?p=liquidwar6.git and http://git.savannah.gnu.org/cgit/liquidwar6.git.
Alternatively, you can download daily snapshots on
http://www.ufoot.org/liquidwar/v6/snapshots/
These files should be built every day, but a make distcheck is
done before creating them. So if the source code is, for some reason, broken, then
they won't be generated. It is a good source if you want the
most up-to-date code which is not completely unstable. This is typically
the place to go if you want to know a reported bug is correctly fixed. Please
do not rely on snapshots generated on the fly by the source content manager,
daily snapshots mentionned above are better since
a make dist has been run on them.
Using a checkout is really for developpers.
This section covers installation from source. Other ways of installing the program are not described here.
All these libraries are mandatory to compile the game. Liquid War 6 won't compile, let alone run, without them. Some of them could probably be replaced by equivalent tools, but this would certainly require a programming effort and some changes in Liquid War 6 source code.
#pragma directives, this should help the game
run faster on SMP systems.
snprintf...)
and Liquid War 6 might use them. In a general manner, Liquid War 6
is part of and designed for GNU. You might however manage to compile
it with limited libc support, this is the case with mingw32 for instance
but, do it at your own risk.
dlopen and dlclose. Check
that you have a /usr/include/ltdl.h file, or install
the corresponding package.
While all these libraries are theorically optional (the game will successfully compile without them), you'll obviously need, for instance, one graphics backend. Otherwise, you'll simply have no display. This is not acceptable. As of today, one can reasonnably consider all SDL-related libraries are required. The rest is truely optional.
OGG/Vorbis
file renderer.
You might find it convenient not to install all the requirements from source, but use your favorite GNU/Linux distribution packages.
On an RPM based GNU/Linux system, a typical command (tested with Fedora 15 “Lovelock”) could be:
yum install \
make gcc glibc glibc-devel binutils \
libgomp \
guile guile-devel gmp gmp-devel libgc1c2 libgc-dev \
libtool libtool-ltdl libtool-ltdl-devel \
zlib zlib-devel expat expat-devel \
libpng libpng-devel libjpeg libjpeg-devel \
sqlite sqlite-devel \
ncurses ncurses-devel readline readline-devel \
libGL libGL-devel libGLU libGLU-devel \
SDL SDL-devel SDL_image SDL_image-devel \
SDL_mixer SDL_mixer-devel \
freetype freetype-devel SDL_ttf SDL_ttf-devel \
libcurl libcurl-devel \
perl lcov global valgrind graphviz gv texinfo-tex \
gtk2-devel rpm-build
On a DEB package based GNU/Linux system this command (tested with Debian 6.0 “squeeze”) would be:
apt-get install \
make gcc libc6 libc6-dev binutils \
libgomp1 \
guile-1.8 guile-1.8-dev guile-1.8-libs libgmp3c2 libgmp3-dev \
libtool libltdl7 libltdl-dev \
zlib1g zlib1g-dev libexpat1 libexpat1-dev \
libpng12-0 libpng12-dev libjpeg8 libjpeg-dev \
libsqlite3-0 libsqlite3-dev \
libncurses5 libncurses5-dev libreadline6 libreadline6-dev \
libgl1-mesa-glx libgl1-mesa-dri libgl1-mesa-dev libglu1-mesa libglu1-mesa-dev \
libsdl1.2debian libsdl1.2-dev libsdl-image1.2 libsdl-image1.2-dev \
libsdl-mixer1.2 libsdl-mixer1.2-dev \
libfreetype6 libfreetype6-dev libsdl-ttf2.0-0 libsdl-ttf2.0-dev \
libcurl4-gnutls-dev \
perl lcov global valgrind graphviz gv \
texinfo texlive-base texlive-generic-extra \
libgtk2.0-dev debhelper
Note that those requirements really depend on the exact distribution you have, package names may vary from one to another.
Liquid War 6 uses GNU Automake, Autoconf and GNU Libtool.
Once all the requirements are installed, run:
./configure
make
make install
Liquid War 6 supports the standard ./configure --prefix=/my/path option
(in fact, it supports much more than that) so you can install the game
in any directory. You do not need to be root to install Liquid War 6.
The main package contains some maps so that you can try out
the game. Still, an additionnal package, called extra-maps
or liquidwar6-extra-maps is available, containing more maps.
It really does contain many of them, including most Liquid War 3
and Liquid War 5 legacy maps, plus new Liquid War 6 maps.
On GNU/Linux systems (and possibly any POSIX unixish system) running:
./configure
make
make install
will install the extra maps on your system automatically,
they will then be available in the extra/ sub-directory
when browsing maps.
The ./configure script has a --enable-liquidwar6 switch
which will try and find automatically if there's an existing liquidwar6
binary in the path. If there's such a binary, it will run it and
ask for its map-path and use this value automatically.
Another solution, which works on all platforms including Microsoft Windows and Mac OS X
but also works on GNU/Linux, is to simply unpack the extra-maps
package (unzip or untar) in your custom map directory, or in the
system map directory. There's nothing else to do to install these maps
but simply put them on your hard drive in the right directory.
Typically on an Microsoft Windows system, you would unpack the extra maps in
C:\Program Files\Liquid War 6\map\ (system directory)
and on a Mac OS X system you would unpack the extra maps in
Liquid War 6.app/Contents/Resources/map/ (system directory)
or $HOME/Library/Application Support/Liquid War 6/map (user directory).
On a GNU/Linux or POSIX system
you would unpack them in $HOME/.liquidwar6/map/ (user directory).
Next time you run the game, the maps should be browsable.
If you can't see them, run liquidwar6 --audit and check that
the place where you unpacked the files is actually searched by the binary.
./configure. Running ./configure > configure.log 2> configure.err does help.
/etc/ld.so.conf and running ldconfig as root
can help if some dependencies are installed in exotic places.
CFLAGS, LDFLAGS and LD_LIBRARY_PATH.
./configure --enable-allinone, this will disable
some fancy but somewhat complicated dynamic .so file support,
it can help if shared libraries are handled differently on your system
than on a plain GNU/Linux box.
If none of these help, consider reporting a bug, or search the mailing-lists for help.
Here's a check-list to ensure that your installation is correct:
make install? make check?
liquidwar6 binary in your PATH environment variable?
It might be in /usr/games.
liquidwar6 --pedigree. Look at the output. Check the
compilation date & time, the version number.
liquidwar6 --audit. What do these paths look like?
Are they absolute paths? Do they exist? What's there?
Normally, once the game is installed, all of them should exist,
and be populated with sub-directories and files.
liquidwar6 --modules, to know which modules where compiled.
You need at least one graphical module, for instance mod-gl,
else the game won't run.
liquidwar6 --host, this displays informations about
the host system the binary has been built for.
Now, game looks correctly installed, but you have problems running it.
$HOME/.liquidwar6/ directory, you'll find some files, the main log file log.csv and maybe dump.txt or backtrace.txt. They might contain valuable information, read them. Note that while log.csv is overwritten each time you start the game, dump.txt or backtrace.txt are conserved until a new problem arises. So check the date of these files to be sure you're analyzing the right ones.
Note that byt default on Microsoft Windows $HOME/.liquidwar6/ is replaced by
C:\Documents and Settings\<username>\Liquid War 6 and on Mac OS X it is
in /Users/<username>/Library/Application Support/Liquid War 6/.
liquidwar6 --defaults. This will reset all options to defaults.
You might need to run this when upgrading from a version to another, since
some options might appear, disappear, or defaults values can change.
liquidwar6 --test. This should run a complete test suite, many functions in the game will be tested automatically, and errors reported.
liquidwar6 --show-script-file. Are you really running the right code?
make uninstall && make clean && make && make install.
Many problems can come from using a wrong shared module. You can also launch
the game with the --trap-errors=false switch, this will disable the custom
popup window and allow you to get the real error.
gdb liquidwar6. Type run --trap-errors=false and watch output.
stdout or stderr.
You can change this
by modifying some environment variables: export LD_DEBUG=all.
This is very verbose but does help finding bugs.
./configure --enable-valgrind and
then run it using Valgrind.
find / -type d -a -name "liquidwar6*" 2> /dev/null to ensure you don't
have an old version of Liquid War 6 somewhere else...
Once the game is installed, run it,
click on Quick start with the mouse, and control
the red 'a' cursor with the mouse, or keyboard, both work.
Try and surround the green team, it's a stupid bot, you should win ;)
You army is formed by all the red pixels on the screen, they should
try and rejoin the cursor (the blinking 'a' letter) using the
shortest path. When red and green meet, they fight. Try it, toy arround.
The Quick start button will always make you play red against
a green stupid bot, whatever other options you have set up.
Todo...
Liquid War 6 can be controlled using a reduced set of keys. This is to make the game more portable and allow possible ports to platforms where a full keyboard is not available. Depending on the graphics backend, exact mapping might change, they should hopefully be obvious and intuitive.
Those keys are:
up : the arrow up key
down : the down arrow key
left : the left arrow key
right : the right arrow key
enter : the enter / return key
esc : the escape key
ctrl : the control key
alt : the alt / meta key
pgup : the page up key
pgdown : the page down key
Basically,
It's also possible to control the game with the mouse only, or with a joystick. By default the interface will trap all events and respond on any of these possible devices.
| Keyboard | Mouse | Joystick | Menu action | In-game
|
|---|---|---|---|---|
up
| mouse pointer | stick | previous menu item | move cursor up
|
down
| mouse pointer | stick | next menu item | move cursor down
|
left
| mouse pointer | stick | change menu item value | move cursor left
|
right
| mouse pointer | stick | change menu item value | move cursor right
|
enter
| left-click | button A | validate menu | validate chat line
|
esc
| right-click | button B | back to previous menu | quit game
|
ctrl
| right-click or double-click on any button | button C | N/A | fire
|
alt
| middle-click or triple-click on any button | button D | N/A | alternate fire
|
pgup
| wheel up | button E | previous menu item | zoom in
|
pgdown
| wheel down | button F | next menu item | zoom out
|
A final word about joystick buttons: there's no such thing as standard
joystick buttons, some will come with A,B,C,D, others will
have A,B,start,select,L,R, there's no way to know. By default,
the game will use the buttons with the lowest indexes (returned by
your driver) for the most usefull functions. Validate menu entries is
the most usefull action, zooming in and out the one you can live without.
There's also an (almost) hardcoded shortcut which will quit the game immediately, or at least as quickly as possible, without any prompt or warning.
It is the F10 key.
Think of this feature as the procastinator's “whoops, here comes my boss!!!” emergency function.
As of today, Liquid War 6 is essentially a solo game since network is not working. It allows you to toy arround in arcade mode on any map you wish.
A real solo mode with campaign and goals to reach is planned, how it will be implemented is yet to be defined.
By default, teams behave differently, some of them move more rapidly,
some are more aggressive but vulnerable, some are more defensive but
do not attack as strong as others. This aspect of the game is under
active tuning, things might be unfair by now, you can toy arround
with the various team-profile-... options, any report is
appreciated.
Note that this is very different from Liquid War 5, and can give very different gaming experiences, you can artificially set up arbitrary strong bots, for instance.
Here's a description of the default color settings:
blue:
has a strong attack but is slow
cyan:
has an extremely good defense but is slow
green:
has a better defense than the average
lightblue:
has an extremely strong attack but is very slow
magenta:
is extremely fast but also very vulnerable
orange:
is fast, but has a very weak attack
pink:
has a very strong attack, but is also very vulnerable
purple:
has a very good defense but a weak attack
red:
moves faster than the average
yellow:
has a strong attack
Additionnally, when profiles are used, each team has two weapons, a primary weapon and an alternate one. Think of weapons as special (usually nasty) tricks you can play on your opponents.
Here's a description of available weapons:
atomic:
nuclear explosion, all fighters arround your cursor are about to die
attract:
all fighters from all teams are packed near your cursor
berzerk:
super-strong attack for a limited time, crush your enemies
control:
you take the control of all other teams while your cursor stays in place
crazy:
all your opponents go crazy for some time, acting with no logic
disappear:
you disappear for some time from the battlefield, to reappear later, somewhere
else
escape:
fighters placed as far as possible from cursor, magically escape from any grip
fix:
all other teams are freezed, you can move but not attack them
invincible:
no damage for a limited time, move untouched
kamikaze:
you die along with the strongest team on the battlefield, requires at least 3
teams
mix:
fighters exchange position, their properties being preserved
permutation:
will exchange colors, randomly, requires at least 3 teams (double edged
weapon)
plague:
general disease, all fighters mysteriously loose health
reverse:
fighters continue to move normally, but attacks are done in reverse mode,
backwards
rewind:
make the battlefield be like it was a few seconds ago
scatter:
every fighters of every team scattered in random places
shrink:
reduces the number of fighters on the map
steal:
steals some fighters to other teams
teleport:
fighters placed as close as possible to cursor
turbo:
move faster for a limited time
Note that this is in progress, some of them are NOT IMPLEMENTED YET.
Liquid War 6 needs to name your “node” (you can think as your server instance of the game) and have a unique URL (address) to publish and give to other nodes.
If only one network adapter is attached to your computer and
your address IP is A.B.C.D then by default the game will
pick automatically the address http://A.B.C.D:8056/ and
it should work flawlessly.
Problems can arise if you have a peculiar network configuration,
if you have multiple non-loopback network interfaces, if you use
NAT to protect yourself from intruders and/or if your
context forces you to do so.
In that case, Liquid War won't be able to guess a correct URL
automatically. So you need to set it up manually either
by editing the public-url entry in the config file,
changing environment variable LW6_PUBLIC_URL or
passing the --public-url=http://<host>:<port>/ argument
when running the game. Typically, if you are behind a firewall
which does NAT, use the firewall address. The right address is
the address which, given to remote hosts, will allow them
to connect on your game instance.
A node is started automatically when you run the game. Even if you don't start to play, node starts in the background and exchanges data with other nodes, mostly to discover them and maintain its internal map of existing nodes and games.
So even without starting a network game, you should be able
to point a web browser on your node and see a web page
describing it. Your node address is displayed on stdout
(console) when starting the game. If in doubt, try http://localhost:8056/
which should work unless you modified defaults settings.
When you start a network game, the program simply changes your node state from “idle” to “accepting connections”.
The interface should show you the list of available nodes, just pick one and try and connect to it.
Note that once you're connected on a remote node, you're still acting as an independant node, and other nodes might connect to your node as well as to the other nodes. In short, there's no real server or client, everyone is a client for someone, and can act as a server.
Nodes connected together form a “community”, which can disband, accept new nodes, and in a general manner has its own immaterial life, the first node which created the game might disappear, game can continue without it.
This is why the main network module is called libp2p,
this is a reference to the term “peer to peer”.
Once a node is connected to another one, they've started a “community”. Formally, a stand-alone node accepting for connection is already a community, even if it has only one member, but the only really interesting communities are those formed with several nodes.
A community can't be reached through a given server, to connect to one you just need to connect on one of its member nodes. All nodes are equivalent, there's no master, no root node, nodes collaborate to share the same real-time information and maintaine an up-to-date game state.
Of course, conflicts can arise, and in that case nodes need to agree on an acceptable solution. Normally, the program takes decisions automatically (for instance, it could decide to “kick” a node out of the community) so the player does not have to care about this, but this is expected to be one of the most tricky (and passionating) part of Liquid War 6 hacking.
By default, Liquid War 6 will communicate on port 8056, in both TCP and UDP, and in both ways too (in/out). It's possible to play with partial connectivity, in extreme case, you can even play without direct internet access, using only a mere web proxy.
However, things will go faster and be much easier if the program can use its default native protocol.
Here's an example of a typicall iptables configuration which allows you to play the game full-featured. It's assumed that by default all packets are dropped, this configuration will just open the necessary ports.
# outgoing TCP on port 8056 (liquidwar6)
iptables -A OUTPUT -p tcp --dport 8056 -m state --state NEW,ESTABLISHED -j ACCEPT
iptables -A INPUT -p tcp --sport 8056 -m state --state ESTABLISHED -j ACCEPT
# incoming TCP on port 8056 (liquidwar6)
iptables -A INPUT -p tcp --dport 8056 -m state --state NEW,ESTABLISHED -j ACCEPT
iptables -A OUTPUT -p tcp --sport 8056 -m state --state ESTABLISHED -j ACCEPT
# outgoing UDP on port 8056 (liquidwar6)
iptables -A OUTPUT -p udp --dport 8056 --sport 1024:65535 -j ACCEPT
iptables -A INPUT -p udp --sport 8056 --dport 1024:65535 -j ACCEPT
# incoming UDP on port 8056 (liquidwar6)
iptables -A INPUT -p udp --dport 8056 --sport 1024:65535 -j ACCEPT
iptables -A OUTPUT -p udp --sport 8056 --dport 1024:65535 -j ACCEPT
If you can't change firewall settings and only have access to the web
through a web proxy, it can still be possible to play (with some restrictions
such as your node not being seen by others) if mod-http is available.
This in turn depends on wether libcurl support was
activated when compiling the game. To use the proxy, you can set
the http_proxy environment variable. For detailed informations,
please refer to libcurl doccumentation.
As stated in the license, the program comes with NO WARRANTY. Period.
However, an important effort has been made so that it can reasonnably be used online, exposed to various “common” attacks.
As far as security is concerned, there are two different issues:
Here's a list of various steps which have been taken to make the program more secure:
--skip-network option is here if you really do
not want to be bothered by networking risks;
strcpy,
equivalents such as strncpy are used;
This being said, Liquid War 6 does not use any strong encryption library to protect the data it sends. All the checksum machinery might be vulnerable to a brute-force and/or strong cryptographic attack, so in theory it's possible to fool the program.
In practise, if you want real privacy, play over a VPN (Virtual Private Network).
Liquid War 6 will try and pick up a default resolution when the game is launched the first time. It won't use your maximum screen resolution but will instead list all available fullscreen modes, and pick up one which is usually something like two thirds of the highest mode. This is to allow switching back and forth between fullscreen and windowed mode using the same settings. This automatically picked-up resolution really depends on your hardware and driver. It is called “standard” in the graphics options menu.
Then it is possible to automatically select the minimum and maximum resolution
your hardware allows in fullscreen mode. These are called “low” and “high”
in the graphics options menu. Just click on the button that display the
resolution, it will change and use the next setting. In windowed mode, the game
won't accept the highest available mode but will instead use a percentage of it,
defined by the --windowed-mode-limit parameter.
You might still be in a case where this is not enough. For instance your maximum resolution is 1600x1200, Liquid War 6 picks a default mode of 1280x960 for you but for some reason you want to play in 800x600, fullscreen. In this case, simply switch to windowed mode, resize the window with the mouse (the resolution button will show you the current resolution) and just choose a resolution near 800x600. It does not even need to be exactly 800x600, 798x603 would probably fit. Then when switching back to fullscreen, you'll be in 800x600, the game will automatically pick up the fullscreen mode which is closest to the current windowed mode resolution.
By default the game will try and run at 60 frames per second. Given the nature of Liquid War 6, this is probably enough. Higher values will maybe give a slightly smoother display, but barely noticeable.
You can activate the display of frames per seconds (aka “fps”) through the menu (“options -> system”) or with the command line (“–display-fps”).
On a single processor system, reducing the number of frames per second might
allow the rest of the game run faster. So if you notice the game is really
slow, in terms of “fighters move slowly” then you might be happy reducing
the display rate and therefore giving power back to the other parts of the
program. On a dual-core (or more) or on a multi-processor system, this is
probably useless since the game is threaded and has a dedicated thread for
display purposes. The command line option to reduce the number of frames
per second is --target-fps.
Additionnally, the parameter --gfx-cpu-usage allows you to force
the display thread to “take a rest” and go idle for some time. This is
advanced settings, most users won't touch this.
As of today, the game is capable of playing Ogg Vorbis audio files. That's it.
In the long run, what is planned is to support Csound which would allow very cool effects, such as dynamically changing the music while the game is running, typically following the action. If there's a lot of fight, the music could reflect this.
For now this is only vaporware, just a nice idea among others, nothing implmented yet.
The config file is a simple XML file. It uses XML only to benefit standard parsing tools, but it's not a structured XML file, in the sense that the tree is so simple that all items are at the same level. It is just a simple key-value binding.
This file is in $HOME/.liquidwar6/config.xml on GNU/Linux and POSIX
systems, in C:\Documents and Settings\<username>\Liquid War 6\config.xml
on Microsoft Windows and in /Users/<username>/Library/Application Support/Liquid War 6/config.xml on Mac OS X.
You're free to edit it manually, but all parameters are changeable with command line options. The program will overwrite this file each time it exits, so if you put comments in it, they will disappear. The advantage of this is that if you mispell something, or if for some reason the game does not understand a value, then when rewriting the file, it will show you it just did not get it.
The file embeds the documentation for all its entries,
it is therefore rather verbose. The documentation is the same you will
find online or by quering the game with the --about option,
also the same you would get reading this manual.
Liquid War 6 uses stdout to output important messages,
and stderr to log warnings and errors.
It will also use syslog if available.
Additionnally, a verbose log is available in $HOME/.liquidwar6/log.csv
on GNU/Linux and POSIX
systems, in C:\Documents and Settings\<username>\Liquid War 6\log.csv
on Microsoft Windows and in /Users/<username>/Library/Application Support/Liquid War 6/log.csv on Mac OS X.
You can read this using any spreadsheet software capable of reading
csv file. It uses the tab (\t) character as a separator.
It contains valuable informations including version and most default
values for the game, and for each line logged, it says where in the
code the log function was called. A must-have for debugging.
There are two ways to report bugs:
The latter (Savannah) is much preferred, because the mailing-list is bloated with spam... It also offers a list of bugs which you should read before submitting a new one.
This hacker's guide is for anyone who is curious about the game, and wants to know how it works. It covers many aspects from simple map creation to technical program internals. A great effort has been done in Liquid War 6 so that it should be much more hackable than previous versions. Any feedback is welcome.
As of Liquid War 5, most levels have been contributed by players. While the maintainer of Liquid War 6 has technical knowledge to develop the game, artistic talent and taste might not be his domain of excellence 8-)
Therefore contribution are truely welcomed when they take the form of a new, original, fun and good looking level. It's believed the levels often make the game much more than its engine. This is true for any type of game, and Liquid War is no exception.
So this section is here to help players understand how to hack existing levels, and create new ones, in the hope that 1) they can enjoy their own creations and 2) possibly share their work with others.
Note that this manual might refer to levels and maps: they are just two different names to describe the very same thing. It's an alias.
Liquid War 6 stores level information in a plain directory.
There is no such thing as an opaque .dat binary file.
The name of the level is the name of the directory itself,
and its elements are the files contained in it.
Files must follow a precise naming scheme. For instance
Liquid War 6 expects a map.png file to be present
in each map directory.
All image files in a level use the
Portable Network Graphics
or JPEG format.
It is possible that in the long term, Liquid War 6 will
be able to handle levels as .tar.gz or .zip
files. In that case these files will only be a compressed
image of the actual level directory.
See the ./map/ directory of the source Liquid War 6
distribution to see example of maps.
Liquid War 6 does enforce a limit on map size. This is not to frustrate map designers and/or players, simply, it would be a lie to pretend the game can handle arbitrary big maps.
They might look great on your computer but will become unplayable soon on an older machine. And most of the time they don't look that great, carefully crafted 1280×720 just looks awesome and can represent a great level complexity.
Here are the technical limits:
| Type | Max width | Max height | Max surface
|
|---|---|---|---|
| Texture | 3 000 | 2 000 | 6 000 000
|
| Logical map | 1 500 | 1 000 | 1 000 000
|
The texture can be somewhat bigger than the logical map, this allows
for pretty levels while limiting the horsepower needed to move
the fighters and animate everything. Note that you could technically
feed the game with a map.png that is bigger than the logical map
limit, only it will be downscaled when being loaded.
The texture limits are generous enough to accept a full-HD 1920x1080 image, or a 4/3 1600x1200 image, while the “one million pixels” logical map limit is enough to store a 16/9 1280x720 map or a 4/3 1024x768.
Keep in mind that the logical map (map.png) will probably be
scaled whatsoever, even if it's within the absolute limits
(the game adapts the resolution to your computer speed)
and your texture will rarely appear in its native
resolution, will probably be distorted, and so on.
Older versions of Liquid War 6 used to load a plain README file
and use this as metadata. Title was take from map directory name. This is
still supported, but it now also supports the addition of a metadata.xml file
in which you can describe your map.
The following files can be defined:
title: map title, what will appear in the menus
author: map author
description: description of the map, to help players when browsing folders
license: map license (short version, just a simple one-liner, don't use lenghtly copyright
notices here, the README file would be the file to put long legal sections)
This is the only required file in a level.
In fact, the existence of map.png makes a
directory a level. When checking wether a directory
is a correct level, Liquid War 6 simply tests the
existence and validity of map.png.
This image is a simple black & white area, where white zones are the background, the sea, the places where fighters can move, and black zones are the foreground, the walls, the places where fighters can't go.
This informations can be stored in a 2-color indexed file, or in a grayscaled or even truecolor RGB file, but color information won't be used. Internally, Liquid War 6 will read the color of every point. If it is over 127 on a 0 to 255 scale, it will be considered as background, if it is below 127, it will be considered as foreground.
Liquid War 6 can handle mutiple layer maps. Think of a pile of maps, one being on top of the other. This allows you to create a volume, the game considers every layer has two axis x and y, and the z axis is to travel through layers. First layer corresponds to z=0, second layer to z=1, and so on.
Here are the files you can use to define layers:
map.png this one is on top, it's always defined (z=0)
layer2.png (z=1)
layer3.png (z=2)
layer4.png (z=3)
layer5.png (z=4)
layer6.png (z=5)
layer7.png (z=6)
A layerX.png file should be designed exactly like map.png.
In fact, map.png could simply have been called layer1.png.
Up to 6 extra layers can be defined
(from layer2.png to layer7.png).
This is a hardcoded limit.
It allows you to define 7 different layers, including
the top map.png layer.
Keep in mind this layer system is not real 3D,
it's more a “2D and a half”
model. Adding layers can considerably slow down the game, so it's
wise to try and use as few layers as possible. Technically, 3 layers
will allow you to build bridges and tunnels, which is probably
the most usefull construction using layers. Fighters can also
have difficulties navigating through layers so piling up layers
in narrow “vertical” z-axis based tunnels is probably not a
great idea.
The ufoot/concept/pass map of the liquidwar6-extra-maps
demonstrates basic layer usage.
It is possible to define a texture for the map by
putting a texture.png or texture.jpeg file.
It does not need to have the
same dimensions as the map itself. Indeed, textures can
be much more precise than the actual logical map.
There's no theorical limit on how big a texture can be, more precisely, it can be much bigger than any hardware/driver maximum texture size. In practice, a too big texture will waste your video card RAM, and slow everything down. Sizes ranging from 640x480 to 1600x1200 are reasonable texture sizes.
If you don't define this, the map.png file will
be used as the texture, and also import colors from
style.xml if defined.
Note that the shape of the texture defines the shape of the map, that is, the ratio with which it will appear on the screen.
The PNG alpha layer will be used for transparency.
But to save disk space, it can be convienient to prefer the JPEG
format, use texture.jpeg instead of texture.png
and store the alpha layer in a separated file,
called texture-alpha.jpeg. This avoids handling heavy
PNG files, PNG compression not being performant on most textures.
In texture-alpha.jpeg, black is considered opaque,
and white is transparent. Different levels of gray correspond to
different levels of opacity. Previous versions of the game
used the other way of doing things (black is transparent) because
this is technically, the most obvious way to do things. Black is 0
and transparent is 0. But for a human “reader” of the map
this does not make sense. One generally expects white to be the
equivalent of “undrawn” or “blank”, well, if it's undecided,
void, transparent, whatever, it's white. When the Gimp
flattens an image, it becomes white, not black.
So white is transparent. Period.
If there's a glue.png or boost.png file in the map directory
(you can use one of them or both) then they will be interpreted as follow:
glue.png and boost.png are white, nothing special
happens, fighters follow their default behavior
glue.png is black, fighters will be slowed down. How
slowish they will be depends on the 'glue-power' parameter. If 'glue-power' is
3 then fighters will move three times slower.
boost.png is black, fighters will behave faster. How
fast they will be depends on the 'boost-power' parameter. If 'boost-power' is
2 then fighters will move two times faster.
glue.png or boost.png are gray, they will
be slowed down less or speeded up less depending on how dark the grey is.
There can be, at the same place, some gray or black in both boost.png
and glue.png. How this will behave exactly is not really clear at this
stage, the recommendation is not to do this (it does not really make sense
anyway) but if you do it, game won't complain.
It's also wise not to abuse of boost.png for obviously, a map
filled with “boosted” zones at a X10 pace will require much more CPU
than the same map with no such setting. This might fool the automatic
resampling algorithm and lead to maps that are unplayable. The spirit of
boost.png is just to make a few spots go faster.
It's also important to note that behaving faster or slower means moving faster or slower but also attacking faster or slower, and, in a general manner doing any action with a different pace.
If there's a danger.png or medicine.png file in the map directory
(you can use one of them or both) then they will be interpreted as follow:
danger.png and medicine.png are white, nothing special
happens, fighters follow their default behavior
danger.png is black, fighters die automatically, that is,
they become black and loose health. How dangerous these zones are depends
on the 'danger-power' parameter.
medicine.png is black, fighters regenerate faster, they
become bright and shiny as if auto-healing. How efficient this medicine is
depends on the 'medicine-power' parameter.
danger.png or medicine.png are gray, well,
it's in between, the “danger” and “medicine” effect will be proportional
to the level of gray.
There can be, at the same place, some gray or black in both medicine.png
and danger.png. How this will behave exactly is not really clear at this
stage, the recommendation is not to do this (it does not really make sense
anyway) but if you do it, game won't complain.
The four files:
one-way-north.png (AKA “up”)
one-way-east.png (AKA “right”)
one-way-south.png (AKA “down”)
one-way-west.png (AKA “left”)
can be used to force the fighters to go in one given direction, on some parts of
the map. If an area is black on one of this meta-layers, then fighters will go
in the given direction. For instance, a black zone in one-way-north will
make fighters go to the north (AKA “up” direction) regardless of the cursor
position. The fact that this is a one-way path is understood by fighters and they
will take this in account when choosing the shortest path to go somewhere.
You can combine vertical and horizontal one-way informations, making diagonal
one-way paths.
By default, a simple cursor will be displayed, but you can use a custom per-map cursor. Cursors are defined by two 64x64 bitmaps:
cursor.png is a PNG file, very likely to use transparency, which will
be default be colorized according to the map colors. You can draw it any color,
only greyscale informations will be used. You can keep the original colors if
you really want to by setting colorize-cursor to false, but the default
is to ignore the hue.
cursor-color.png is another PNG file, very likely to use transparency too,
which will always be colorized, replacing white by the team color, and black by the
“dead” color, which by default is black and is usually a dark color. This colorization
is a way to recognize your cursor and know which team it belongs to.
You can define only one of those bitmaps, if doing so, then the other layer will be empty, and won't be filled with the default cursor data. Note that additionnally, a little letter (single character) will be displayed using the team color, so that's yet another way to identify which teams the cursor belongs too. The PNG files really need to be PNG (JPEG won't work) and need to be 64x64, any other size will be ignored.
Whereas style.xml is only about the appearance
of the map, rules.xml allows the map designer
to change pretty much any parameter.
Ultimately, the player can still ignore these settings and overide them with its own values, but the idea is: most game options are only pertinent in a given context. For instance, on some maps it's interesting to move slowly, on some other it's interesting to move fast. Some maps might be playable packed with fighters everywhere, some other might be much more fun with almost nobody on them.
The approach in Liquid War 5 was to make the options available, but let the player himself find the right settings for the right map. The consequence is that no one ever used all those cryptic options in the advanced options menu, and probably 99% of the players ended up playing with default settings. This is not that bad, but given the fact that changing a few parameters one can totally transform the gameplay, it has decided been that in Liquid War 6, the map designer suggests the right options that matches his map.
This does not prevent the player from toying with options himself, he can still do it.
There's also one important point to note: all these options are
technically implemented as integer parameters. We certainly do not
want any float here, since, and it is a Liquid War specific behavior,
the game must be 100,00% predictable and behave the same on every platform.
As there is nothing like exactness when speaking of floats, those are
forbidden here. As for strings, we are dealing here with low-level
internals, and this section is not about telling a story. They
are technical options only. Booleans are implemented with the usual
false = 0 and true = 1 convention. Note that other
config files in Liquid War 6 might rely on floats, strings, and
booleans with conventionnal true and false values,
but not this one. rules.xml is special.
This rules.xml file is a direct image of the internal
“rules” structure, so it contains technical, sometimes not very
user-friendly parameters. While hacking rules.xml directly
is a good way to test things, most of the time, the other file
hints.xml contains more high-level informations that do
the job the right way. A typicall example is speed.
See rules.xml reference.
This parameter is only used by the map loader. The map itself contains none of these parameters, they are only clues (hints, in fact..) on “how to load the map” which are passed to the loader.
Let's take an example : speed. This rules.xml file has
a (rather) easy to use “speed” parameter, which will do all the job
of finding the right resolution for your map, the right “rounds-per-sec”
and “moves-per-round” parameters, in short, it will set many
other parameters to fit your needs.
As far as the map designer is concerned, rules.xml and hints.xml
could have been merged (but so would have style.xml) but internally
they are very different: rules.xml contains the real parameters,
the one used by the algorithm whereas hints.xml contains only instructions
which are used once when loading the map and then disappear. The core algorithm
has no idea of what was in hints.xml, once it's loaded.
See hints.xml reference.
This is a simple XML file defining various appearance parameters. It has absolutely no effect on gameplay. These settings can ultimately be overriden by the player, but the idea is that if the map designer thinks this level looks better with this or that option, let him say it in this file.
See style.xml reference.
In this file one can specify per-map team settings. In short, this is where you can say how many bots you want, which color, and so on. This can be on a per-map basis, so that each map has different customized settings, some maps might be fun with only one bot, some other maps might be fun packed with 8 opponents.
Technically, teams.xml will allow you to define up to
4 players and 9 bots. This is an awfull lot considering there are
only 10 colors. Basically, it's OK to simply define:
player1 and player2)
bot1 and bot2)
player2 and bot1 being
the same color, in case of a conflict the game will pick up another color, but
in practice those two entries often correspond to “the second player, bot or human,
coming on the battlefield”.
All in all, this represents 5 entries to set up (main player, other player or first bot which can be the same, then 3 more bots), it's OK to have the rest undefined or set to defaults.
Note that this can also simply be unset, and in that case the game defaults will apply, and the user will be able to change them, whereas if you set these up, the player will somewhat force to used the map settings.
See teams.xml reference.
This is a very important point. Liquid War almost *always* resamples maps, unless you ask it not to do it. This is not recommended, it is believed in the general case, letting the internal algorithm make its own decisions is better than trying to figure out oneself “which is the best resolution”.
The reason is, the right resolution (we're talking here of the logical resolution, how many fighters wide is the battlefield) often depends on the speed and general ressources the of the computer the program is running on. The map designer does not have this information. The program does. It runs a bench at startup. So this way it can choose, at runtime, the resolution which fits best.
The recommended way of doing things is not to try to be too picky about
rules.xml parameters related to speed and also let the default
map size limits in hints.xml to their defaults. Do not use them
unless debugging stuff.
Then the program will resample the map so that the player can play
on it at a reasonnable speed.
If map is too big, and it's often the case, then it will downsize it until
there are sufficiently few fighters so that the CPU can handle the job.
This, of course, is not rocket science. The bench calculation is a
somewhat brute-force approach of doing things. Formally, we would have
to run the map for good to figure out what is the right speed. Still,
this bench gives good approximations.
Previous versions of the game relied heavily on 'fighter-scale' to resample maps, but this is not the case anymore. The 'fighter-scale' is now a minor parameter which is used to upsize maps if they are too small. In 99.9% of the cases, the map is first upsized by 'fighter-scale' for this parameter is by default set low (1.0) then downsized by 'bench-value' for real-life personnal computers can't handle 1600x1200 maps in real-time. Not yet.
There are a bazillion options to control map size, including 'min-map-surface'. They are here because it's important that, ultimately, people can do whatever they want with the game. But for map design, this is another story. Don't use them. Rely on 'bench-value' and just care about game speed. This is achieved by changing the “speed” parameter.
It is possible to store your own custom music file within the map directory.
You can call it whatever you want (you can keep its original name, which is
something music authors usually appreciate, even if there's no strong
“attribution” clause on the license, it can be considered fair use not
to fiddle to much with the name) you just have to place it in the same
directory than the other files like map.png or texture.jpeg.
The following formats are known to work with the default
SDL_mixer based mod_ogg
backend:
ogg (Ogg Vorbis files)
wav
midi (extensions .mid and .midi should both work)
mod, s3m and xm files, AKA “modules”.
To be more precise, here's how things work:
music-file (parameter taken
from style.xml or defined/overriden by player) in the current map
directory;
step 2: if not found, it will try every path in music-path to find
this file. This includes the “system” music directory with musics that
ship with the game, but also the ./music subfolder in the user
directory;
step 3: if still not found, it will try to play a random file, relying
on music-filter to ignore some files.
In rules.xml you can set a special parameter which is exp
and allows you to tell “a player can't load this map if he doesn't have
at least N at his/her exp rating”. Gaining exp (stands
for “experience”) isn't hard, you just need to win a level with exp=N
to gain exp=N+1.
By default, the player's exp is 0 and levels default to 1, so this means
only levels with exp set explicitely to 0 in rules.xml might be
used. Then player wins that level and is given access to all maps by default,
unless these are explicitely set with exp greater than 1.
In solo game, when a player wins a level, he's automatically redirected
to the map which is in the same directory and has exactly the exp
he just gain. For instance, if you win a map with exp=5 then you're
chained to the first map (in alphabetical order) which has exp=6.
By setting up the exp parameter the right way, with a map for each
exp level one can transform a simple map directory in a scenario
that player will automatically follow.
Last, but not least, the game, at startup, only allows you to play red, green, blue and yellow. Other colors are unlocked as you progress among levels. Same things with weapons, there are “liberated” continuously through the game.
This mechanics allows the following behavior:
extra package.
As a final word, yes, it's possible to cheat, fool the exp system, but it's believed this is moot and lame.
Liquid War 6 uses GNU gettext for all
its messages. There's an online manual
about this tool. In practice, what you have to do as a translator is to
edit the po/xx.po file with xx being your language / country code.
For instance, to translate the game in French, one needs to edit po/fr.po.
This is very important, you might already be aware of it if you are familiar
with gettext, but still it's worth mentionning : when a string contains special
characters such as %d or %s (in a general manner, anything with
a % it's important that all translations contain exactly the same number
of %ds and %ss than the original.
For instance:
"foo has %d bars (%s)"
can be translated to:
"ziblug zdonc %d zuc - %s - tac"
The number, order and type of % entries is preserved. To learn more
about these formats, use info printf or man 3 printf. In a
general manner, get informations about printf.
Additionnally, some strings are used by Scheme (Guile) code and not
by C code. Thus, they don't use the standard C/printf convention.
In these strings, what you must preserve and be aware of is the tilde
character ~. Very often you'll see ~a in a string. As
with the printf %, you must preserve the number, order and type
of those. There is a complete
online reference
about this way of formatting strings.
Liquid War 6 has thousands and thousands of messages which could theorically be translated. In practise it's counter-productive to spend time to translate those, as the game is still evolving constantly, and as most of these messages are technical messages which inform about rare bugs and strange conditions. All sort of informations which, while valuable, are not intented for end-users and are more destinated to be reported in bug reports. To select only the interesting messages to translate, the current gettext configuration only uses a reduced set of files.
src/scriptpo.c : the most important file. It contains the definitions used
by all the Guile code, this is where you'll find all the menu labels.
src/lib/sys/sys-log.c : log messages and keywords. These are not the log
messages themselves, it only concerns the log engine. One can for instance
replace WARNING by ATTENTION.
src/lib/hlp/hlp-credits.c : the credits, which are
displayed at game startup in the splash screen.
src/lib/lw6-print.c : contains some messages printed on the console.
As a side note, the file src/lib/hlp/hlp-reference.c contains all the
entries for the various configuration options, anything that can be queried
by liquidwar6 --about=<keyword>. This is several hundred messages. It
might be interesting to translate them some day, but it's obviously not a
priority today.
Technically, Liquid War 6 is a collection of C functions which are exported to Guile. The main binary embeds a Guile interpreter, which will run a Guile script. This script calls the exported C functions, and glues them together.
It should be possible to implement the game without using Guile at all, using C code to make the various modules communicate together. This might seem an easier way to go, not involving several languages. However, using this script level is a good way to achieve several important goals:
Having Guile to implement high-level stuff also decreases, to some extent, the need for object-oriented features of C++. The big picture is : low level code that require speed, optimized data processing, is written in C. Code which is more high level and requires abstraction is written in scheme.
Liquid War 6 makes a heavy usage of threads. Early versions of the game did not have this feature but starting with 0.0.7beta, one can really consider the game is heavily threaded.
There's basically:
So globally, if you have an SMP system, the game will be happy with it. It will also run on a single processor, as the program uses POSIX pthreads it's capable to run on any computer which has pthreads implemented for it.
But, and this is a strong limitation, without pthreads, the game won't run. At all. Or at least, not unless it's almost completely rewritten.
The C code is splitted into several internal libraries. This allow independant testing of various game modules.
The main module, the most important one, is libker, (stands for “kernel”).
This is were the core algorithm is. To some extent, the rest of the code is
just about how to provide this module with the right data and environment.
Logically, if you profle the game, you should find out that a great part
of the CPU time is spent here. Code here is about spreading gradients, moving
fighters and cursors.
The libmap module is here to handle maps, it contains the code to manipulate
maps in memory. But it does not know how to load them from disk. This is the
responsability of another module, libldr, which is linked against libraries
such as libpng or
libjpeg and does the job of transforming those
standard formats into a usable in-memory structure. There's still a third
moduled involved in map handling, it's libtsk, whose job is to load a
level in the background. It has a 2-steps asynchronous loading system which allows
the game to load maps while the user interface is still responsive, and give
a preview of the map as soon as possible, when loading continues in the background,
building optimizing structures which are usefull when playing but not mandatory
just to show the map.
At the other end of the algorithm-chain, the libpil module will “pilot”
things. It's this module which will translate text readable orders (typically
adapted for network usage) into function calls. It has event lists, keeps
them in the right order, and will also permanently maintain
three different states of the game. A backup state which can be used any time
to go back in time and get the game in a stable 100% sure state. A reference state which
is correct but ever changing. Basically backup plus all the orders received
between backup and reference gives reference. And finally a draft state which
is as up to date as possible but might be wrong. This is typically interesting
in network game, where we want to show something moving, something fast, even
if there's lag on the network and other computers fail to send information in time.
In this case we display draft while still keeping reference and updating it
when we finally receive valid informations. Backup would be used to send
bootstrap information when people are joining a new game, or to check up if
things are going right.
A special libbot module is here to handle bot algorithms. A bot is just
a simple move function which takes a game state as an input, and returns
an x,y position, just the way a mouse handler would. How complex a
bot is “under the hood” depends on the type of bot. Current bots are really
basic. Additionnally, libsim will run dummy fight simulations to find
out wether some team has a real advantage on another one, speaking of team
profiles depending on colors.
The libgfx module handles all the graphics stuff. It is itself splitted
in several sub-modules, that is, it does not do anything but load a module
such as mod-gl which will actually contain the implementation. In an
object-oriented language, it would be an abstract class, an inteface. The
implementation does not need to be thread-safe. It's better if it is, for
theorically it could be possible to fire Liquid War 6 with two display
backends running at the same time on the same game instance, but this code
has yet to be written, and it's a rare dual headed configuration which
probably has no real-life usage. If only one graphics backend is activated
at a time, the rest of the implementation garantees there will never
be two concurrent calls to a function is this module. It is the
libdsp (“display”) which handles this. It fires a thread for
rendering purposes, and sends information to this thread, detecting
automatically if it's necessary to acquire a mutex and update rendering
informations. For the caller, this is transparent, one just has to
call an update function from time to time. The module will even perform
“dirty-reads” on a game state being calculated, to render things
in real time, as soon as possible.
An experimental libvox module is under design/development and
might, in the future, provide a real-time voxel renderer. Still pre-alpha
stage.
To ease up the implementation of different graphics backends, a libgui
module contains code which is meant to be used by any graphics backend.
It's just a factorisation module, containing common code and interfaces,
related to displaying things. This is where, for instance, one can find
a high level menu object.
The libsnd module handles sound. It's also an abstract class, an interface,
which uses dynamic backends as implementations.
The libnet module is a wrapper over different network APIs, it
handles Winsock and POSIX sockets in a uniform manner.
The libcli and libsrv contain network client and server code,
implementing the various protocols in dynamically loadable sub-modules.
It's the role of libp2p to glue this together, handle the list
of available servers, the message queue, verifying nobody is cheating,
and so on. All this modules share information about current game
state using code & structures defined in libnod,use message
utilities (format, parse) defined in libmsg and share code concerning connections in libcnx. Additionnally, libdat
provides facilities to store old network messages and sort them.
The libsys module contains most system and convenience functions, it handles
logs, type conversions, timer, memory allocation, it's the fundamental
module every other module depends on. It has a compation libglb
module with all the Gnulib shared code.
The libhlp is used to handle keywords and internal self-documentation
(this is what is used by --list and --about), libcfg
knows how to read and save config files, libcns handles the console,
and libdyn can load .so shared files dynamically.
To glue all this, there are some Guile bindings with helper functions
available in libscm which fills two needs, one being an easy way
to check if Guile linking is working correctly without requiring all other
modules to be available, and also performing automatic checks on some actions
such as registering or executing a function.
Finally there are small modules like libimg (to make screenshots of the game)
which
have been separated because they required special libraries to link with
and/or did not really fit in existing modules for dependencies reasons.
So well, this is a lot of modules. The list might move a bit, but the big picture is here. Each module is testable separately.
Below is a Graphviz diagram, which shows the modules dependencies.
The most important memory structures in Liquid War 6 are:
lw6map_level_t) : this contain the map immutable informations.
This is what resides in memory after a map has been loaded from the disk.
It contains all the various .png and .jpeg files stored
as pixel arrays, resampled if need, and also contains the various map
attributes. Once this structure is ready, the game is capable of displaying
the map on the screen, but it can not do anything with it yet.
lw6ker_game_struct_t) : this one contains the same informations
as the previous structure, only the information has been post-treated so that it's
ready for use by the core algorithm. It will, for instance, contain the famous
mesh structure, which groups squares by packets of 1, 4, 16, 64 or more. The reason
it's been separated from the level is that operations such as creating the mesh
might require a lot of time. So to allow players to see the level while black magic
is still running in the background, it was required to make a difference between
what is required to view the map (“level”) and what is required to play on
it (“game_struct”).
lw6ker_game_state_t) : contains all the variable, ever
changing game data. This is where the position of fighters is stored, their
health, and such things. It is designed to be synchronizable by using mostly
simple calls to memcpy. It heavily relies on the previous structures,
the idea is that one can have several “game_state” plugged on a
single “game_struct”.
All these structures are defined in the ker/ker.h header.
The core Liquid War 6 algorithm is 100% predictable, that is to say, given the same input, it will produce the same results, on any computer. Previous versions of the game also had this property. This is very important for network games, since in a network only informations such as “cursor A is at position x,y” are transmitted. Every node maintains its own internal game state, so it's very important that every node comes with the same output given the same input.
For this reason Liquid War 6 never uses floating point numbers for its core algorithm, it uses fixed point numbers instead. It also never relies on a real “random” function but fakes random behavior by using predictable pseudo-random sources, implementation independant, such as checksums, or modulos.
There are also some optimizations which are not possible because of the predictability requirement, for instance one can not spread a gradient and move the fighters in concurrent threads, or move fighters from different teams in different threads.
If you read the code, you'll find lots of checksums here and there, a global checksum not being enough for you never know where the problem happened. The test suite uses those facilities to garantee that the game will run the same on any platform.
Not being able to rely on a predictable algorithm would require to send whole game states on the network, and this is certainly way too much data to transmit. A moderate 200x200 map has a memory footprint of possibly several megabytes, so serializing this and sending it to multiple computers at a fast-paced rate is very hard, if possible at all, even with a high bandwidth. We're talking about Internet play here.
Liquid War 6 has a modular architecture which allows the programmer (and the player) to plug pretty much any rendering/graphics backend, provided this one is... developped.
As of 2009 the only available backend is still mod-gl, it will
display the game using 3D acceleration, if available, through the
SDL library, using its GL bindings.
Additionnally, versions available for Microsoft Windows and Mac OS X will
probably never any other backends available. For technical reasons, those
platforms do not have the flexibility of GNU/Linux and do not allow
graphical libraries to be loaded dynamically. In practice, both of them
require hacks that override the standard main function. Microsoft Windows
has its WinMain instead, and Mac OS X is even more pedantic,
requiring graphical functions to be executed in the main thread.
So mod-gl is just linked statically in those versions, and
the modularity of the game is purely theorical on these platforms.
This mod-gl module is really one of the key stones of
Liquid War 6, and if you want to change graphical things, it's definitely
the place to hack on. The source is in src/lib/gfx/mod-gl.
The mod-gl backend requires “moderate” hardware, but it
still does require hardware acceleration. Pure software rendering
through mesa for instance, won't
be enough.
So if you're running Xorg on GNU/Linux and there's a DRI driver for your card, the game should run fine.
On the programmer side, the counterpart is that one should not rely
on fancy OpenGL features. Textures have a maximum size of 512x512
for instance. Of course some maps are bigger than this but this
means that internally, mod-gl splits them into smaller tiles,
and displays those tiles one by one.
Inside the mod-gl backend, the src/lib/gfx/mod-gl/gl-utils
directory contains lots of common structures, factorized functions which
can (and should, if appliable) be used.
In addition to all the common
Autoconf switches
such as --prefix, Liquid War 6 has some custom switches:
--enable-console: allows you to turn on/off console support.
Normally this is detected automatically but in case you really want
to disable it on platforms which support it, you can. This will cause
the program no to link against libreadline, among other things.
--enable-gtk: allows you to turn on/off gtk support.
Normally this is detected automatically but in case you really want
to disable it on platforms which support it, you can. This will cause
the program no to link against GTK libs.
--enable-optimize: will turn on optimizations. This will
turn on compiler options such as -fomit-frame-pointer
but also disable some code in the program. Indeed, most of
the advanced memory checking in the game - which ensures it
does not leak - will be turned of. This will certainly speed up
things, however, it's not recommended to turn this on until
program is not stable enough so that memory leaks and other
problems can be declared 'impossible'. Turn this on if you
really have some speed problem, otherwise it's safer to use
the full-featured 'slow' version of the game.
--enable-paranoid: will turn on very picky and pedantic
checks in the code, try this when you suspect a serious memory
bug, a race condition whatsoever, and want to track it down.
Useless for players.
--enable-headless: will allow compilation without any
graphics backend. The game is unplayable in that state but one
can still wish to compile what is compilable, for testing purposes.
--enable-silent: will allow compilation without any
sound backend. The game won't play any music in that state but one
can still wish to compile what is compilable, for testing purposes.
--enable-allinone: will stuff all the internal libraries
into one big executable.
Very convenient for profiling. The major drawback is that
you need to have all the optional libraries installed
to compile all the optional modules. Another side effect is that
with this option there's no more dynamic loading of binary modules,
so if your platform has a strange or buggy support for .so
files, this option can help.
--enable-fullstatic: will build a totally static
binary, that is using the --static option
for gcc and the -all-static option
for libtool. Currently broken, this option could
in the future allow for building binaries that run
pretty much everywhere, without requiring any dependency
but a Kernel.
--enable-gprof: will enable profiling informations.
This will activate --enable-allinone, else you would
only track the time spent in functions
in the main liquidwar6 executable, and exclude lots
of interesting code contained in dynamic libraries.
--enable-instrument: will instrument functions for
profiling. This will turn on the -finstrument-functions
switch when compiling, so that the hooks
__cyg_profile_func_enter and __cyg_profile_func_exit
are called automatically. Then you can link against tools like
cprof or
FunctionCheck.
--enable-profiler: will enable
Google Performance Tools
support. Basically, this means linking against libtcmalloc
and libprofiler. You could activate those by using
LD_PRELOAD or by using your own LDFLAGS but
using this option will also make the game tell you if
CPUPROFILE or HEAPPROFILE are set
when it starts. The pprof -gv output is very handy.
Note that on some systems pprof is renamed google-pprof.
--enable-gcov: will enable coverage informations,
to use with gcov
and lcov.
This is for developpers only. It will activate --enable-allinone,
else there would be some link errors when opening dynamic libraries.
The obtained information is available online:
coverage.
and
GNU global.
--enable-valgrind: will enable some CFLAGS
options which are suitable for the use of
Valgrind, to track
down memory leaks and other common programming errors.
Use for debugging only, usually together with
--enable-allinone.
Liquid War 6 does have a ./debian in both main and extra maps packages,
so it's “debianized”.
To build the main .deb package, untar the main source tarball, then:
make dist cd pkg cp ../liquidwar6-X.Y.Z.tar.gz . # X.Y.Z is the version make deb
Note that you have to copy the source tarball to ./pkg and move
to this directory before typing make deb. This is, among other things,
to simplify the main Makefile.
To build the extra maps .deb package, untar the extra maps tarball, then:
make deb
Liquid War 6 does have a .spec files in both main and extra maps packages.
To build the main .rpm package, untar the main source tarball, then:
make dist cd pkg cp ../liquidwar6-X.Y.Z.tar.gz . # X.Y.Z is the version make rpm
Note that you have to copy the source tarball to ./pkg and move
to this directory before typing make rpm. This is, among other things,
to simplify the main Makefile.
To build the extra maps .rpm package, untar the extra maps tarball, then:
make rpm
This section describes how to compile the game from source under Microsoft Windows. Note that players are encouraged to use a free system such as GNU/Linux, which is the platform Liquid War 6 is being hacked on by default. If you encounter problems with this port, you'll probably save time by installing a double-boot with GNU/Linux coexisting with your previous Microsoft Windows install.
Basically, Liquid War 6 requires
MinGW.
More precisely, it requires MSYS.
A standard Cygwin installation won't
work, because it is too UNIXish to allow third party libraries
like SDL to compile natively.
You might argue that SDL is available for Cygwin, but in reality,
the Cygwin port of SDL is a MinGW port. Indeed, Cygwin brings
all standard POSIX functions including the use of main
instead of WinMain and I suspect this is a problem for
graphical libraries like SDL which do require some sort of direct
access to the OS low-level functions. Therefore, MinGW is more
adapted for it does not define all these functions, and
allows any library to hook on Microsoft Windows internals directly.
Point is then, you also loose the cool effect of Cygwin which
is to have a complete glibc
available,
including network functions like select defined the
POSIX way, and not the WinSock way. If you ever ported code from
POSIX sockets to WinSock 2, you know what I mean. Using MinGW
is also embarassing for some libraries won't compile easily, and
for instance programs which heavily rely on a real TTY
interface to work are usually hard to port. This includes
ncurses
and
GNU readline.
Liquid War 6 tries to have workarrounds for all this, and in
some cases the workarround is simply that embarassing code
is not compiled on Microsoft Windows. For this reason, some
features are not available on this platform. Period.
Now the reason you need MSYS and not only MinGW is that MSYS
will allow ./configure scripts to run, and this eases
up the porting process a lot. MinGW and MSYS packages are
downloadable on the
SourceForge MinGW download page. Alternatively, there is a
mirror on ufoot.org,
but files might be outdated.
To compile Liquid War 6, first download and unzip all the
following files in
the same directory, for instance C:\MSYS.
If you do not have any tool to handle .tar.gz and .tar.bz2
files under Microsoft Windows, which is likely to be the case
when MSYS is not installed yet, you can untar these on any GNU/Linux box,
then upload the whole directory to the target Windows host.
This file list might contain file which are not absolutely mandatory for Liquid War 6, for instance the Fortran 77 compiler is absolutely useless, but installing it won't harm either. Some packages might unzip things the right way, but some do it in a subfolder. You might need to run commands like:
cp -r coreutils*/* .
rm -rf coreutils*
Get rid of useless files:
rm ._.DS_Store .DS_Store
It's also mandatory to move everything that has been installed in
/usr or /usr/local to / since MSYS has some
builtin wizardry which maps /usr on /.
You need to do this if you don't unzip files from a MinGW shell,
which is obviously the case when you first install it. Usefull command
can be:
mv usr/* .
rmdir usr
Next, libintl is not correctly handled/detected by LW6,
and can raise an error like
"gcc.exe: C:/msys/local/lib/.libs/libintl.dll.a: No such file or directory"
so one needs to copy some libraries in /usr/local/lib/.libs/:
mkdir local/lib/.libs
cp local/lib/libintl.* local/lib/.libs/
Another step is to edit /etc/profile and add lines like:
export CFLAGS="-g -I/usr/local/include"
export LDFLAGS="-L/usr/local/lib"
export GUILE_LOAD_PATH="C:\\MSYS\\local\\share\\guile\\1.8\\"
Close and re-launch your msys shell (rxvt) so that these changes take effect. Check that those values are correctly set:
env | grep FLAGS
env | grep GUILE
Finally, your MSYS environment is (hopefully...) working.
Now you need to compile the following programs, from source.
Files are mirrored on ufoot.org for your convenience, however these might be outdated.
Still, there are known to work.
Proceed like if you were under a POSIX system.
Some packages use the --disable-rpath swith, there are various
reasons for which rpath is an issue.
In the same manner, --disable-nls when linking against libintl
or libiconv was painful.
make clean GC; cp pthread.h sched.h /usr/local/include/; cp pthreadGC2.dll /usr/local/bin/; cp libpthreadGC2.a /usr/local/lib/
gmp-4.2.2.tar.gz
then ./configure && make && make install
guile-1.8.5.tar.gz.
Edit libguile/guile.c
and insert #undef SCM_IMPORT
just before #include <libguile.h>.
Edit ./libguile/threads.c and place struct timespec { long tv_sec; long tv_nsec; }; just before #include "libguile/_scm.h".
Then ./configure --disable-nls --disable-rpath --disable-error-on-warning --without-threads && make && make install. The GUILE_LOAD_PATH value must be correctly
set for guile-config to work. For unknown reasons, running guile
can throw a stack overflow error. Don't panic.
See bug 2007506 on SourceForge.net for an explanation on
why the Guile binary shipped with MSYS is not suitable for Liquid War 6.
expat-2.0.1.tar.gz
then ./configure && make && make install
sqlite-amalgamation-3.5.9.tar.gz
then ./configure && make && make install
libpng-1.2.29.tar.gz
then ./configure && make && make install
jpegsrc.v6b.tar.gz
then ./configure && make && make install && make install-lib
curl-7.18.1.tar.gz
then ./configure --without-ssl && make && make install
freetype-2.3.5.tar.gz
then ./configure && make && make install
libogg-1.1.3.tar.gz
then ./configure && make && make install
libvorbis-1.2.0.tar.gz
then LDFLAGS="$LDFLAGS -logg" && ./configure && make && make install
SDL-1.2.13.tar.gz
then ./configure && make && make install
SDL_image-1.2.6.tar.gz
then ./configure && make && make install
SDL_mixer-1.2.8.tar.gz
then ./configure && make && make install
SDL_ttf-2.0.9.tar.gz
then ./configure && make && make install
For your convenience, a zip file containing a complete MSYS "Liquid War 6 ready"
environment is available. It is simply the result of all the operations
described above.
Simply unzip msys-for-liquidwar6-20080819.zip
(about 240 megs) in C:\MSYS\.
All dependencies compiled in /local have been generated
using the command:
cd /usr/local/src
./msys-for-liquidwar6-build.sh > ./msys-for-liquidwar6-build.log 2>&1
Note that this script does't do everything, you'll still need to edit Guile source code and patch it manually.
It might even be possible to use this MSYS environment
under Wine.
Simply unzip it under $HOME/.wine/drive_c, and run
wine "$HOME/.wine/drive_c/windows/system32/cmd.exe" /c "c:\\msys\\msys.bat" and with
luck, you'll get a working shell. Note that this might allow you to compile
the game, but running it is another story. Consider this MSYS over Wine trick
as a hack enabling the use of free software only when compiling for
Microsoft proprietary platform. It is not a reasonnable way to run the game.
If running under a UNIXish platform, or better, GNU, simply run native code.
Use the Windows 32-bit port only if you are jailed on a Microsoft system.
Now, let's come to the real meat, untar the Liquid War 6 source tarball, launch your MSYS shell, and:
./configure
make
make install
Now the binary is in src/.libs/liquidwar6.exe
(beware, src/liquidwar6.exe is only a wrapper).
This binary is an MSYS/MinGW binary, so it read paths “Ã la”
Microsoft, that is, it has no knowledge of what /usr is,
for instance. It requires paths starting by C:\.
This is still experimental. Basically, install MacPorts, and most dependencies with,
except for SDL which you compile from source. The idea is to compile SDL using
the native OS X bindings (and not some other GL files you could have in /opt/local
installed by MacPorts), then compile the game and other SDL dependencies
against this SDL.
The SDL_mixer library might need to be told to compile itself without dynamic ogg support.
By default it seems that it tries to load libvorbisfile.dylib at runtime, and it can fail.
To disable this dynamic loading, use for instance :
/configure --prefix=/opt/extra --enable-music-ogg --disable-music-ogg-shared
Also, it might seem obvious for Mac OS X users, but there are some important issues related to compiling options and handling dynamic libraries at runtime.
ldd does not exist, run otool -L instead.
LD_LIBRARY_PATH is DYLD_LIBRARY_PATH.
.dylib and not .so.
OBJCFLAGS environment variable along with CFLAGS
because the Mac OS X port uses some Objective-C code.
It is very important to have the right SDL flags when linking the Liquid War 6 binaries. For instance it could be:
-I/opt/extra/include -I/opt/local/include -Wl,-framework -Wl,CoreFoundation -I/opt/local/include -D_THREAD_SAFE -Wl,-framework -Wl,Cocoa -Wl,-framework -Wl,OpenGL -Wl,-framework -Wl,Cocoa
The point is to have Cocoa and OpenGL support. Depending on the way you installed SDL,
you might also need to include an SDL framework support, this is mostly if you installed SDL from
.dmg binary images, and not from source with the command line. A typical output of sdl-config --libs is:
-L/opt/extra/lib -lSDLmain -lSDL -Wl,-framework,Cocoa
Another important issue is to include SDL.h, which in turn includes SDLmain.h, in
all the .c source files defining the standard main function. This is done in liquidwar6 but
should you try to link yourself on liquidwar6 libraries and/or hack code, you must do this or
you'll get errors when running the game. Such errors look like:
*** _NSAutoreleaseNoPool(): Object 0x420c90 of class NSCFNumber autoreleased with no pool in place - just leaking
The reason is that SDL replaces your main with its own version of it. One strong implication
is that all the dynamic loading of SDL, which works on sandard GNU/Linux boxes, won't work under
Mac OS X, since SDL hard codes itself by patching main with #define C-preprocessor commands.
A .dmg file (disk image) containing a Liquid War 6.app folder (OS X application)
is available for your convenience. It might work or not. In doubt, compile from source. The complicated part about this package (a “bundle” is OS X language) is that
it needs to embed various libraries which are typically installed in /opt
by MacPorts on a developper's machine. So to build this package a heavy use
of the utilility install_name_tool is required, normally all libraries
needed ship with the binary, remaining depedencies concern frameworks which
should be present on any working Mac OS X install. Still, this is only theory.
Needs to be widely tested.
The layout of the bundle follows:
./Contents/Info.plist: metadata, bundle description file
./Contents/MacOS: contains the main binary liquidwar6 as well as all specific low-level libraries
./Contents/Resources/data: general game data, does not contain maps.
./Contents/Resources/music: music for the game.
./Contents/Resources/map: system maps, you can put your own maps (or “extra” maps) here if you want all users to share them.
./Contents/Resources/script: Liquid War 6 specific scripts, the scheme scripted part of the program.
./Contents/Resources/guile: common shared Guile scripts, part of Guile distribution.
./Contents/Resources/doc: documentation in HTML and PDF formats.
Additionnally, the Mac OS X port uses /Users/<username>/Library/Application Support/Liquid War 6/ to store
configuration file, logs, etc. It does not use $HOME/.liquidwar6 like the default UNIX port.
The Mac OS X port also has a special behavior, in order to load some libraries with dlopen
(SDL_image does this with libpng and libjpeg) it needs to set DYLD_FALLBACK_LIBARY_PATH to a
value that contains these libraries. This is typically in the bundle distributed on the disk image.
On a developper's computer this problem does not appear for those libs are often in places like:
/usr/local/lib
/usr/X11/lib
/opt/local/lib
DYLD_FALLBACK_LIBARY_PATH (but not DYLD_LIBRARY_PATH else
it breaks internal OS X stuff which relies, for instance, on libjpeg library that has the
same name but different contents) but it needs to do it before it is even run, else
the various dyld functions do not acknowledge the change. That is, calling the C
function setenv(), even before dlopen(), has no effect. So the program
calls exec() to re-run itself with the right environment variable. This is why,
on Mac OS X, there are two lines (exactly the same ones) displaying the program description
when it is started in a terminal.
This is not working yet, but there are good hopes that some day, Liquid War 6 can run on a GP2X console. This handled gaming device uses a Linux kernel on an ARM processor, does support most GNU packages through cross-compilation, and has basic SDL support.
To compile Liquid War 6 for GP2X, you first need to set up a working “toolchain”. It's suggested you do this on a working GNU/Linux box. There are several solutions, the recommended one being Open2x. Read the online documentation on how to install Open2x.
Basically, the following should work:
mkdir /opt/open2x # check that you can write here svn co https://open2x.svn.sourceforge.net/svnroot/open2x/trunk/toolchain-new open2x-toolchain ./open2x-gp2x-apps.sh cd open2x-toolchain
Then, for your environment to be complete, you need to set up some environment variables. For instance:
export OPEN2X_SYSTEM_PREFIX=/opt/open2x/gcc-4.1.1-glibc-2.3.6/arm-open2x-linux
export GP2X_USER_PREFIX=$HOME/gp2x
export CC=${OPEN2X_SYSTEM_PREFIX}/bin/arm-open2x-linux-gcc
export CPP=${OPEN2X_SYSTEM_PREFIX}/bin/arm-open2x-linux-cpp
export CXX=${OPEN2X_SYSTEM_PREFIX}/bin/arm-open2x-linux-g++
export AS=${OPEN2X_SYSTEM_PREFIX}/bin/arm-open2x-linux-as
export CFLAGS=''-I${OPEN2X_PREFIX}/include -I${GP2X_USER_PREFIX}/include''
export CPPFLAGS=''-I${OPEN2X_PREFIX}/include -I${GP2X_USER_PREFIX}/include''
export CXXFLAGS=''-I${OPEN2X_PREFIX}/include -I${GP2X_USER_PREFIX}/include''
export LDFLAGS=''-L${OPEN2X_PREFIX}/lib -L${GP2X_USER_PREFIX}/lib''
export PATH=''${GP2X_USER_PREFIX}/bin:${OPEN2X_SYSTEM_PREFIX}/bin:$PATH''
In this setting, there's a user $HOME/gp2x directory which will
contain all the Liquid War 6 related libraries while the /opt/open2x
remains untouched.
Then you need to install the requirements. All these packages need to
be cross-compiled. To make things clear and non-ambiguous, even if you
have CC set up in your environment variables, pass --build
and --host arguments to the ./configure script of all these
packages. A typical command is:
./configure --build=i686-pc-linux-gnu --host=arm-open2x-linux --prefix=${GP2X_USER_PREFIX}
Here's the list of the requirements:
./configure --prefix=$GP2X_USER_PREFIX --build=x86_64-pc-linux-gnu --host=arm-open2x-linux --disable-pulseaudio --disable-video-directfb
--witout-threads switch to the ./configure
script else it will try (and fail!) to run a test program. Liquid War 6 does
not use Guile threads, it does use threads but uses them “directly” outside
the Guile layer.
--build and --host for this one, they are
unsupported. Package compiles fine anyway.
Next, one needs to install a special version of SDL, which targets the GP2X specifically. This is not a generic SDL, and it does have limitations, which are related to the GP2X peculiar hardware. There are installation instructions about how to do this. The following should work:
cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/open2x login # blank password cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/open2x co libs-gp2x
One of the purposes of Liquid War 6 is to make a cleaner implementation of Liquid War than the previous one, namely Liquid War 5. While the latter has achieved the practical goal of providing a playable implementation of the game, it failed at providing an evolutive platform. Network capabilities where finally added to Liquid War 5, but anyone who played on Internet with someone a few hundreds of milliseconds away would agree that it's far from being perfect. The main reason for this is that it is really had to hack on Liquid War 5, especially when you are not the core developper. The core developper himself, even knowing all the various hacks in the game, is very quickly lost when trying to implement major changes.
To put it short, Liquid War 5 is a global variable hell, a pile of hacks on top of a quick and dirty implementation. Still, it works.
With Liquid War 6, the idea is to take the time to make something stable, something nice which will enable developpers to implement the cool features, and have fun along the way. Of course, this is only a dream, and in the (hopefully "very") long run, Liquid War 6 will also end up as a big unmaintainable mess, like any real-life program, until then, it should remain hackable.
Here are a few guidelines which I think are common sense advice, but they are still worth mentionning:
strcpy or sprintf anywhere in the code.
Nowhere. Use their equivalent strncpy and snprintf systematically,
as they are part of the glibc and are an order of magnitude safer.
Moreover, Liquid War 6 provides wrappers, such as lw6sys_new_sprintf
which handles all the nasty dirty memory allocation stuff for you;
Each of the internal libraries in Liquid War has a “test” program
associated with it. For instance liquidwar6sys-test is
associated to libliquidwar6sys, and its purpose is to
test the features of this library.
While it is fairly easy to test out unitary functions which require no peculiar context, testing high-level functions which requires files, graphical and possibly network contexts to exist is obviously harder to achieve. There's no easy way to draw the line, but the idea is to put in these test executables as many features as possible, to be sure that what is tested in them is rock solid, bullet proof, and that one can safely rely on it and trust that code when running it in a more complex environnement.
These test executables are also very good places to see a library API in action, find code fragments, and make experiments.
Liquid War 6 provides macros to allocate and free memory. One should use them systematically, except when trying to free something allocated by another library, and in very special cases, mostly concerning low-low level operations which are seldom hacked on.
Usage of macros LW6SYS_MALLOC,
LW6SYS_CALLOC and LW6SYS_FREE is straightforward,
read any random chunk of code, for instance ./src/lib/sys/sys-test.c
to see them in action. They are defined in sys/sys.h.
Once used, these macros will track every single call to malloc and free,
and if there's a difference, it will report it. It will also help you by
showing what's in the non-freed memory area, at which line of code
it has been allocated, and when. This is very usefull to track down memory leaks.
Of course a debugger could tell you some of these informations, but experience
shows than when you encounter a memory bug, it's very often impossible to
reproduce it. So you one wastes time trying to reproduce the bug, whereas
with this tool you have the information reported just when the problem happens.
Each library exports a public interface and hides its internal.
Since Liquid War 6 uses standard C and no C++, there's no
real standard way to handle public/private features. The
convention used in Liquid War 6 is to show internal structures
as opaque pointers (void *) whenever some function needs
to operate on a structure which has possibly private fields.
This way the caller function has no way to access the internals,
and we are sure that no reference to any internal implementation
specific feature will appear.
Here's a code excerpt from src/gfx/setup.c:
void _lw6gfx_quit(_LW6GFX_CONTEXT *context) {
/*
* Implementation here.
*/
[...]
}
void lw6gfx_quit(void *context) {
_lw6gfx_quit((_LW6GFX_CONTEXT *) context);
}
The function _lw6gfx_quit (note the “_”) is internal,
declared in internal.h whereas the function lw6gfx_quit
is public, and is therefore exported in gfx.h.
This way, functions in the program using lw6gfx_quit
do not know what is in the _LW6GFX_CONTEXT structure,
and they need not know it.
This does not mean it is not possible to have public structures, only these structures must reflect some truely public, accessible and safe to access structures.
Liquid War 6 is regularly audited with automated tools. You might
need to pass --enable-gcov to --configure if you want
to use thes tools yourself. More precisely:
liquidwar6ker-test or liquidwar6ker-pil.
Bits of code which depend on other libraries are a different story, for
some projects on which Liquid War 6 depends might, for some reason, raise
warnings. But as far as Liquid War 6 is concerned, the goal is simple: zero leak.
Those tools certainly don't garantee the code is perfect, but they do help improving the quality of the program. If you hack, it's recommended you give them a try.
The console can be activated by passing --display-console when starting
the game or by using the system options menu.
When the console is activated, a lw6> prompt should appear in the
terminal which launched the program. If you started Liquid War 6 by clicking
on an icon, console probably won't work at all since stdout and
stdin won't be attached to anything.
The console allows you to type arbitray Scheme/Guile code.
Try, for instance:
(+ 1 2)
(display "foo\n")
You can really break things with this console, it gives you a direct access to all the program internals. At least, all the values which are accessible through the script interface, that is, many of them.
You can call any internal C function which has been exported to Guile, here are some examples:
(c-lw6sys-timestamp)
(c-lw6bot-get-backends)
(c-lw6sys-sleep 2.0)
(lw6-config-get-number "zoom")
(lw6-config-set-number! "zoom" 0.9)
(lw6-config-get-number "zoom")
While syntax (and possibly other) errors will be trapped by the interpreter, note that if you break things inside the game by, say, changing some global value, or in a general manner cause an error elsewhere in the code, the game will really raise a fatal error and stop. That's how you can “break things”.
Still, this console is a very powerfull tool, very usefull for debugging but also for tweaking the game without restarting it and/or navigating through the menu interface.
Liquid War 6 tries to have as few hardcoded data as possible. So many
constants, and pretty much all the image files, are accessible in the
data directory. You can know where it is by launching
liquidwar6 --show-data-dir. If you look in this directory
you'll find different files, among
them XML files.
Let's take an example. Try and find the file gfx/gl/hud/floating/gl-floating-const.xml.
Edit the line with the clock-y1 entry. Change the number after "value".
Re-run the program. Play a game. What happens? Logically you should see that
“something” is not displayed at the same place than before.
You could also modify the textures (JPEG and PNG files). In a general manner it's more cautious to keep them the same size but it depends, sometimes other sizes will work as well.
Many of these parameters are really too technical and obscure to have their place in the main config file (which is already rather big). Use at your own risks, you can really break things touching this, but you can also find out lots of things can be tuned.
Todo...
Todo...
Todo...
This section describes how Liquid War 6 handles network messages. Note that for now this is purely theorical, more of a draft, a plan, it might change before being implemented.
Liquid War 6 does not really have the notion of server or client, any instance of the program can act as both server and client, therefore we use the term node.
A node listens on a given port, in both TCP and UDP, and can
connect to other nodes on the same port. The main identifier
of a node is its public url, which is typically of the
form http://<ip-address>:<port>/. This url is very important
for it is (or at least should be) a unique identifier of the
node over the network.
Liquid War has 3 ways to communicate:
mod-tcp and mod-tcpd.
mod-httpd and client part requires mod-http which might or
not be available, depending on how the game was compiled.
mod-udp and mod-udpd
to work. Using UDP only was not an option when conceiving Liquid War since
it's interesting to have other solutions if, for instance, a firewall
does not allow you to use UDP the way you want.
On each of these channels, messages can be exchanged in two modes, an “out of band” mode (AKA “oob”), and a regular message oriented, here we speak of “connection”.
There are only 3 out of band messages:
PING:
requests for a simple PONG http://server:port/ answer, this is just to
check if a server is a valid server, and if the URL we used to connect on it
is the correct one.
INFO:
requests for a list of key/attributes pairs, which describe the node, telling
for instance its version, its uptime, and so on.
LIST:
requests for a list of other nodess this node is aware of.
You can test out of band messages by simply connecting on your server with a command like:
telnet localhost 8056
At the telnet prompt, simply type:
INFOand press return, and you should have a description of your node.
The complete syntax of OOB messages is:
<COMMAND> [password] [url]
The password and url parameters are optionnal. password can contain either the plain text password or a checksum calculated from the password which is, for security reasons, seeded with the public url of the node we're connecting to, so that this password can't be re-used on another node. url is simply a clue we give to the other node to help find us, the other node will automatically try to detect our IP address and use standard LW6 port 8056, but if for some reason we use a different setting, this is a good way to pass the hint.
As far as OOB is concerned, TCP and UDP work almost the same, HTTP is a bit different, the OOB commands are accessed through the following URLs:
/ping.txt
/info.txt
/list.txt
TCP messages:
LW6 [<passwd>] <version> <client-id> <from-id> <to-id> <serial> <i> <n> <sig> MSG1 <from-id> <to-id> <serial> <i> <n> <sig> MSG2
TCP oobs:
<return> # only works anonymous, same as INFO INFO [<passwd>] [<public-url>] LIST [<passwd>] [<public-url>] PING [<passwd>] [<public-url>]
UDP messages:
LW6 [<passwd>] <version> <client-id> <from-id> <to-id> <serial> <i> <n> <sig> MSG1 LW6 [<passwd>] <version> <client-id> <from-id> <to-id> <serial> <i> <n> <sig> MSG2
UDP oobs:
INFO [<passwd>] [<public-url>] LIST [<passwd>] [<public-url>] PING [<passwd>] [<public-url>]
HTTP messages:
client id & password passed in HTTP headers
/lw6/version/<from-id>/<to-id>/<serial>/<i>/<n>/sig/MSG1 /lw6/version/<from-id>/<to-id>/<serial>/<i>/<n>/sig/MSG2
HTTP public URLs:
/ -> index.html /index.html /favicon.ico /screenshot.jpeg /robots.txt /gpl.txt /info.txt /list.txt /ping.txt
MSG syntax:
<round> <server-id> <command> <arg1> ... <argN>
COMMAND examples:
2 1234abcd1234abcd REGISTER 3 1234abcd1234abcd ADD 5678 YELLOW 4 1234abcd1234abcd SET 5678 20 5 10 1234abcd1234abcd NOP 400 1234abcd1234abcd REMOVE 5678 1000 1234abcd1234abcd UNREGISTER
Sig is a checksum on string:
<from-id> <to-id> <serial> <i> <n> MSG
Summary off all operations required for a release:
LW6MAP_RULES_DEFAULT_EXP and default for --skip-network, which might have been changed will developping.
./src, run ./indent.sh.
./doc, run ./gdoc-update.sh.
NEWS file, in both liquidwar6 and liquidwar6-extra-maps. Check ChangeLog is OK.
doc/liquidwar6.texi.
debian/changelog files in both main and extra maps packages.
make distcheck... (at least!)
RPM package (make -C pkg rpm), check yum install produces a working installation, also check the rpm -e command to verify uninstalling is OK too.
.exe main binary on Microsoft Windows then go back to GNU/Linux and build .exe installer (make -C pkg installer), go back to Microsoft Windows and test the installer (there are often problems at this stage because of missing libraries or other files...).
.dmg Mac OS X disk image, check it works even when /opt and /usr/local or (re)moved, this is important, else execution might rely on binaries which are only on the development machine and do not ship with game.
rsync --rsh=ssh --recursive ./version/ login@dl.sv.nongnu.org:/releases/liquidwar6/version/. Each file must have its .sig corresponding file.
gendocs.sh, carefull, liquidwar6.html is suppressed by this, need to re-create it from previous version and/or index.html which is the same.
index.html, liquidwar6.html and liquidwar6.fr.html so that they reflect the latest release. Check download links are OK.
./configure --enable-gcov ; make clean ; make. Then run src/liquidwar6 --test, stay here and get ready to respond interactively to various questions. Then cd to ./doc/coverage and run make opt. Copy files to web CVS, sync them.
./doc/global and run make opt. Copy files to web CVS, sync them.
./doc/cyclo and run make opt. Copy files to web CVS, sync them.
This describes how to add a new option to the game.
src/lib/def/def-list.txt
src/lib/def/def-update.py run ./def-update.py. This will automatically fill src/lib/def/def.h and script/def.scm. In the code, you should always use LW6DEF_<OPTION> in C and lw6def-<option> in scheme to refer to the option. This does help avoiding typesetting errors.
src/lib/hlp/hlp-list.c, choose a category for it
src/lib/hlp/hlp-reference.c, give it a type, documentation string and default values if needed
src/lib/def/def-list.txt a common practice is to fill it with the output of liquidwar6 --list once the program has been compiled and is aware of the new option.
Unless this is done, program won't accept the option.
This describes how to add a new libxyz internal library:
src/lib/xyz directory. The convention is to use 3 letters names and prefix every global identifier with lw6xyz.
Makefile.am, xyz.h, xyz-test.c and xyz-testmain.c from an existing internal library (libnod is a good source, it does not have complex dependencies).
Makefile.am to fill requirements, make necessary adjustments to other files (many string replaces to make, both lowercase and uppercase).
SUBDIRS and LW6_LIBS sections of src/lib/Makefile.am
AC_CONFIG_FILES of ./configure.ac.
automake and autoconf.
src/lib/lw6-options.c and add a call to lw6xyz_test() for both “check” and “test” cases.
src/lib/lw6-test.c and add a reference to the lw6xzy_test() function.
abc library that depends on xyz, edit the lw6abc_test function so that it contains a reference to lw6xzy_test.
abc library that depends on xyz/xyz.h, edit the abc/abc.h header so that it includes xzy/xyz.h. Also edit src/lib/liquidwar6.h.in.
abc library that depends on libxyz, add a reference to ../xyz/libxyz.la inf the _LDADD section.
doc/gdoc-update.sh and add the entry for xyz.
doc/Makefile.am and add xyz-gdoc.texi in gdoc_TEXINFOS.
./doc, run ./gdoc-update.sh.
doc/liquidwar6.texi to and a new node/section for this internal library.
doc/deps.dot to update dependencies.
./configure && make, fix code if needed.
This describes how to add a new mod-ab module, for instance a new bot, but gfx, snd, cli or srv backends should work pretty much the same:
src/lib/bot/Makefile.am
src/lib/bot/mod-ab, with its Makefile.am (inspired from other existing modules)
configure.ac so that src/lib/bot/mod-ab/Makefile is generated.
doc/gdoc-update.sh and add an entry for mod-ab
doc/Makefile.am and add mod-ab-gdoc.texi in gdoc_TEXINFOS.
./doc, run ./gdoc-update.sh.
doc/liquidwar6texi to add a new node/section for this module.
doc/deps.dot to update dependencies.
src/lib/bot/bot-test.c, change the value of TEST_NB_BACKENDS and modify the code so that the new ab module is tested too.
src/lib/bot/bot-register.c, the code must updated pretty much in every place with the conditionnal LW6_ALLINONE, you need to add the new module.
automake, autoconf, ./configure and make.
Since March, 4th 2010, Liquid War 6 uses GIT to handle source code, track changes, branches, and the rest. It replaces the GNU Arch repository. This old repository contains all sources up to version 0.0.7beta, following versions, including 0.0.8beta, must be retrieved from GIT.
So the following informations only concern those who are interested in previous versions of the game. Anybody else - probably you - should use GIT instead.
See Using GIT.
Still, this quick Arch survival guide is kept in the documentation.
Read the GNU Arch tutorial to learn how Arch works. Note that there are many other source control managers available, some of which provide functionnalities similar to GNU Arch / tla. GNU Arch has been chosen for Liquid War 6 because:
The repository for Liquid War 6 is accessible on http://arch.savannah.gnu.org/archives/liquidwar6. This is a read-only access, but with the distributed nature of GNU Arch, it still allows you to keep track of your own changes, and submit patches. Accessing it in read/write mode with sftp requires a Savannah account and special rights on the Liquid War 6 project.
Here are typicall commands one can use to get Liquid War 6 source from the GNU Arch repository:
tla register-archive http://arch.savannah.gnu.org/archives/liquidwar6
tla get -A liquidwar6@sv.gnu.org liquidwar6--beta
All the patches in the archive are signed with GnuPG, so you can check their authenticity with my public key.
You might need to edit your $HOME/.arch-params/signing/=default.check
file and put the following text in it:
tla-gpg-check gpg_command="gpg --verify-files -"
This section is for those who want to hack the game and set up their own repositories. This will enable you to keep track of your patches, package them, and help the core maintainer merging them in the main repository.
You can introduce yourself and create a repository by issuing commands like:
You can introduce yourself and create a repository by issuing commands like:
tla my-id me@home.net
tla register-archive me@home.net--2008 /home/me/tla-archives
Then, you can get create your own repository, with a command like:
tla tag -S liquidwar6@sv.gnu.org/liquidwar6--beta--0.1 me@home.net--2008/liquidwar6--beta--0.4
The idea is that you create, locally, a depot which has a name that matches the name on savannah (this is for convenience, you could technically give it any name...) and indicate that they represent, today, the same thing.
You can get a working copy of your depot with the command:
tla get me@home.net--2008/liquidwar6--beta--0.4
This will create a complete source tree, which you are free to modify, this is where you should hack.
To synchronize yourself with upstream developments, go into
your copy (the directory created by tla get) and type:
tla star-merge liquidwar6@sv.gnu.org/liquidwar6--beta--0.1
This will apply locally all the changes that happened since the
last synchronization. Of course this is one way to work, you
can decide to cherry pick patches and such stuff, but for most
dayly uses, a good'ol star-merge is fine.
Not that star-merge will only apply patches on your
working copy, not on your repository. The only way to actually
commit the modifications on the repository is to use the
commit command.
When using Arch, you can of course still send patches created
with diff, or even send updated files directly, the way
you would without revision control.
But it can be more convenient to either
/home/me/tla-archives
in our example).
tla mkpatch.
Here's an example of an mkpatch command, and which will
compute the differences between a previous
liquidwar6--beta--0.4--patch-2 snapshot and a not yet
commited latest version:
tla mkpatch {arch}/++pristine-trees/unlocked/liquidwar6/liquidwar6--beta/liquidwar6--beta--0.4/me@home.net--2006/liquidwar6--beta--0.4--patch-2 . my-patch
This will create a my-patch directory, which can be gzipped
and sent by mail.
Sometimes, when signing a patch, you might enter the wrong passphrase several times, or you might press CTRL+D inadvertantly. In that case, tla will be in a half-broken state, telling you it can't acquire revision lock... A quick workarround for this is to go to the depot, find the latest patch, and in this repository, create the following folders:
++revision-lock/+contents
Both are directories, note the two ++ and the single +. the +contents
directory can be empty. Once you've done this, try to re-commit.
There's no CVS or Subversion (AKA “SVN”) source depot for Liquid War 6. Instead, a GIT depot is used. GIT has many advantages over other source control managers (SCM), among them, it's distributed, like GNU Arch.
You can find interesting informations on GIT here:
Simply install git and run the following command:
git clone git://git.sv.gnu.org/liquidwar6.git
If you are behing a firewall and can't have direct TCP/IP access:
git clone http://git.sv.gnu.org/r/liquidwar6.git
Additionnally, source can be browsed online here: http://git.savannah.gnu.org/cgit/liquidwar6.git
You need an ssh access on Savannah and appropriate rights on the project, then you can type:
git clone login@git.sv.gnu.org:/srv/git/liquidwar6.git
If you have developper access to the project, then a simply git push
will commit your changes.
If not (that is, if you checked out anonymously using
git clone git://git.sv.gnu.org/liquidwar6.git for instance, you
can still submit patches. Follow these steps:
git format-patch -p origin this command will generate .patch files, one for each of you commits, which you can send by email. They can be easily integrated in the main source tree by using git apply <file.patch>.
Note that you can need to run git format-patch -p master (with master instead of origin) it not using a fresh checkout. Also consider adding the --stdout switch, eg git format-patch -p master --stdout > my-changes.patch if you're not using a fresh checkout.
This chapter is a technical reference. Most of its content
is self-generated by the program itself. That is to say, most
if its content is already available to you if you have the game
installed. Running liquidwar6 --list
and liquidwar6 --about=<keyword> is very likely to give
you the very same informations, the advantage being that you'll
be sure the information is up-to-date and corresponds to the exact
version of the program you have. However, publishing this in
a reader-friendly way is convenient, plus it enables web search
engines to harvest the content.
--about=<value>Type: string
Will allow you to get informations about a given keyword. Let's say that, for instance, you want informations about the keyword 'map-path'. Simply run 'liquidwar6 –about=map-path'. Note that this internal self-documentation system can describe command line switches as well as XML config file parameters or environment variables, and even some Guile script functions. The '–list' command line switch will give you the list of all available keywords.
--auditDisplay all path values, defaults and current settings. This output is very usefull to track down problems such as missing directories, broken installations. If you get an error message that suggests some file is missing, then give this option a try.
--debugEnables debug mode. This will turn on maximum log information, and display everything on stderr, even messages which are normally only stored in the log file.
--defaultsClears the config file and run the game with default settings. Use this if you suspect you have broken something by tweaking user settings, or when upgrading the game to a new version.
--hostDisplay all known system host properties, including os and cpu informations.
--listReturns the list of all keywords which can be queried for information. This includes command-line options, environment variables, and so on. This is the companion option of '–about'. Results obtained with '–list' can be passed to '–about'.
--modulesTells which modules have been enabled when the game was compiled. It's still possible to add or remove modules afterwards, but this option allows you to know how things were at first.
--pedigreeDisplay all build values, these are general constants which can help debugging, tracing what binary you are running, and so on. It's a good idea to take a look at the output of 'pedigree' if you have problems running the game.
--testRuns a (hopefully) complete test suite which will call most internal Liquid War 6 functions and check out wether they work, in a simple context, without any game interference. Usefull for troubleshooting.
--versionReturns the version of the program, as defined by the GNU Coding Standards.
--example-hints-xmlDumps on stdout an example hints.xml file. Such a file is normally shipped with the game. It is indeed generated using this command.
--example-rules-xmlDumps on stdout an example options.xml file. Such a file is normally shipped with the game. It is indeed generated using this command.
--example-style-xmlDumps on stdout an example style.xml file. Such a file is normally shipped with the game. It is indeed generated using this command.
--example-teams-xmlDumps on stdout an example teams.xml file. Such a file is normally shipped with the game. It is indeed generated using this command.
--list-advancedList advanced options which can be used for fine-tuning the game.
--list-docList documentation-related command line options. These commands allow you to list all the keywords related to a given domain.
--list-funcsList the C-functions which are exported to Guile, thus usable in scripts.
--list-inputList input (AKA controls) related options. Use these to change keyboard, joystick and mouse settingds.
--list-mapList map-related entries, excluding rules.xml, hints.xml and style.xml entries.
--list-map-hintsList 'hints.xml' entries. These parameters enable you to modify the behavior of the map loader.
--list-map-rulesList 'options.xml' entries. These parameters enable you to modify the gameplay.
--list-map-styleList 'style.xml' entries. These parameters enable you to modify the aspect of the game.
--list-map-teamsList 'teams.xml' entries. These parameters enable you to specify which teams should play on the map.
--list-pathList parameters which allow you to override the defaults of the game, and force the game your own file paths and directories.
--list-quickList quick help entries, this includes the GNU standard options and a few troubleshooting tools.
--list-showList command-line options which begin with '–show-...'. These will display on the console many internal parameters. Usefull when debugging.
--show-build-bin-idShows the internal 'bin-id' value. This value does not mean anything in itself but it's supposed to change each time you compile the game.
--show-build-cflagsShows what value you should put in 'CFLAGS' (environment variable) if you want to compile programs that use Liquid War 6 as a library, and include 'liquidwar6.h'.
--show-build-codenameShows the codename associated with this version, generally the name of someone famous who is war-related (a general, an emperor...).
--show-build-configure-argsShows the arguments that have been passed to the GNU Autoconf './configure' script when building the program. This can be very usefull if you want to know how the program has been built.
--show-build-datadirShows the 'datadir' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local/share'. This is the generic, non Liquid War 6 specific data directory. Liquid War 6 related data is stored elsewhere (usually in a sub-directory) see the 'data-dir' switch for more information. 'datadir' is not 'data-dir'. That's the point.
--show-build-docdirShows the 'docdir' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local/share/doc/liquidwar6'.
--show-build-enable-allinoneShows wether the 'allinone' option has been chosen when building the game. This depends on parameters passed to './configure'.
--show-build-enable-consoleShows wether the console has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of ncurses and readline.
--show-build-enable-fullstaticShows wether the 'fullstatic' option has been chosen when building the game. This depends on parameters passed to './configure'.
--show-build-enable-gcovShows wether the game was build with suitable informations for gcov. This depends on parameters passed to './configure'.
--show-build-enable-gprofShows wether the game was build with suitable informations for gprof. This depends on parameters passed to './configure'.
--show-build-enable-gtkShows wether GTK+ support has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of GTK+ headers and libs. It uses pkg-config to detect it.
--show-build-enable-instrumentShows wether the game was build with the '-finstrument-functions' GCC switch. This depends on parameters passed to './configure'.
--show-build-enable-mod-csoundShows wether the mod-csound audio backend has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of the csound library.
--show-build-enable-mod-glShows wether the mod-gl graphical backend has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of SDL and related libraries.
--show-build-enable-mod-httpShows wether the mod-http network backend has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of libCurl.
--show-build-enable-mod-oggShows wether the mod-ogg audio backend has been enabled when building the game. This depends on parameters passed to './configure' and also on the presence of SDL and related libraries.
--show-build-enable-openmpShows wether the program was built with OpenMP support. This depends on parameters passed to './configure'.
--show-build-enable-optimizeShows wether the 'optimize' option has been chosen when building the game. This depends on parameters passed to './configure'.
--show-build-enable-paranoidShows wether the game was build with paranoid memory management. This is for debugging purposes, the default already includes some controls, with turned it's really... paranoid.
--show-build-enable-profilerShows wether the game was build with Google Profiler support. This depends on parameters passed to './configure'.
--show-build-enable-valgrindShows wether the game was build with valgrind later use in mind. This depends on parameters passed to './configure'.
--show-build-endiannessReturns the endianness. 'little' corresponds to x86-like systems, 'big' to ppc-like systems.
--show-build-gcc-versionReturns the version of the GNU C compiler which was used to compile the program.
--show-build-gnuReturns 1 (true) if host OS is a GNU system, or at least has been considered as such when compiling, 0 (false) if not.
--show-build-host-cpuShows the host CPU, as defined by 'host_cpu' in GNU Autoconf.
--show-build-host-osShows the host OS, as defined by 'host_os' in GNU Autoconf.
--show-build-hostnameShows the name of the host where the binary was compiled.
--show-build-includedirShows the 'includedir' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local/include'.
--show-build-ldflagsShows what value you should put in 'LDFLAGS' (environment variable) if you want to link programs against libliquidwar6.
--show-build-libdirShows the 'libdir' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local/lib'. This is the generic, non Liquid War 6 specific library directory. Dedicated Liquid War 6 modules are stored elsewhere (usually in a sub-directory) see the 'mod-dir' switch for more information.
--show-build-localedirShows the 'localedir' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local/share/locale'.
--show-build-mac-os-xReturns 1 (true) if host OS is Mac OS X, 0 (false) if not.
--show-build-md5sumShows the MD5 checksum, which has been calculated from the C source files. Complementary with 'show-build-stamp'.
--show-build-ms-windowsReturns 1 (true) if host OS is Microsoft Windows, 0 (false) if not.
--show-build-package-stringShows the package string, that is, 'Liquid War 6 <version>
--show-build-pointer-sizeReturns the pointer size, in bytes. Should be 4 on 32-bit systems and 8 on 64-bit systems.
--show-build-prefixShows the 'prefix' value as passed to the GNU Autoconf './configure' script when compiling the program. Default is '/usr/local'.
--show-build-stampShows the build stamp. A very usefull value, more precise than the version to track down binaries. It is incremented each time the core C code is updated. It won't reflect all the programs for it does not take scripts in account, but if you are running a work-in-progress version, it might be very convenient to use this to know what your are running exactly.
--show-build-top-srcdirShows the top source directory on the machine where the binary was compiled.
--show-build-unixReturns 1 (true) if host OS is a UNIX system, or at least has been considered as such when compiling, 0 (false) if not.
--show-build-versionShows the version. Note that this is different from the standard GNU 'version' command line option which shows a complete message with a short copyright notice. This one will just return the version, without the package tarname or anything else.
--show-config-fileShows the config file path. Default is '$HOME/.liquidwar6/config.xml'.
--show-cwdShows the current working directory, the value that the pwd command would return.
--show-data-dirShows the data directory path. This is where the games searches for most of its data,the most important exception being maps, which are stored elsewhere. Default is '/usr/local/share/liquidwar6-<version>/data'.
--show-default-config-fileShows the default config file path. Default is '$HOME/.liquidwar6/config.xml'.
--show-default-data-dirShows the default data directory path. This is where the games searches for most of its data,the most important exception being maps, which are stored elsewhere. Default is '/usr/local/share/liquidwar6-<version>/data'.
--show-default-log-fileShows the default log file path. Default is '$HOME/.liquidwar6/log.csv'.
--show-default-map-dirShows the default map directory. This is where builtin maps are stored. Default is '/usr/local/share/liquidwar6-<version>/map'.
--show-default-map-pathShows the default map search path. This is where the game searches for maps. It's the combination of command-line arguments and builtin paths. Might return more directories than the one specified in a single 'map-path=dir1:dir2' argument.
--show-default-mod-dirShows the default module directory path. This is where all dynamically loaded modules are stored. Default is '/usr/local/lib/liquidwar6-<version>'.
--show-default-music-dirShows the default music directory. This is where builtin musics are stored. Default is '/usr/local/share/liquidwar6-<version>/music'.
--show-default-music-pathShows the default music search path. This is where the game searches for musics. It's the combination of command-line arguments and builtin paths. Might return more directories than the one specified in a single 'music-path=dir1:dir2' argument.
--show-default-prefixShows the default prefix used. This should logically be the value passed to the GNU Autoconf ./configure script when building the game. Most other path are deduced from this one. Default is '/usr/local'.
--show-default-script-fileShows the default main script file path. This file is very important, since the program is more or less a hudge scheme interpreter, and this file is the file loaded by Guile. In short, it is the main program. Default is '/usr/local/share/liquidwar6-<version>/script/liquidwar6.scm'.
--show-default-user-dirShows the default user directory path. This is where run-time data, config files, log files, are stored. Default is '$HOME/.liquidwar6/'.
--show-log-fileShows the log file path. Default is '$HOME/.liquidwar6/log.csv'.
--show-map-dirShows the map directory. This is where builtin maps are stored. Default is '/usr/local/share/liquidwar6-<version>/map'.
--show-map-pathShows the map search path. This is where the game searches for maps. It's the combination of command-line arguments and builtin paths. Might return more directories than the one specified in a single 'map-path=dir1:dir2' argument.
--show-mod-dirShows the module directory path. This is where all dynamically loaded modules are stored. Default is '/usr/local/lib/liquidwar6-<version>'.
--show-music-dirShows the music directory. This is where builtin maps are stored. Default is '/usr/local/share/liquidwar6-<version>/music'.
--show-music-pathShows the music search path. This is where the game searches for musics. It's the combination of command-line arguments and builtin paths. Might return more directories than the one specified in a single 'music-path=dir1:dir2' argument.
--show-prefixShows the prefix used. This should logically be the value passed to the GNU Autoconf ./configure script when building the game. Most other path are deduced from this one. Default is '/usr/local'.
--show-run-dirShows the run directory, usually the path where the binary is. It depends on how and where the program is launched. It is guessed from the argc/argv values at runtime.
--show-script-fileShows the main script file path. This file is very important, since the program is more or less a hudge scheme interpreter, and this file is the file loaded by Guile. In short, it is the main program. Default is '/usr/local/share/liquidwar6-<version>/script/liquidwar6.scm'.
--show-user-dirShows the user directory path. This is where run-time data, config files, log files, are stored. Default is '$HOME/.liquidwar6/'.
--config-fileType: string
Default value: $HOME/.liquidwar6/config.xml
Set the config file path. This enables you to use whatever config file you like, keeping all other informations in the same place.
--data-dirType: string
Default value: /usr/local/share/liquidwar6-<version>/data
Set the data directory. By changing ths value you'll be able to use an alternative data directory.
--log-file=<value>LW6_LOG_FILElog-fileType: string
Default value: $HOME/.liquidwar6/log.csv
Set the log file path. This enables you to use whatever log file you like, keeping all other informations in the same place.
--map-dirType: string
Default value: /usr/local/share/liquidwar6-<version>/map
Set the map directory path. By changing this value you'll be able to play with your own maps in your own directory. Note that there are other ways to achieve that, but using this option will work. However, a side effect is that you might not see builtin maps anymore.
--map-path=<value>LW6_MAP_PATHmap-pathType: string
Default value: $HOME/.liquidwar6/map:/usr/local/share/liquidwar6-<version>/map
Set the map search path. By changing this value you'll be able to play with your own maps in your own directory. This is different from 'map-dir', since it includes 'map-dir', plus it adds a number of other search paths. Unlike most other parameters, the values given from the command-line, from the environment variables, or from the config file, are not overwritten, but appended. That is to say if you specify a 'map-path' with the command-line argument 'map-path=path', but also define the 'LW6_MAP_PATH' value and finally edit 'config.xml' to change the 'map-path' entry in it, you'll end up with the game searching for maps in all these directories. Additionnally, 'map-dir' and '<user-dir>/map' will always be in the list. Any given value can itself include several pathes, separated by the path separator. This separator is ':' on GNU/Linux, and ';' on Microsoft Windows. For instance, on a GNU/Linux box, you could use the command-line argument 'map-path=/foo/bar/map:/home/user/map/:/map'.
--mod-dirType: string
Default value: /usr/local/lib/liquidwar6-<version>
Set the module directory path. By changing this you will load dynamic shared libraries (game specific modules such as the graphical backend) from an alternative place. Use this at your own risks, for there can always be a binary incompatibility. You've been warned.
--music-dir=<value>LW6_MUSIC_DIRmusic-dirType: string
Default value: /usr/local/share/liquidwar6-<version>/music
Set the music directory path. By changing this value you'll be able to use your own musics in your own directory. Note that there are other ways to achieve that, but using this option will work. The major side effect is that using this option, you really replace the existing builtin musics by your own. If you simply want to add musics you can store them in $HOME/.liquidwar6/music or in the map directory itself.
--music-path=<value>LW6_MUSIC_PATHmusic-pathType: string
Default value: $HOME/.liquidwar6/music:/usr/local/share/liquidwar6-<version>/music
Set the music search path. By changing this value you'll be able to play with your own musics in your own directory. This is different from 'music-dir', since it includes 'music-dir', plus it adds a number of other search paths. Unlike most other parameters, the values given from the command-line, from the environment variables, or from the config file, are not overwritten, but appended. That is to say if you specify a 'music-path' with the command-line argument 'music-path=path', but also define the 'LW6_MUSIC_PATH' value and finally edit 'config.xml' to change the 'music-path' entry in it, you'll end up with the game searching for musics in all these directories. Additionnally, 'music-dir' and '<user-dir>/music' will always be in the list. Any given value can itself include several pathes, separated by the path separator. This separator is ':' on GNU/Linux, and ';' on Microsoft Windows. For instance, on a GNU/Linux box, you could use the command-line argument 'music-path=/foo/bar/music:/home/user/music/:/music'.
--prefixType: string
Default value: /usr/local
Override the prefix value given to the GNU Autoconf ./configure script when building the game. Not all path will be changed, some of them might remain the same, for instance message translations (localedir). But most game-specific data including maps, graphics, sounds, will be searched according to the new given parameter.
--script-fileType: string
Default value: /usr/local/share/liquidwar6-<version>/script/liquidwar6.scm
Set the main script file path. This file is very important, since the program is more or less a hudge scheme interpreter, and this file is the file loaded by Guile. In short, it is the main program.
--user-dir=<value>LW6_USER_DIRuser-dirType: string
Default value: $HOME/.liquidwar6
Set the user directory path. This is where run-time data, config files, log files, are stored. If you override this value, other parameters such as where the config and log files reside, will change.
--player1-control=<value>LW6_PLAYER1_CONTROLplayer1-controlType: string
Default value: mouse
Control for the first player, must be mouse, keyboard, joystick1, joystick2 or custom.
--player1-name=<value>LW6_PLAYER1_NAMEplayer1-nameType: string
Default value: <username>
Name of the first player, the player used by default. A default value is provided, you can of course, change it at will.
--player1-status=<value>LW6_PLAYER1_STATUSplayer1-statusType: boolean
Default value: true
Status of the first player, true if player is activated, false if idle.
--player2-control=<value>LW6_PLAYER2_CONTROLplayer2-controlType: string
Default value: keyboard
Control for the second player, must be mouse, keyboard, joystick1, joystick2 or custom.
--player2-name=<value>LW6_PLAYER2_NAMEplayer2-nameType: string
Default value: player2-<hostname>
Name of the second player. A default value is provided, you'll certainly want to change it.
--player2-status=<value>LW6_PLAYER2_STATUSplayer2-statusType: boolean
Default value: true
Status of the second player, true if player is activated, false if idle.
--player3-control=<value>LW6_PLAYER3_CONTROLplayer3-controlType: string
Default value: joystick1
Control for the third player, must be mouse, keyboard, joystick1, joystick2 or custom.
--player3-name=<value>LW6_PLAYER3_NAMEplayer3-nameType: string
Default value: player3-<hostname>
Name of the third player. A default value is provided, you'll certainly want to change it.
--player3-status=<value>LW6_PLAYER3_STATUSplayer3-statusType: boolean
Default value: false
Status of the third player, true if player is activated, false if idle.
--player4-control=<value>LW6_PLAYER4_CONTROLplayer4-controlType: string
Default value: joystick2
Control for the fourth player, must be mouse, keyboard, joystick1, joystick2 or custom.
--player4-name=<value>LW6_PLAYER4_NAMEplayer4-nameType: string
Default value: player4-<hostname>
Name of the fourth player. A default value is provided, you'll certainly want to change it.
--player4-status=<value>LW6_PLAYER4_STATUSplayer4-statusType: boolean
Default value: false
Status of the fourth player, true if player is activated, false if idle.
--click-to-focus=<value>LW6_CLICK_TO_FOCUSclick-to-focusType: boolean
Default value: false
If set to true, you'll need to click with the mouse to select a menuitem or move the cursor in the game. If not, some actions will be taken automatically without the need to click.
--cursor-sensitivity=<value>LW6_CURSOR_SENSITIVITYcursor-sensitivityType: float
Default value: 1.0
Keyboard and joystick sensitivity while moving the cursor. 1.0 is the default, 0.1 is slow, 10 is reponsive. This is used for moving the cursor during the game only, the option has no impact on menu navigation.
--custom-alt=<value>LW6_CUSTOM_ALTcustom-altType: string
Default value: (c-lw6gui-keyboard-is-pressed 110) ; SDLK_n
Guile custom code associated to the ALT key equivalent.
--custom-ctrl=<value>LW6_CUSTOM_CTRLcustom-ctrlType: string
Default value: (c-lw6gui-keyboard-is-pressed 98) ; SDLK_b
Guile custom code associated to the CTRL key equivalent.
--custom-down=<value>LW6_CUSTOM_DOWNcustom-downType: string
Default value: (c-lw6gui-keyboard-is-pressed 100) ; SDLK_d
Guile custom code associated to the DOWN key equivalent.
--custom-enter=<value>LW6_CUSTOM_ENTERcustom-enterType: string
Default value: (c-lw6gui-keyboard-is-pressed 103) ; SDLK_g
Guile custom code associated to the ENTER key equivalent.
--custom-esc=<value>LW6_CUSTOM_ESCcustom-escType: string
Default value: (c-lw6gui-keyboard-is-pressed 102) ; SDLK_f
Guile custom code associated to the ESC key equivalent.
--custom-left=<value>LW6_CUSTOM_LEFTcustom-leftType: string
Default value: (c-lw6gui-keyboard-is-pressed 99) ; SDLK_c
Guile custom code associated to the LEFT key equivalent.
--custom-pgdown=<value>LW6_CUSTOM_PGDOWNcustom-pgdownType: string
Default value: (c-lw6gui-keyboard-is-pressed 115) ; SDLK_s
Guile custom code associated to the PGDOWN key equivalent.
--custom-pgup=<value>LW6_CUSTOM_PGUPcustom-pgupType: string
Default value: (c-lw6gui-keyboard-is-pressed 119) ; SDLK_w
Guile custom code associated to the PGUP key equivalent.
--custom-right=<value>LW6_CUSTOM_RIGHTcustom-rightType: string
Default value: (c-lw6gui-keyboard-is-pressed 118) ; SDLK_v
Guile custom code associated to the RIGHT key equivalent.
--custom-up=<value>LW6_CUSTOM_UPcustom-upType: string
Default value: (c-lw6gui-keyboard-is-pressed 101) ; SDLK_e
Custom keycode to be used as the UP key equivalent.
--double-click-delay=<value>LW6_DOUBLE_CLICK_DELAYdouble-click-delayType: integer
Default value: 333
Time, in milliseconds, determining wether two consecutive clicks make a double-click or not.
--max-cursor-speed=<value>LW6_MAX_CURSOR_SPEEDmax-cursor-speedType: float
Default value: 10.0
Maximum cursor speed when cursor is controlled with keyboard or joystick joystick 1. Consider using cursor-sensitivity too.
--mouse-sensitivity=<value>LW6_MOUSE_SENSITIVITYmouse-sensitivityType: float
Default value: 1.0
Mouse sensitivity, 1.0 is the default, 0.1 is slow, 10 is reponsive. This is used for moving the cursor during the game only, the option has no impact on menu navigation.
--repeat-delay=<value>LW6_REPEAT_DELAYrepeat-delayType: integer
Default value: 500
Time, in milliseconds, before key repeat will start, use 0 to disable.
--repeat-interval=<value>LW6_REPEAT_INTERVALrepeat-intervalType: integer
Default value: 100
Time, in milliseconds, between two repeats, once repeat has started, use 0 to disable.
--use-double-click=<value>LW6_USE_DOUBLE_CLICKuse-double-clickType: boolean
Default value: false
Wether to use double-click feature, mostly usefull if running on a system that has only one button (such as a tablet-PC or anything with a tactile screen), if your mouse has three buttons, disabling this might avoid some confusion. Basically, if enabled, double-click is equivalent to right-click (fire) and triple-click is equivalent to middle-click (alternate fire).
--use-esc-button=<value>LW6_USE_ESC_BUTTONuse-esc-buttonType: boolean
Default value: true
Decides wether to display an 'esc' (escape) button in the interface. This is usefull for people who control the game with the mouse only, and have a single buttons, or on a touchscreen.
--zoom-step=<value>LW6_ZOOM_STEPzoom-stepType: float
Default value: 1.1
A value, strictly greater than 1, which will be used when zooming. The greater it is, the more sensible the zoom is.
--zoom-stick-delay=<value>LW6_ZOOM_STICK_DELAYzoom-stick-delayType: float
Default value: 1000
How long, in msec, the zoom will stick to its default value.
--capture=<value>LW6_CAPTUREcaptureType: boolean
Default value: false
Enables capture mode, in which a BMP file is dumped on the disk (in your user directory, search for a 'capture' sub-directory).
--fullscreen=<value>LW6_FULLSCREENfullscreenType: boolean
Default value: false
Force the game to fun fullscreen. Note that the graphics backend might ignore this hint.
--gfx-backend=<value>LW6_GFX_BACKENDgfx-backendType: string
Default value: gl
Sets the graphics backend AKA 'gfx' to use. For now the only choice is 'gl' and will use an OpenGL/SDL 3D-accelerated driver.
--gfx-quality=<value>LW6_GFX_QUALITYgfx-qualityType: integer
Default value: 1 Min value: 0 Max value: 2
Sets the overall quality of the graphics backend. Depending on the backend, this can mean different things. For instance for the 'gl' backend, this can change texture filtering (nearest, linear, bilinear...). This is not the same as 'pixelize' which is a per-map option and emulates an old school appearance.
--height=<value>LW6_HEIGHTheightType: integer
Default value: -1
Run the game with the given screen height.Note that the graphics backend might ignore this hint. Use with its companion option 'width'. A negative value will force the use of a default value.
--width=<value>LW6_WIDTHwidthType: integer
Default value: -1
Run the game with the given screen width. Note that the graphics backend might ignore this hint. Use with its companion option 'height'.A negative value will force the use of a default value.
--windowed-mode-limit=<value>LW6_WINDOWED_MODE_LIMITwindowed-mode-limitType: float
Default value: 0.95
When switching back from fullscreen mode to windowed mode, if we're in maximum resolution, then this coefficient will be applied before resizing the window. The idea is that (obviously) a windowed mode is prefered when a little smaller that totally fullscreen. So set this to a value just below 1.0.
--ambiance-exclude=<value>LW6_AMBIANCE_EXCLUDEambiance-excludeType: string
Default value:
If this string is present in a music file name, this file won't be played during the menus, it will be excluded from the list.
--ambiance-file=<value>LW6_AMBIANCE_FILEambiance-fileType: string
Default value:
A music file which will be used to be played during the menus. If not found, game will fallback on random files.
--ambiance-filter=<value>LW6_AMBIANCE_FILTERambiance-filterType: string
Default value: Chadburn
A music filter, used to select the files which are played while navigating in the menus. It works like 'music-filter' except this one is not related to a peculiar map. This is not a complex regex-enabled filter, just a plain string search. Even the '*' wildcard won't work.
--fx-volume=<value>LW6_FX_VOLUMEfx-volumeType: float
Default value: 0.3 Min value: 0 Max value: 1
Set the sound effects volume. This is a floating point value. 0 is mute. Maximum value is 1.
--music-volume=<value>LW6_MUSIC_VOLUMEmusic-volumeType: float
Default value: 0.6 Min value: 0 Max value: 1
Set the music volume.This is a floating point value. 0 is mute. Maximum value is 1.
--snd-backend=<value>LW6_SND_BACKENDsnd-backendType: string
Default value: ogg
Sets the sound backend AKA 'snd' to use. Can be 'ogg' or 'csound' but only 'ogg' will produce sound in the current release.
--water-volume=<value>LW6_WATER_VOLUMEwater-volumeType: float
Default value: 0.2 Min value: 0 Max value: 1
Set the volume for water sounds. This is a floating point value. 0 is mute. Maximum value is 1.
--bind-ip=<value>LW6_BIND_IPbind-ipType: string
Default value: 0.0.0.0
The IP address to bind on when listening to network messages. You can use this to specifically use a given network interface, the default will listen on any available interface.
--bind-port=<value>LW6_BIND_PORTbind-portType: integer
Default value: 8056 Min value: 1 Max value: 65535
The IP port to bind on when listening to network messages. The default should work out of the box, and will ease up the discovery process. That is, if you use your own settings, automatic detection of your server by other servers might not work so well.
--broadcast=<value>LW6_BROADCASTbroadcastType: boolean
Default value: true
Allows the program to send broadcast messages on the network. It can be usefull to disable those if you don't use UDP node discovery and/or if there's a sysadmin arround who does not enjoy permanent broadcasts on his LAN.
--cli-backends=<value>LW6_CLI_BACKENDScli-backendsType: string
Default value: tcp,udp,http
The client backends to use. Most of the time the default is fine, change it only if you specifically want to disactivate some protocol, or if you want to activate a custom-made client backend. It's a comma separated list.
--known-nodes=<value>LW6_KNOWN_NODESknown-nodesType: string
Default value: http://ufoot.org:8056/,http://ufoot.hd.free.fr:8056/
List of known nodes, nodes which the program will try to contact first to get the list of other nodes. This is mostly usefull when program is launched for the first time, after this it should keep an up-to-date list of known servers in its internal database and automatically reconnect to them next time it starts. You might want to change this if you really want to connect to a given server which is not publically listed. The list is comma separated.
--node-description=<value>LW6_NODE_DESCRIPTIONnode-descriptionType: string
Default value: No description.
The description of your node, that is a text that describes your server. This will typically appear when pointing a web client on the public server URL, it is for general information, so if there's something special about your server, say it here.
--node-title=<value>LW6_NODE_TITLEnode-titleType: string
Default value:
The title of your node, that is the name which will be displayed when listing servers. This is different from player name, for there can be several players on a single computer. By default this will be set to hostname.
--password=<value>LW6_PASSWORDpasswordType: string
Default value:
The password to use for network games. Do not use a valuable password, as this is stored as clear text on your hard drive. Still, the game will only send a hash/checksum of the password on the network so eavesdropper won't be able to read it. They can see the hash/checksum and use it if clever, but they can't guess the real password. A blank password means anyone can join your games when you act like a server.
--public-url=<value>LW6_PUBLIC_URLpublic-urlType: string
Default value:
The public URL of your server. By default the game will pick up one for you. In fact, the clients discovering your server should guess the public URL, probably http://<your-ip>:<your-port>/ but you might need to use your own settings if you are using NAT or an Apache reverse-proxy to rewrite HTTP requests.
--skip-network=<value>LW6_SKIP_NETWORKskip-networkType: boolean
Default value: false
If set, then game won't do anything network related. No listen, no connect, no nothing. You are playing locally.
--srv-backends=<value>LW6_SRV_BACKENDSsrv-backendsType: string
Default value: tcpd,udpd,httpd
The server backends to use. Most of the time the default is fine, change it only if you specifically want to disactivate some protocol, or if you want to activate a custom-made server backend. It's a comma separated list.
--chosen-map=<value>LW6_CHOSEN_MAPchosen-mapType: string
Default value: subflower
The last map chosen by the player, locally. This is the map which will be used for a quick-start game, a local game, or a game started as a server.
--force=<value>LW6_FORCEforceType: string
Default value: respawn-team,color-conflict-mode
A comma separated list of options which should be ignored when reading map XML files. For instance, if this contains 'rounds-per-sec,moves-per-round' then whatever values were defined for this in 'rules.xml', then game will ignore them and use the user's values, stored in 'config.xml', running the game at the requested speed. This ultimately allows the player to control everything despite the values set by the map designer.
--use-cursor-texture=<value>LW6_USE_CURSOR_TEXTUREuse-cursor-textureType: boolean
Default value: true
Defines wether the cursor textures should be used. If unset, then the default builtin cursor texture will be used instead of the map specific one.
--use-hints-xml=<value>LW6_USE_HINTS_XMLuse-hints-xmlType: boolean
Default value: true
If set, then hints will be picked up from the map defined hints.xml, if it exists. This is the default.
--use-music-file=<value>LW6_USE_MUSIC_FILEuse-music-fileType: boolean
Default value: true
If set, then the program will use the 'music-file' attribute to choose the music to play. If unset, then a random builtin music will be picked up, regardless of what is specified in 'music-file'.
--use-rules-xml=<value>LW6_USE_RULES_XMLuse-rules-xmlType: boolean
Default value: true
If set, then rules will be picked up from the map defined rules.xml, if it exists. This is the default. Use force-time and force-size to override this and use user-defined values anyway.
--use-style-xml=<value>LW6_USE_STYLE_XMLuse-style-xmlType: boolean
Default value: true
If set, then style will be picked up from the map defined style.xml, if it exists. This is the default. Use force-time and force-background to override this and use user-defined values anyway.
--use-teams-xml=<value>LW6_USE_TEAMS_XMLuse-teams-xmlType: boolean
Default value: true
If set, then teams will be picked up from the map defined teams.xml, if it exists. This is the default. Use force-time and force-background to override this and use user-defined values anyway.
--use-texture=<value>LW6_USE_TEXTUREuse-textureType: boolean
Default value: true
Defines wether the map texture should be used. Of course if there's no map texture, the texture... won't be used. But if there is one, this parameter will force the game to ignore it and play with solid colors. This probably won't look as nice as the textured map in most cases, but some players might find it more readable and confortable to play when throwing eye candy away.
--boost-power=<value>LW6_BOOST_POWERboost-powerType: integer
Default value: 3 Min value: 1 Max value: 10
Defines how fast and powerfull the boost is. That is, if on 'boost.png' it's pitch black and this parameter is set to 3, then fighters will move and act 3 times than what they would do normally.
--color-conflict-mode=<value>LW6_COLOR_CONFLICT_MODEcolor-conflict-modeType: integer
Default value: 1 Min value: 0 Max value: 2
How to handle color conflicts, that is, when a player requests a color, but this color is already used, what should be done? If 0, wether a color already exists won't affect the color of a new cursor. If 1, then two players on the same computer will be allowed to share the same color/team, but if another computer is already playing with a color, any new computer will need to use another team. If 2, then it's impossible for a new cursor to use a pre-existing color, any new cursor will require a new color, if that color is already used, a new color will be picked randomly.
--cursor-pot-init=<value>LW6_CURSOR_POT_INITcursor-pot-initType: integer
Default value: 100000 Min value: 5000 Max value: 500000
Defines the cursor potential at startup. Not really any reason to change it. Theorically, there could be maps where the default value doesn't fit, but none has been seen yet.
--danger-power=<value>LW6_DANGER_POWERdanger-powerType: integer
Default value: 200 Min value: 0 Max value: 10000
Defines how dangerous are the black zones defined in 'danger.png'. The value is used to decrease the fighter health at each move, so you should compare its value to something like 'fighter-attack'. Being on a dangerous zone is a bit like being attacked by an invisible and unknown ennemy.
--exp=<value>LW6_EXPexpType: integer
Default value: 1 Min value: 0 Max value: 99
Level of experience (AKA exp) required to play the current level. If this level is validated (that is, won) then player will be granted with a level of exp+1 and be able to play all the next levels. An exp of 0 means the level is playable by a pure beginner.
--fighter-attack=<value>LW6_FIGHTER_ATTACKfighter-attackType: integer
Default value: 500 Min value: 1 Max value: 10000
Defines how hard fighters will attack others, that is, in one attack, how many life-points the attacked fighter will loose. Increasing this will cause your opponents to melt faster when you attack them. With a low value, it will take ages to take on your opponents. Different styles of game. Can radically change the gameplay.
--fighter-defense=<value>LW6_FIGHTER_DEFENSEfighter-defenseType: integer
Default value: 50 Min value: 0 Max value: 10000
Defines how fast fighters will regenerate after an attack. When this parameter is set low, an attacked fighter, which is very dark and almost dead will take a very long time to regain energy. If the parameter is set high, it can almost instantaneously regain energy.
--fighter-new-health=<value>LW6_FIGHTER_NEW_HEALTHfighter-new-healthType: integer
Default value: 5000 Min value: 1 Max value: 10000
Defines how healthy fighters will be when they appear on the map. This can be either at the beginning of the game of when a fighter changes team. Setting this low will allow battefields to switch from one side to another very fast, for freshly gained fighters will be feeble and very likely to return to their original camp. To calibrate this parameter, keep in mind that the absolute maximum health a fighter can have is always 10000 (ten-thousands).
--fighter-regenerate=<value>LW6_FIGHTER_REGENERATEfighter-regenerateType: integer
Default value: 5 Min value: 0 Max value: 10000
Defines at which speed fighters will self-regenerate, without even begin packed together. This will allow lone fighters to regenerate a bit by hiding somewhere in the map. This is typically a low value, might even be 0.
--frags-fade-out=<value>LW6_FRAGS_FADE_OUTfrags-fade-outType: integer
Default value: 100 Min value: 10 Max value: 100
When a player looses (in deathmatch mode) all player points will be multiplicated by this percentage, for instance if it's 90 and player had 50 points, then player will only have 45 points, then points corresponding to the new death will be added/substrated to its total. This is to avoid players with thousands of points in advance, and keep everyone in the race. A low value will minimize the importance of game start. This is only used in modes where frags are distributed in a proportional way.
--frags-mode=<value>LW6_FRAGS_MODEfrags-modeType: integer
Default value: 2 Min value: 0 Max value: 3
Defines how points are calculated in deathmatch mode, 0 is old school simple mode. 1 is in a mode in which 1 point is attributed to every winner, and looser looses all the corresponding points (total is always 0). 2 isproportional mode, with a total of 0 kept constant, that is, loosers loose as many points as attributed to winners. 3 is a mode in which at each death, winners are attributed a number of points proportional to their fighters, and loosers scores remain untouched.
--frags-to-distribute=<value>LW6_FRAGS_TO_DISTRIBUTEfrags-to-distributeType: integer
Default value: 100 Min value: 10 Max value: 1000
Defines how many points will be distributed when in deathmatch mode. When a player looses, this amont of points will be substracted to its total, and the same amount of points will be distributed to other live players, proportionnally to how many fighters they have on the battlefield.
--glue-power=<value>LW6_GLUE_POWERglue-powerType: integer
Default value: 20 Min value: 1 Max value: 100
Defines how sticky and powerfull the glue is. That is, if on 'glue.png' it's pitch black and this parameter is set to 3, then fighters will take 3 steps to do what would normally take only one step.
--highest-team-color-allowed=<value>LW6_HIGHEST_TEAM_COLOR_ALLOWEDhighest-team-color-allowedType: integer
Default value: 9 Min value: 3 Max value: 9
Id of the greatest/highest color one can use. Normally, you can leave this untouched, the program will automatically fit this according to your exp. Setting an artificially low value will just cause normally available colors to disappear, setting it to a high value does nothing, if you still don't have access to some colors, you still don't, period.
--highest-weapon-allowed=<value>LW6_HIGHEST_WEAPON_ALLOWEDhighest-weapon-allowedType: integer
Default value: 19 Min value: 7 Max value: 19
Id of the greatest/highest weapon one can use. Normally, you can leave this untouched, the program will automatically fit this according to your exp. Setting an artificially low value will just cause normally available weapons to disappear, setting it to a high value does nothing, if you still don't have access to some weapons, you still don't, period.
--max-cursor-pot=<value>LW6_MAX_CURSOR_POTmax-cursor-potType: integer
Default value: 1000000 Min value: 50000 Max value: 5000000
Defines the maximum cursor potential. Not really any reason to change it. Any high value should produce the same results. Low values might reveal algorithm bugs and inconsistencies.
--max-cursor-pot-offset=<value>LW6_MAX_CURSOR_POT_OFFSETmax-cursor-pot-offsetType: integer
Default value: 100 Min value: 1 Max value: 10000
Defines the maximum cursor potential offset. The idea is that in some cases, the potential of a cursor can increase in burst mode, for instance to make this cursor more important than others, so that fighters rally to it, neglecting other cursors (talking about a multi-cursor controlled team). This parameter is here to limit this burst effect and avoid bugs.
--max-nb-cursors=<value>LW6_MAX_NB_CURSORSmax-nb-cursorsType: integer
Default value: 26 Min value: 2 Max value: 26
Defines the maximum number of cursors who can enter the game. Really makes sense in network games. Default value is 26, the maximum.
--max-nb-nodes=<value>LW6_MAX_NB_NODESmax-nb-nodesType: integer
Default value: 12 Min value: 2 Max value: 26
Defines the maximum number of servers who can enter the game. Really makes sense in network games. Default value is 10, and should fit in most cases. Can be raised up to 26.
--max-nb-teams=<value>LW6_MAX_NB_TEAMSmax-nb-teamsType: integer
Default value: 10 Min value: 2 Max value: 10
Defines the maximum number of teams who can enter the game. Really makes sense in network games. Default value is 10, the maximum.
--max-round-delta=<value>LW6_MAX_ROUND_DELTAmax-round-deltaType: integer
Default value: 1000 Min value: 1 Max value: 10000
This is the companion value of 'round-delta'. Will put an absolute limit to the delta, which (what did you think?) is of course incremented in some cases by the core algorithm. If in doubt, don't touch.
--max-zone-size=<value>LW6_MAX_ZONE_SIZEmax-zone-sizeType: integer
Default value: 8 Min value: 1 Max value: 64
Defines the maximum zone size, which is an internal and rather technical parameter. The idea is that to optimize things, Liquid War 6 divides the battlefield in squares, where it can, and tries to make these squares as big as possible, the idea being that everywhere in this square, fighters follow the same intructions. Just a technical optimization. The problem is that setting it too high will reveal the optimization and its tradeoffs to the player, who will see the fighter behave strangely, following invisible paths. Plus, it's ugly. Depending on your tastes (speed, look'n'feel) you'll prefer something nice or something fast. Note that anyways passed a certain value, this does not optimize anything anymore. In doubt, don't touch it.
--medicine-power=<value>LW6_MEDICINE_POWERmedicine-powerType: integer
Default value: 100 Min value: 0 Max value: 10000
Defines how fast fighter will automatically regenerate on black zones defined in 'medicine.png'. The value is used to decrease the fighter health at each move, so you should compare its value to something like 'fighter-defense'. Being on a medicined zone is a bit like being defended by an invisible and unknown friend.
--moves-per-round=<value>LW6_MOVES_PER_ROUNDmoves-per-roundType: integer
Default value: 2 Min value: 1 Max value: 50
Defines how many times fighters move per round. Increasing this will just make fighters move faster, but won't change anything for the rest, that is keyboard and mouse responsivity, and network traffic will stay the same. Multiplying the number of moves per round by the number of rounds per second will give the number of moves per second, which is, in fact, how fast fighters move on the screen.
--nb-attack-tries=<value>LW6_NB_ATTACK_TRIESnb-attack-triesType: integer
Default value: 3 Min value: 1 Max value: 7
Defines how many tries a fighter will do before giving-up attacking and choosing another behvior (defense). By tries we mean: how many directions it will try. Going North? Going North-West? Setting this to a low value will make fighters somewhat less aggressive. This idea is that they'll prefer to switch to the next option, that is, defense/regeneration, if there's no opponent right in front of them.
--nb-defense-tries=<value>LW6_NB_DEFENSE_TRIESnb-defense-triesType: integer
Default value: 1 Min value: 1 Max value: 7
Defines how many tries a fighter will do before giving-up attacking and choosing another behavior (do nothing). By tries we mean: how many directions it will try. Going North? Going North-West? Setting this to a low value, you'll need a very compact pack of fighters for regeneration to operate, else fighters will hang arround unhealthy.
--nb-move-tries=<value>LW6_NB_MOVE_TRIESnb-move-triesType: integer
Default value: 5 Min value: 3 Max value: 7
Defines how many tries a fighter will do before giving-up moving and choosing another behvior (attack or defense). By tries we mean: how many directions it will try. Going North? Going North-West? Setting this to a low value, your fighters will look very stubborn and always try to move in one direction, neglecting the fact that they could dodge. This can lead to queues of fighters and other strange behaviors. On the other hand, setting it too high will cause fighter to always avoid the enemy, and groups of fighters will just pass each other without any fight. Matter of taste.
--respawn-delay=<value>LW6_RESPAWN_DELAYrespawn-delayType: integer
Default value: 3 Min value: 0 Max value: 30
Delay, in seconds, after which teams reappear on the battlefield, when in deathmatch mode. 0 means team right away.
--respawn-position-mode=<value>LW6_RESPAWN_POSITION_MODErespawn-position-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Defines how teams are set up on the map when respawning. 0 means teams respect the pre-defined start positions. 1 means that a random position will be picked, among the existing positions. That is, red could take green's place. 2 means total randomness, teams can appear anywhere.
--respawn-team=<value>LW6_RESPAWN_TEAMrespawn-teamType: integer
Default value: 1 Min value: 0 Max value: 1
Defines what to do when a team dies. If set to 0, team disappears forever, if set to 1, team reappears automatically with fresh fighters. It's a deathmatch mode, where the winner is not the one who stays alive the longest time, since it makes no real sens in this case, but the one who has died less often than others.
--round-delta=<value>LW6_ROUND_DELTAround-deltaType: integer
Default value: 1 Min value: 0 Max value: 100
Conditions by how much the cursor potential will be incremented each time gradient is spreaded. Sounds cryptic? It is. The idea is that at each time you move your cursor of 1 pixel, theorically, you'll need in the worst case to move of 1 more pixel to reach any point on the map. Of course this is not true but this is the default asumption, and gradient spread will fix that. Only in Liquid War 6 this is not even the worst case, for you can control your cursor with the mouse and cross walls. Whenever you cross a wall, you might have done a great distance from the fighters' point of view, if the map is a maze. Thus this parameter, which corrects things, experience shows it does give acceptable results to increase the cursor potential by more than one at each turn. Toy arround with this if you find fighters take wrong paths on some given map. If in doubt, don't touch.
--rounds-per-sec=<value>LW6_ROUNDS_PER_SECrounds-per-secType: integer
Default value: 50 Min value: 1 Max value: 200
Defines the overall speed of the game. All other settings being equal, raising this value will cause the game to behave faster. Everything will be faster, except probably the display since your computer will calculate more game positions in a given time and spend more CPU time. It will also increase network traffic. Values between 10 and 50 really make sense.
--side-attack-factor=<value>LW6_SIDE_ATTACK_FACTORside-attack-factorType: integer
Default value: 20 Min value: 0 Max value: 100
Defines how hard fighters will attack sideways. It's an algorithm trick, fighters attack by default the opponent right in front, but if there's no fighter there, they will still try to attack someone else, maybe sideways. But doing this their attack is not as strong. This parameter enables you to tune this. This is a percentage.
--side-defense-factor=<value>LW6_SIDE_DEFENSE_FACTORside-defense-factorType: integer
Default value: 20 Min value: 0 Max value: 100
Defines how fast fighters will regenerate, when being side by side instead of being right in front of the other. This is a percentage.
--single-army-size=<value>LW6_SINGLE_ARMY_SIZEsingle-army-sizeType: integer
Default value: 30 Min value: 1 Max value: 95
Defines the proportion of the whole available space, which will be occupied by an army at the beginning of the game. You can either imagine playing with almost empty maps, or play very crowded with almost no space left. This is a percentage, but will be multiplied by itself to get the actual surface. That is, 50 means 50%*50%, that is, a square of 1/2 the size of a square map, so it represents 25% (1/4) of the total surface.
--spread-mode=<value>LW6_SPREAD_MODEspread-modeType: integer
Default value: 1 Min value: 0 Max value: 2
If set to 1, then gradient spread will be slower but gain in terms of homogeneity and consistency. You could consider setting this to 0 on very very big maps to save CPU cycles, else the default should work fine.
--spread-thread=<value>LW6_SPREAD_THREADspread-threadType: integer
Default value: 0 Min value: 0 Max value: 1
If set to 1, the core algorithm with fire a separate thread to spread the gradient. By default this is turned off (set to 0). Consider this as an experimental feature, the program is already rather heavily threaded, turning this on will probably not offer any significant performance gain, even on SMP systems. This might change in the future.
--spreads-per-round=<value>LW6_SPREADS_PER_ROUNDspreads-per-roundType: integer
Default value: 5 Min value: 1 Max value: 100
Defines how many times the gradient is spread per round. Gradient spread is a very Liquid War 6 specific feature, just remember that the more often you do it, the more accurately fighters will move. That is, you will be sure they really take the shortest path. Usually this does not have much effect, the default value should fit in most cases, but you might want to decrease it on very simple maps where the gradient is obvious, or increase it on complex maps where you want fighters to be real smart.
--start-blue-x=<value>LW6_START_BLUE_Xstart-blue-xType: integer
Default value: 90 Min value: 0 Max value: 100
X start position for the blue team. This is a percentage of map width, value between 0 and 100.
--start-blue-y=<value>LW6_START_BLUE_Ystart-blue-yType: integer
Default value: 10 Min value: 0 Max value: 100
Y start position for the blue team. This is a percentage of map height, value between 0 and 100.
--start-cyan-x=<value>LW6_START_CYAN_Xstart-cyan-xType: integer
Default value: 35 Min value: 0 Max value: 100
X start position for the cyan team. This is a percentage of map width, value between 0 and 100.
--start-cyan-y=<value>LW6_START_CYAN_Ystart-cyan-yType: integer
Default value: 10 Min value: 0 Max value: 100
Y start position for the cyan team. This is a percentage of map height, value between 0 and 100.
--start-green-x=<value>LW6_START_GREEN_Xstart-green-xType: integer
Default value: 90 Min value: 0 Max value: 100
X start position for the green team. This is a percentage of map width, value between 0 and 100.
--start-green-y=<value>LW6_START_GREEN_Ystart-green-yType: integer
Default value: 90 Min value: 0 Max value: 100
Y start position for the green team. This is a percentage of map height, value between 0 and 100.
--start-lightblue-x=<value>LW6_START_LIGHTBLUE_Xstart-lightblue-xType: integer
Default value: 35 Min value: 0 Max value: 100
X start position for the lightblue team. This is a percentage of map width, value between 0 and 100.
--start-lightblue-y=<value>LW6_START_LIGHTBLUE_Ystart-lightblue-yType: integer
Default value: 90 Min value: 0 Max value: 100
Y start position for the lightblue team. This is a percentage of map height, value between 0 and 100.
--start-magenta-x=<value>LW6_START_MAGENTA_Xstart-magenta-xType: integer
Default value: 65 Min value: 0 Max value: 100
X start position for the magenta team. This is a percentage of map width, value between 0 and 100.
--start-magenta-y=<value>LW6_START_MAGENTA_Ystart-magenta-yType: integer
Default value: 90 Min value: 0 Max value: 100
Y start position for the magenta team. This is a percentage of map height, value between 0 and 100.
--start-orange-x=<value>LW6_START_ORANGE_Xstart-orange-xType: integer
Default value: 65 Min value: 0 Max value: 100
X start position for the orange team. This is a percentage of map width, value between 0 and 100.
--start-orange-y=<value>LW6_START_ORANGE_Ystart-orange-yType: integer
Default value: 10 Min value: 0 Max value: 100
Y start position for the orange team. This is a percentage of map height, value between 0 and 100.
--start-pink-x=<value>LW6_START_PINK_Xstart-pink-xType: integer
Default value: 10 Min value: 0 Max value: 100
X start position for the pink team. This is a percentage of map width, value between 0 and 100.
--start-pink-y=<value>LW6_START_PINK_Ystart-pink-yType: integer
Default value: 50 Min value: 0 Max value: 100
Y start position for the pink team. This is a percentage of map height, value between 0 and 100.
--start-position-mode=<value>LW6_START_POSITION_MODEstart-position-modeType: integer
Default value: 0 Min value: 0 Max value: 2
Defines how teams are set up on the map at game startup. 0 means teams respect the pre-defined start positions. 1 means that a random position will be picked, among the existing positions. That is, red could take green's place. 2 means total randomness, teams can appear anywhere.
--start-purple-x=<value>LW6_START_PURPLE_Xstart-purple-xType: integer
Default value: 90 Min value: 0 Max value: 100
X start position for the purple team. This is a percentage of map width, value between 0 and 100.
--start-purple-y=<value>LW6_START_PURPLE_Ystart-purple-yType: integer
Default value: 50 Min value: 0 Max value: 100
Y start position for the purple team. This is a percentage of map height, value between 0 and 100.
--start-red-x=<value>LW6_START_RED_Xstart-red-xType: integer
Default value: 10 Min value: 0 Max value: 100
X start position for the red team. This is a percentage of map width, value between 0 and 100.
--start-red-y=<value>LW6_START_RED_Ystart-red-yType: integer
Default value: 10 Min value: 0 Max value: 100
Y start position for the red team. This is a percentage of map height, value between 0 and 100.
--start-yellow-x=<value>LW6_START_YELLOW_Xstart-yellow-xType: integer
Default value: 10 Min value: 0 Max value: 100
X start position for the yellow team. This is a percentage of map width, value between 0 and 100.
--start-yellow-y=<value>LW6_START_YELLOW_Ystart-yellow-yType: integer
Default value: 90 Min value: 0 Max value: 100
Y start position for the yellow team. This is a percentage of map height, value between 0 and 100.
--team-profile-blue-aggressive=<value>LW6_TEAM_PROFILE_BLUE_AGGRESSIVEteam-profile-blue-aggressiveType: integer
Default value: 150 Min value: 5 Max value: 2000
Defines how aggressive the blue team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-blue-fast=<value>LW6_TEAM_PROFILE_BLUE_FASTteam-profile-blue-fastType: integer
Default value: 50 Min value: 5 Max value: 2000
Changes the speed of the blue team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-blue-mobile=<value>LW6_TEAM_PROFILE_BLUE_MOBILEteam-profile-blue-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the blue team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-blue-vulnerable=<value>LW6_TEAM_PROFILE_BLUE_VULNERABLEteam-profile-blue-vulnerableType: integer
Default value: 60 Min value: 5 Max value: 2000
Defines how vulnerable the blue team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-blue-weapon-alternate-id=<value>LW6_TEAM_PROFILE_BLUE_WEAPON_ALTERNATE_IDteam-profile-blue-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_CONTROL Min value: 0 Max value: 19
Id of the default alternate weapon for the blue team, see the documentation about weapons to know what these ids mean.
--team-profile-blue-weapon-id=<value>LW6_TEAM_PROFILE_BLUE_WEAPON_IDteam-profile-blue-weapon-idType: integer
Default value: LW6MAP_WEAPON_REWIND Min value: 0 Max value: 19
Id of the default weapon for the blue team, see the documentation about weapons to know what these ids mean.
--team-profile-blue-weapon-mode=<value>LW6_TEAM_PROFILE_BLUE_WEAPON_MODEteam-profile-blue-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for blue team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-cyan-aggressive=<value>LW6_TEAM_PROFILE_CYAN_AGGRESSIVEteam-profile-cyan-aggressiveType: integer
Default value: 44 Min value: 5 Max value: 2000
Defines how aggressive the cyan team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-cyan-fast=<value>LW6_TEAM_PROFILE_CYAN_FASTteam-profile-cyan-fastType: integer
Default value: 40 Min value: 5 Max value: 2000
Changes the speed of the cyan team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-cyan-mobile=<value>LW6_TEAM_PROFILE_CYAN_MOBILEteam-profile-cyan-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the cyan team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-cyan-vulnerable=<value>LW6_TEAM_PROFILE_CYAN_VULNERABLEteam-profile-cyan-vulnerableType: integer
Default value: 12 Min value: 5 Max value: 2000
Defines how vulnerable the cyan team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-cyan-weapon-alternate-id=<value>LW6_TEAM_PROFILE_CYAN_WEAPON_ALTERNATE_IDteam-profile-cyan-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_REVERSE Min value: 0 Max value: 19
Id of the default alternate weapon for the cyan team, see the documentation about weapons to know what these ids mean.
--team-profile-cyan-weapon-id=<value>LW6_TEAM_PROFILE_CYAN_WEAPON_IDteam-profile-cyan-weapon-idType: integer
Default value: LW6MAP_WEAPON_TURBO Min value: 0 Max value: 19
Id of the default weapon for the cyan team, see the documentation about weapons to know what these ids mean.
--team-profile-cyan-weapon-mode=<value>LW6_TEAM_PROFILE_CYAN_WEAPON_MODEteam-profile-cyan-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for cyan team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-green-aggressive=<value>LW6_TEAM_PROFILE_GREEN_AGGRESSIVEteam-profile-green-aggressiveType: integer
Default value: 70 Min value: 5 Max value: 2000
Defines how aggressive the green team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-green-fast=<value>LW6_TEAM_PROFILE_GREEN_FASTteam-profile-green-fastType: integer
Default value: 70 Min value: 5 Max value: 2000
Changes the speed of the green team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-green-mobile=<value>LW6_TEAM_PROFILE_GREEN_MOBILEteam-profile-green-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the green team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-green-vulnerable=<value>LW6_TEAM_PROFILE_GREEN_VULNERABLEteam-profile-green-vulnerableType: integer
Default value: 30 Min value: 5 Max value: 2000
Defines how vulnerable the green team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-green-weapon-alternate-id=<value>LW6_TEAM_PROFILE_GREEN_WEAPON_ALTERNATE_IDteam-profile-green-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_MIX Min value: 0 Max value: 19
Id of the default alternate weapon for the green team, see the documentation about weapons to know what these ids mean.
--team-profile-green-weapon-id=<value>LW6_TEAM_PROFILE_GREEN_WEAPON_IDteam-profile-green-weapon-idType: integer
Default value: LW6MAP_WEAPON_CRAZY Min value: 0 Max value: 19
Id of the default weapon for the green team, see the documentation about weapons to know what these ids mean.
--team-profile-green-weapon-mode=<value>LW6_TEAM_PROFILE_GREEN_WEAPON_MODEteam-profile-green-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for green team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-lightblue-aggressive=<value>LW6_TEAM_PROFILE_LIGHTBLUE_AGGRESSIVEteam-profile-lightblue-aggressiveType: integer
Default value: 200 Min value: 5 Max value: 2000
Defines how aggressive the lightblue team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-lightblue-fast=<value>LW6_TEAM_PROFILE_LIGHTBLUE_FASTteam-profile-lightblue-fastType: integer
Default value: 20 Min value: 5 Max value: 2000
Changes the speed of the lightblue team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-lightblue-mobile=<value>LW6_TEAM_PROFILE_LIGHTBLUE_MOBILEteam-profile-lightblue-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the lightblue team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-lightblue-vulnerable=<value>LW6_TEAM_PROFILE_LIGHTBLUE_VULNERABLEteam-profile-lightblue-vulnerableType: integer
Default value: 8 Min value: 5 Max value: 2000
Defines how vulnerable the lightblue team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-lightblue-weapon-alternate-id=<value>LW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_ALTERNATE_IDteam-profile-lightblue-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_KAMIKAZE Min value: 0 Max value: 19
Id of the default alternate weapon for the lightblue team, see the documentation about weapons to know what these ids mean.
--team-profile-lightblue-weapon-id=<value>LW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_IDteam-profile-lightblue-weapon-idType: integer
Default value: LW6MAP_WEAPON_TELEPORT Min value: 0 Max value: 19
Id of the default weapon for the lightblue team, see the documentation about weapons to know what these ids mean.
--team-profile-lightblue-weapon-mode=<value>LW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_MODEteam-profile-lightblue-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for lightblue team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-magenta-aggressive=<value>LW6_TEAM_PROFILE_MAGENTA_AGGRESSIVEteam-profile-magenta-aggressiveType: integer
Default value: 192 Min value: 5 Max value: 2000
Defines how aggressive the magenta team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-magenta-fast=<value>LW6_TEAM_PROFILE_MAGENTA_FASTteam-profile-magenta-fastType: integer
Default value: 320 Min value: 5 Max value: 2000
Changes the speed of the magenta team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-magenta-mobile=<value>LW6_TEAM_PROFILE_MAGENTA_MOBILEteam-profile-magenta-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the magenta team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-magenta-vulnerable=<value>LW6_TEAM_PROFILE_MAGENTA_VULNERABLEteam-profile-magenta-vulnerableType: integer
Default value: 1920 Min value: 5 Max value: 2000
Defines how vulnerable the magenta team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-magenta-weapon-alternate-id=<value>LW6_TEAM_PROFILE_MAGENTA_WEAPON_ALTERNATE_IDteam-profile-magenta-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_ATTRACT Min value: 0 Max value: 19
Id of the default alternate weapon for the magenta team, see the documentation about weapons to know what these ids mean.
--team-profile-magenta-weapon-id=<value>LW6_TEAM_PROFILE_MAGENTA_WEAPON_IDteam-profile-magenta-weapon-idType: integer
Default value: LW6MAP_WEAPON_FIX Min value: 0 Max value: 19
Id of the default weapon for the magenta team, see the documentation about weapons to know what these ids mean.
--team-profile-magenta-weapon-mode=<value>LW6_TEAM_PROFILE_MAGENTA_WEAPON_MODEteam-profile-magenta-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for magenta team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-orange-aggressive=<value>LW6_TEAM_PROFILE_ORANGE_AGGRESSIVEteam-profile-orange-aggressiveType: integer
Default value: 48 Min value: 5 Max value: 2000
Defines how aggressive the orange team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-orange-fast=<value>LW6_TEAM_PROFILE_ORANGE_FASTteam-profile-orange-fastType: integer
Default value: 160 Min value: 5 Max value: 2000
Changes the speed of the orange team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-orange-mobile=<value>LW6_TEAM_PROFILE_ORANGE_MOBILEteam-profile-orange-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the orange team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-orange-vulnerable=<value>LW6_TEAM_PROFILE_ORANGE_VULNERABLEteam-profile-orange-vulnerableType: integer
Default value: 144 Min value: 5 Max value: 2000
Defines how vulnerable the orange team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-orange-weapon-alternate-id=<value>LW6_TEAM_PROFILE_ORANGE_WEAPON_ALTERNATE_IDteam-profile-orange-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_SHRINK Min value: 0 Max value: 19
Id of the default alternate weapon for the orange team, see the documentation about weapons to know what these ids mean.
--team-profile-orange-weapon-id=<value>LW6_TEAM_PROFILE_ORANGE_WEAPON_IDteam-profile-orange-weapon-idType: integer
Default value: LW6MAP_WEAPON_BERZERK Min value: 0 Max value: 19
Id of the default weapon for the orange team, see the documentation about weapons to know what these ids mean.
--team-profile-orange-weapon-mode=<value>LW6_TEAM_PROFILE_ORANGE_WEAPON_MODEteam-profile-orange-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for orange team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-pink-aggressive=<value>LW6_TEAM_PROFILE_PINK_AGGRESSIVEteam-profile-pink-aggressiveType: integer
Default value: 640 Min value: 5 Max value: 2000
Defines how aggressive the pink team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-pink-fast=<value>LW6_TEAM_PROFILE_PINK_FASTteam-profile-pink-fastType: integer
Default value: 80 Min value: 5 Max value: 2000
Changes the speed of the pink team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-pink-mobile=<value>LW6_TEAM_PROFILE_PINK_MOBILEteam-profile-pink-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the pink team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-pink-vulnerable=<value>LW6_TEAM_PROFILE_PINK_VULNERABLEteam-profile-pink-vulnerableType: integer
Default value: 640 Min value: 5 Max value: 2000
Defines how vulnerable the pink team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-pink-weapon-alternate-id=<value>LW6_TEAM_PROFILE_PINK_WEAPON_ALTERNATE_IDteam-profile-pink-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_PLAGUE Min value: 0 Max value: 19
Id of the default alternate weapon for the pink team, see the documentation about weapons to know what these ids mean.
--team-profile-pink-weapon-id=<value>LW6_TEAM_PROFILE_PINK_WEAPON_IDteam-profile-pink-weapon-idType: integer
Default value: LW6MAP_WEAPON_INVINCIBLE Min value: 0 Max value: 19
Id of the default weapon for the pink team, see the documentation about weapons to know what these ids mean.
--team-profile-pink-weapon-mode=<value>LW6_TEAM_PROFILE_PINK_WEAPON_MODEteam-profile-pink-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for pink team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-purple-aggressive=<value>LW6_TEAM_PROFILE_PURPLE_AGGRESSIVEteam-profile-purple-aggressiveType: integer
Default value: 32 Min value: 5 Max value: 2000
Defines how aggressive the purple team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-purple-fast=<value>LW6_TEAM_PROFILE_PURPLE_FASTteam-profile-purple-fastType: integer
Default value: 80 Min value: 5 Max value: 2000
Changes the speed of the purple team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-purple-mobile=<value>LW6_TEAM_PROFILE_PURPLE_MOBILEteam-profile-purple-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the purple team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-purple-vulnerable=<value>LW6_TEAM_PROFILE_PURPLE_VULNERABLEteam-profile-purple-vulnerableType: integer
Default value: 16 Min value: 5 Max value: 2000
Defines how vulnerable the purple team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-purple-weapon-alternate-id=<value>LW6_TEAM_PROFILE_PURPLE_WEAPON_ALTERNATE_IDteam-profile-purple-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_DISAPPEAR Min value: 0 Max value: 19
Id of the default alternate weapon for the purple team, see the documentation about weapons to know what these ids mean.
--team-profile-purple-weapon-id=<value>LW6_TEAM_PROFILE_PURPLE_WEAPON_IDteam-profile-purple-weapon-idType: integer
Default value: LW6MAP_WEAPON_ATOMIC Min value: 0 Max value: 19
Id of the default weapon for the purple team, see the documentation about weapons to know what these ids mean.
--team-profile-purple-weapon-mode=<value>LW6_TEAM_PROFILE_PURPLE_WEAPON_MODEteam-profile-purple-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for purple team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-red-aggressive=<value>LW6_TEAM_PROFILE_RED_AGGRESSIVEteam-profile-red-aggressiveType: integer
Default value: 220 Min value: 5 Max value: 2000
Defines how aggressive the red team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-red-fast=<value>LW6_TEAM_PROFILE_RED_FASTteam-profile-red-fastType: integer
Default value: 160 Min value: 5 Max value: 2000
Changes the speed of the red team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-red-mobile=<value>LW6_TEAM_PROFILE_RED_MOBILEteam-profile-red-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the red team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-red-vulnerable=<value>LW6_TEAM_PROFILE_RED_VULNERABLEteam-profile-red-vulnerableType: integer
Default value: 110 Min value: 5 Max value: 2000
Defines how vulnerable the red team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-red-weapon-alternate-id=<value>LW6_TEAM_PROFILE_RED_WEAPON_ALTERNATE_IDteam-profile-red-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_ESCAPE Min value: 0 Max value: 19
Id of the default alternate weapon for the red team, see the documentation about weapons to know what these ids mean.
--team-profile-red-weapon-id=<value>LW6_TEAM_PROFILE_RED_WEAPON_IDteam-profile-red-weapon-idType: integer
Default value: LW6MAP_WEAPON_STEAL Min value: 0 Max value: 19
Id of the default weapon for the red team, see the documentation about weapons to know what these ids mean.
--team-profile-red-weapon-mode=<value>LW6_TEAM_PROFILE_RED_WEAPON_MODEteam-profile-red-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for red team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--team-profile-yellow-aggressive=<value>LW6_TEAM_PROFILE_YELLOW_AGGRESSIVEteam-profile-yellow-aggressiveType: integer
Default value: 200 Min value: 5 Max value: 2000
Defines how aggressive the yellow team is. This is a percentage, if set to 200 then team will attack twice as much as any other team with the default value. Setting this to a high value clearly advantages this team.
--team-profile-yellow-fast=<value>LW6_TEAM_PROFILE_YELLOW_FASTteam-profile-yellow-fastType: integer
Default value: 70 Min value: 5 Max value: 2000
Changes the speed of the yellow team. This is a percentage, if set to 50, then team will move twice slower than other teams with the default parameter. Setting this high is very likely to advantage the team.
--team-profile-yellow-mobile=<value>LW6_TEAM_PROFILE_YELLOW_MOBILEteam-profile-yellow-mobileType: integer
Default value: 0 Min value: -3 Max value: 3
Increases (or decreases if negative) the number of move/attack/defense tries for the yellow team. If set to a high value team will appear more mobile and do more things, but it won't change its cruising speed. It's not obvious to tell wether this is an advantage or not, but it clearly changes the behavior.
--team-profile-yellow-vulnerable=<value>LW6_TEAM_PROFILE_YELLOW_VULNERABLEteam-profile-yellow-vulnerableType: integer
Default value: 90 Min value: 5 Max value: 2000
Defines how vulnerable the yellow team is. This is a percentage, if set to 200 then team will be attacked twice as much as any other team with the default value. Setting this to a high value clearly disadvantages this team.
--team-profile-yellow-weapon-alternate-id=<value>LW6_TEAM_PROFILE_YELLOW_WEAPON_ALTERNATE_IDteam-profile-yellow-weapon-alternate-idType: integer
Default value: LW6MAP_WEAPON_PERMUTATION Min value: 0 Max value: 19
Id of the default alternate weapon for the yellow team, see the documentation about weapons to know what these ids mean.
--team-profile-yellow-weapon-id=<value>LW6_TEAM_PROFILE_YELLOW_WEAPON_IDteam-profile-yellow-weapon-idType: integer
Default value: LW6MAP_WEAPON_SCATTER Min value: 0 Max value: 19
Id of the default weapon for the yellow team, see the documentation about weapons to know what these ids mean.
--team-profile-yellow-weapon-mode=<value>LW6_TEAM_PROFILE_YELLOW_WEAPON_MODEteam-profile-yellow-weapon-modeType: integer
Default value: 1 Min value: 0 Max value: 2
Weapon mode for yellow team. 0 means there's no weapon, 1 means one weapon per team, defined by the weapon-id parameter, 2 means random weapon.
--total-armies-size=<value>LW6_TOTAL_ARMIES_SIZEtotal-armies-sizeType: integer
Default value: 60 Min value: 1 Max value: 95
Defines the proportion of the whole available space, which can be occupied by all the armies present together. Setting this low, whenever a new team arrives on the map, fighters might be stolen to other teams, otherwise the ame would get too crowded. This allows you to play with reasonnably enough fighters with 2 players, while still allowing interesting gameplay with many players. This is a percentage, but will be multiplied by itself to get the actual surface. That is, 50 means 50%*50%, that is, a square of 1/2 the size of a square map, so it represents 25% (1/4) of the total surface.
--total-time=<value>LW6_TOTAL_TIMEtotal-timeType: integer
Default value: 900 Min value: 10 Max value: 864000
Defines the maximum time of the game, in seconds. Note that in some cases, the game can end much earlier if some player has managed to win before the bell rings. Also, technically, this value will be translated into rounds and moves, and the game engine will wait until enough rounds and moves have been played. So if the computer is too slow and the desired speed is not reached, then the game will last for a longer time.
--use-team-profiles=<value>LW6_USE_TEAM_PROFILESuse-team-profilesType: integer
Default value: 1 Min value: 0 Max value: 1
If set, then all the team-profile-... values will be taken in account. This enables a mode in which teams behave differently according to their colors. If you disable this, then all teams will behave the same, which is more fair, but might not be as fun.
--vertical-move=<value>LW6_VERTICAL_MOVEvertical-moveType: integer
Default value: 1 Min value: 0 Max value: 7
Defines when to process a vertical move (along the Z 'depth' axis). If set to 0, fighters never spontaneously move along this axis. If set to 1, it will be tried just after the first move failed. If set to 2, it will be tried just after the second move failed. And so on.
--weapon-charge-delay=<value>LW6_WEAPON_CHARGE_DELAYweapon-charge-delayType: integer
Default value: 30 Min value: 1 Max value: 600
How long it will take for weapons to charge and be usable, by default. Unit is seconds.
--weapon-charge-max=<value>LW6_WEAPON_CHARGE_MAXweapon-charge-maxType: integer
Default value: 200 Min value: 100 Max value: 1000
Maximum (percentage) of charge intensity that one have. For instance, if this is 400, then if you wait four times more than required before firing, then you weapon will have four times its default power, but if you wait five times more it will still be four times more powerfull, it's just the limit after which it's useless to charge.
--weapon-duration=<value>LW6_WEAPON_DURATIONweapon-durationType: integer
Default value: 3 Min value: 1 Max value: 60
How long all weapons (for which duration makes sense) will last. Unit is seconds.
--weapon-tune-berzerk-power=<value>LW6_WEAPON_TUNE_BERZERK_POWERweapon-tune-berzerk-powerType: integer
Default value: 3 Min value: 1 Max value: 100
Use to specifiy how strong berzerk mode is, if set to 3, then attacks will be 3 times as efficient in berzerk mode.
--weapon-tune-turbo-power=<value>LW6_WEAPON_TUNE_TURBO_POWERweapon-tune-turbo-powerType: integer
Default value: 3 Min value: 1 Max value: 10
Defines how fast fighters move in turbo mode, if set to 3, then fighters move and act 3 times as fast.
--x-polarity=<value>LW6_X_POLARITYx-polarityType: integer
Default value: 0 Min value: -1 Max value: 1
Defines how the map will be wrapped on the X (horizontal) axis. If set to 0, nothing is wrapped. If set to 1, the right and left borders are connected, any fighter can disappear on the right border and reappear on the left border, for instance. If set to -1, it will be wrapped but also inversed, that is on a 320x240 map, a fighter disappearing on the left border at position (0,60) will reapper on the right border at position (319,180). You can combine it with 'y-polarity'.
--y-polarity=<value>LW6_Y_POLARITYy-polarityType: integer
Default value: 0 Min value: -1 Max value: 1
Defines how the map will be wrapped on the Y (vertical) axis. If set to 0, nothing is wrapped. If set to 1, the top and bottom borders are connected, any fighter can disappear on the top border and reappear on the bottom border, for instance. If set to -1, it will be wrapped but also inversed, that is on a 320x240 map, a fighter disappearing on the bottom border at position (40,239) will reapper on the top border at position (280,0). You can combine it with 'x-polarity'.
--z-polarity=<value>LW6_Z_POLARITYz-polarityType: integer
Default value: 0 Min value: 0 Max value: 1
Defines how the map will be wrapped on the Z (deep) axis. If set to 0, nothing is wrapped. If set to 1, when using a 4 layer map, for instance, fighters on layer 1 will be able to go directly to layer 4 even if layers 2 and 3 are filled with walls. A value of -1 is forbidden, this is not like x and y axis, it does not really make sense. Consider this an advanced setting which might save a layer in some tricky cases, the default value of 0 should fit in most cases.
--background-color-auto=<value>LW6_BACKGROUND_COLOR_AUTObackground-color-autoType: boolean
Default value: true
Defines wether hud colors will be set automatically from base and alternate colors. This is a time saver to keep map designers from requiring to redefined every single color in the game. You only need to set color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg. Then hud_color_frame_bg, hud_color_frame_fg, hud_color_text_bg and hud_color_text_fg will be automatically set.
--downsize-using-bench-value=<value>LW6_DOWNSIZE_USING_BENCH_VALUEdownsize-using-bench-valueType: boolean
Default value: true
If set, then the game will automatically downsize a map according to the 'bench-value' parameter. Downsizing means: a 1600x1200 maps becomes 200x150, for instance. Downsizing causes fighters to be bigger because map resolution is lower. This will avoid running the game on a too big map, with your computer not being able to handle it at the required speed.
--downsize-using-fighter-scale=<value>LW6_DOWNSIZE_USING_FIGHTER_SCALEdownsize-using-fighter-scaleType: boolean
Default value: false
If set, then the game will automatically downsize a map according to the 'fighter-scale' parameter. Downsizing means: a 1600x1200 maps becomes 200x150, for instance. Downsizing causes fighters to be bigger because map resolution is lower. This can be usefull if you don't want fighters to be too small.
--fighter-scale=<value>LW6_FIGHTER_SCALEfighter-scaleType: float
Default value: 1.0
Defines how wide (in pixels) fighters must be. This parameter is very important and will largely condition the number of fighters on the map. It is used when loading the map. If it is, for instance, set to 1, there will be exactly a fighter per pixel on the screen. That is, if you play 640x480 on an empty map, the maximum fighters you could have is about 300000. The idea is that by changing the resolution, you also define the density of the map. In pratice, this is done in the hope that someone with a slow computer will pick up a low resolution and therefore play small levels. Conversely, someone with a brand new computer with powerfull CPU & GPU will use great resolutions and be happy with many fighters on the map. Still, changing the resolution after loading the map will not affet the number of fighters. Same for network games, the first player, who loads the map, defines its properties according to its own settings.
--guess-colors=<value>LW6_GUESS_COLORSguess-colorsType: boolean
Default value: true
Defines wether colors should be set automatically from texture colors. If set to true, then the program will try to pick up colors automatically from the texture, and will override the values of the color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg parameters. How these colors are picked up can't be garanteed, so if the map does not have strong contrast or if there can be any form of ambiguity, it's safe to set this to false and define one's own colors.
--guess-moves-per-sec=<value>LW6_GUESS_MOVES_PER_SECguess-moves-per-secType: boolean
Default value: true
If set, then loader will use 'time-to-cross-level' to guess the game speed parameters.
--hud-color-auto=<value>LW6_HUD_COLOR_AUTOhud-color-autoType: boolean
Default value: true
Defines wether hud colors will be set automatically from base and alternate colors. This is a time saver to keep map designers from requiring to redefined every single color in the game. You only need to set color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg. Then hud_color_frame_bg, hud_color_frame_fg, hud_color_text_bg and hud_color_text_fg will be automatically set.
--max-map-height=<value>LW6_MAX_MAP_HEIGHTmax-map-heightType: integer
Default value: 1000
Allows you to give a maximum map height. When designing a map you might wonder: this is dumb I'm conceiving this map I know its height, why should I limit it? Now think of the play who plays on a old slowish computer with a tiny screen. He might redefine this himself, and does not necessarly wishes to fire Gimp to rescale the map.
--max-map-surface=<value>LW6_MAX_MAP_SURFACEmax-map-surfaceType: integer
Default value: 1000000
Allows you to give a maximum map surface. Map surface is simply (width * height). This parameter is just here to save you the hassle of defining both 'max-map-width' and 'max-map-height' in a consistent manner.
--max-map-width=<value>LW6_MAX_MAP_WIDTHmax-map-widthType: integer
Default value: 1500
Allows you to give a maximum map width. When designing a map you might wonder: this is dumb I'm conceiving this map I know its width, why should I limit it? Now think of the play who plays on a old slowish computer with a tiny screen. He might redefine this himself, and does not necessarly wishes to fire Gimp to rescale the map.
--menu-color-auto=<value>LW6_MENU_COLOR_AUTOmenu-color-autoType: boolean
Default value: true
Defines wether menu colors will be set automatically from base and alternate colors. This is a time saver to keep map designers from requiring to redefined every single color in the game. You only need to set color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg. Then menu_color_default_bg, menu_color_default_fg, menu_color_selected_bg, menu_color_selected_fg, menu_color_disabled_bg and menu_color_disabled_fg will be automatically set.
--min-map-height=<value>LW6_MIN_MAP_HEIGHTmin-map-heightType: integer
Default value: 30
Allows you to give a minimum map height. When designing a map you might wonder: this is dumb I'm conceiving this map I know its height, why should I limit it? Now think of the player who decided to play with highly-defined maps because he has a super calculator and a hudge screen. He might redefine this himself, and does not necessarly wishes to fire Gimp to rescale the map.
--min-map-surface=<value>LW6_MIN_MAP_SURFACEmin-map-surfaceType: integer
Default value: 3600
Allows you to give a minimum map surface. Map surface is simply (width * height). This parameter is just here to save you the hassle of defining both 'min-map-width' and 'min-map-height' in a consistent manner.
--min-map-width=<value>LW6_MIN_MAP_WIDTHmin-map-widthType: integer
Default value: 40
Allows you to give a minimum map width. When designing a map you might wonder: this is dumb I'm conceiving this map I know its width, why should I limit it? Now think of the player who decided to play with highly-defined maps because he has a super calculator and a hudge screen. He might redefine this himself, and does not necessarly wishes to fire Gimp to rescale the map.
--resample=<value>LW6_RESAMPLEresampleType: boolean
Default value: true
If set to true, maps will always be resampled to a size which depends on your screen resolution, zoom factor, and the rest. If false, maps will be set at the exact resolution of map.png.
--speed=<value>LW6_SPEEDspeedType: float
Default value: 1.0
This parameter is the main parameter on which game speed depends. The map loader will garantee, by downscaling the map, that to cross the level (by crossing the level we mean, for instance, going from top-left corner to bottom-right corner in a straight line) a fighter will take a constant amount of time. Under the hood, the loader might of course rescale the map but it will also change game speed so that, at the end, fighters take a constant time to cross the level. This is, indeed, the most important thing, players do not care much if internally there are X or Y moves per second, the global game experience depends on how fast fighter movement looks on the screen. The default settings corresponds roughly to one second to cross the level. If you set this to 2.0, it will go twice faster.
--system-color-auto=<value>LW6_SYSTEM_COLOR_AUTOsystem-color-autoType: boolean
Default value: true
Defines wether system colors will be set automatically from base and alternate colors. This is a time saver to keep map designers from requiring to redefined every single color in the game. You only need to set color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg. Then system_color_bg and system_color_fg will be automatically set.
--upsize-using-bench-value=<value>LW6_UPSIZE_USING_BENCH_VALUEupsize-using-bench-valueType: boolean
Default value: false
If set, then the game will automatically upsize a map according to the 'fighter-scale' parameter. Upsizing means: a 160x120 maps becomes 400x300, for instance. Upsizing causes fighters to be smaller because map resolution is higher. This will avoid useless pixelish 'jumbo fighters' look when your computer is powerfull enough to do better.
--upsize-using-fighter-scale=<value>LW6_UPSIZE_USING_FIGHTER_SCALEupsize-using-fighter-scaleType: boolean
Default value: true
If set, then the game will automatically upsize a map according to the 'fighter-scale' parameter. Upsizing means: a 160x120 maps becomes 400x300, for instance. Upsizing causes fighters to be smaller because map resolution is higher. This can be usefull if you don't want fighters to be too big.
--view-color-auto=<value>LW6_VIEW_COLOR_AUTOview-color-autoType: boolean
Default value: true
Defines wether view colors will be set automatically from base and alternate colors. This is a time saver to keep map designers from requiring to redefined every single color in the game. You only need to set color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg. Then view_color_cursor_bg, view_color_cursor_fg, view_color_map_bg and view_color_map_fg will be automatically set.
--wall-grease=<value>LW6_WALL_GREASEwall-greaseType: integer
Default value: 0 Min value: -5 Max value: 5
This parameter allows you to make walls (AKA map foreground) thicker, or thiner, when map is loaded. Indeed, when map are resampled, and especially when they are downscaled, some walls may disappear, or some passages may be blocked. The loader can't automatically figure out wether it's more important to keep an existing wall or to keep an open passage for fighters. This parameter helps doing so, if you set it to a low value, level will be less greasy, and many passages might open themselves. On the contrary, if grease is at a high level, then a thin line of almost isolated pixels might become a thick wall. There's no real garantee your wall or passage will always be present, but it's a same bet to assume on a 'tunnel-like' level one needs to set grease to a low value, and on a 'wide open' level with few walls one needs to set grease to a high value.
--animation-density=<value>LW6_ANIMATION_DENSITYanimation-densityType: float
Default value: 1.0f Min value: 0 Max value: 10
Density of the background animation, that is, for instance, if the background animation is about displaying bubbles, using a high value will display many bubbles. A value of 1.0 corresponds to the default setting.
--animation-speed=<value>LW6_ANIMATION_SPEEDanimation-speedType: float
Default value: 1.0f Min value: 0 Max value: 10
Speed of the background animation, that is, for instance, if the background animation is about displaying bubbles, using a high value will cause bubbles to move very fast. A value of 1.0 corresponds to the default setting.
--background-color-root-bg=<value>LW6_BACKGROUND_COLOR_ROOT_BGbackground-color-root-bgType: color
Default value: #000
Defines the main background color. This is, for instance, the color which will be used to clear the screen before drawing thing. Will be automatically guessed from the map texture if color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--background-color-root-fg=<value>LW6_BACKGROUND_COLOR_ROOT_FGbackground-color-root-fgType: color
Default value: #ccc
Defines a color which will be used together with color-base-bg to compose the background. It can be wise to have a minimum contrast between this color and color-base-bg, but it is not mandatory, especially if other colors are manually redefined. Will be automatically guessed from the map texture if color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--background-color-stuff-bg=<value>LW6_BACKGROUND_COLOR_STUFF_BGbackground-color-stuff-bgType: color
Default value: #333
Defines a color which will be used together with color-alternate-fg to draw things (animations, sprites, text, whatever) in the background. It should be different enough from color-alternate-fg so that one can really distinguish these colors. Will be automatically guessed from the map texture if color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--background-color-stuff-fg=<value>LW6_BACKGROUND_COLOR_STUFF_FGbackground-color-stuff-fgType: color
Default value: #fff
Defines a color which will be used to draw things (animations, sprites, text, whatever) in the background. It should be different enough from color-alternate-bg so that one can really distinguish these colors. Think of this as the sprite, the text, the whatever-needs-to-be-seen-uses-this color. Will be automatically guessed from the map texture if color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--background-style=<value>LW6_BACKGROUND_STYLEbackground-styleType: string
Default value: bubbles
The background defines, of course, what is displayed at the background, but it also conditions the colors used for other items, such as the menus for instance. The possible values are 'void' and 'bubbles'.
--blink-cursor=<value>LW6_BLINK_CURSORblink-cursorType: boolean
Default value: false
If set, then cursor will blink, allowing you to see what's under the cursor. It's just a matter of taste, you might to always have your cursor displayed, or prefer to have it disappear from time to time so that you can see the action below
--color-alternate-bg=<value>LW6_COLOR_ALTERNATE_BGcolor-alternate-bgType: color
Default value: #333
Defines the alternate color, more precisely, its bg (background) part. Colors are always defined by a bg/fg pair. Most colors in the game can be deduced from this one, usually to color a map you only need to define color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg.
--color-alternate-fg=<value>LW6_COLOR_ALTERNATE_FGcolor-alternate-fgType: color
Default value: #fff
Defines the alternate color, more precisely, its fg (foreground) part. Colors are always defined by a bg/fg pair. Most colors in the game can be deduced from this one, usually to color a map you only need to define color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg.
--color-base-bg=<value>LW6_COLOR_BASE_BGcolor-base-bgType: color
Default value: #000
Defines the base color, more precisely, its bg (background) part. Colors are always defined by a bg/fg pair. Most colors in the game can be deduced from this one, usually to color a map you only need to define color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg.
--color-base-fg=<value>LW6_COLOR_BASE_FGcolor-base-fgType: color
Default value: #ccc
Defines the base color, more precisely, its fg (foreground) part. Colors are always defined by a bg/fg pair. Most colors in the game can be deduced from this one, usually to color a map you only need to define color-base-bg, color-base-fg, color-alternate-bg and color-alternate-fg.
--colorize=<value>LW6_COLORIZEcolorizeType: boolean
Default value: true
If set, then all background drawings including textures will use the background colors. This means, for instance, that if background colors are set automatically by color-auto from the map texture, then the background will adopt the same range of colors than the map itself. In short, the background will mimic the map.
--colorize-cursor=<value>LW6_COLORIZE_CURSORcolorize-cursorType: boolean
Default value: true
If set, then all cursors will use the automatic guessed colors, or the specified colors, but basically they won't be displayed using their native colors. This can be usefull for you can wish to use a generic non-colored texture for your cursor and let it be colorized automatically so that it's accorded to the level.
--cursor-size=<value>LW6_CURSOR_SIZEcursor-sizeType: float
Default value: 1.0f Min value: 0 Max value: 10
Size of the cursors on the map. 1 is the default, setting it to a higher value will make cursors bigger, a lower value will make them smaller.
--hidden-layer-alpha=<value>LW6_HIDDEN_LAYER_ALPHAhidden-layer-alphaType: float
Default value: 0.1f Min value: 0 Max value: 1
Whenever players are supposed to be hidden behind a wall, for instance if they are in layer 2 and layer 1 is filled with walls, it's still possible to see them, but with a low alpha value (almost transparent). This parameter allows you to trick this value, 0 will make these players absolutely invisible, 1 will make them totally opaque, like if they were on layer 1.
--hud-color-frame-bg=<value>LW6_HUD_COLOR_FRAME_BGhud-color-frame-bgType: color
Default value: #000
Defines the background color for the hud frame. Ignored if hud-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--hud-color-frame-fg=<value>LW6_HUD_COLOR_FRAME_FGhud-color-frame-fgType: color
Default value: #ccc
Defines the foreground color for the hud frame. Ignored if hud-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--hud-color-text-bg=<value>LW6_HUD_COLOR_TEXT_BGhud-color-text-bgType: color
Default value: #333
Defines the background color for hud text. Ignored if hud-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--hud-color-text-fg=<value>LW6_HUD_COLOR_TEXT_FGhud-color-text-fgType: color
Default value: #fff
Defines the foreground color for hud text. Ignored if hud-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--hud-style=<value>LW6_HUD_STYLEhud-styleType: string
Default value: floating
The hud is where informations about the game are displayed. This means, who is winning, are other status-like informations. Possible values include 'floating' and 'tactical'.
--keep-ratio=<value>LW6_KEEP_RATIOkeep-ratioType: boolean
Default value: true
Defines wether the map should keep its ratio, or if it should be stretched to fill the shape of your screen.
--menu-color-default-bg=<value>LW6_MENU_COLOR_DEFAULT_BGmenu-color-default-bgType: color
Default value: #333
Defines the default background color for menus. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-color-default-fg=<value>LW6_MENU_COLOR_DEFAULT_FGmenu-color-default-fgType: color
Default value: #fff
Defines the default foreground color for menus. In fact, this is the main color for menu text, the color used to draw letters in menus. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-color-disabled-bg=<value>LW6_MENU_COLOR_DISABLED_BGmenu-color-disabled-bgType: color
Default value: #000
Defines the background color for a disabled menu item. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-color-disabled-fg=<value>LW6_MENU_COLOR_DISABLED_FGmenu-color-disabled-fgType: color
Default value: #ccc
Defines the foreground color for a disabled menu item. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-color-selected-bg=<value>LW6_MENU_COLOR_SELECTED_BGmenu-color-selected-bgType: color
Default value: #fff
Defines the background color for a selected menu item. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-color-selected-fg=<value>LW6_MENU_COLOR_SELECTED_FGmenu-color-selected-fgType: color
Default value: #333
Defines the foreground color for a selected menu item. Ignored if menu-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--menu-style=<value>LW6_MENU_STYLEmenu-styleType: string
Default value: cylinder
The menu style is simply the name of the engine used to power the menu system. The only possible value, for now, is 'cylinder'.
--music-exclude=<value>LW6_MUSIC_EXCLUDEmusic-excludeType: string
Default value: Chadburn
If this string is found in a music file name, it will be excluded from the list when playing in random mode.
--music-file=<value>LW6_MUSIC_FILEmusic-fileType: string
Default value:
Allows you to play a custom music file (typically your own ogg music) and override default game music. If file does not exist, game will use its internal music. The file will be searched for in the current 'music-path' but also in the current map directory. No absolute or even relative path are allowed, only a plain filename with no slash or backslash. Avoid special characters at all cost.
--music-filter=<value>LW6_MUSIC_FILTERmusic-filterType: string
Default value:
A music filter, used when files are played randomly. This is not a complex regex-enabled filter, just a plain string search. Even the '*' wildcard won't work. If you want precise control on what music file to play, please consider reorganizing your files and/or use the 'music-file' parameter.
--pixelize=<value>LW6_PIXELIZEpixelizeType: boolean
Default value: false
Depending on the renderer capabilities, will try to pixelize some parts of the game. This can be used to emulate the old LW5 appearance.
--system-color-bg=<value>LW6_SYSTEM_COLOR_BGsystem-color-bgType: color
Default value: #333
Defines the system background color, used when displaying system info, such as the number of frames per second. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--system-color-fg=<value>LW6_SYSTEM_COLOR_FGsystem-color-fgType: color
Default value: #fff
Defines the system foreground color, used when displaying system info, such as the number of frames per second. This will typically be text color. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--team-color-blue=<value>LW6_TEAM_COLOR_BLUEteam-color-blueType: color
Default value: #00f
Defines the color for the blue team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-cyan=<value>LW6_TEAM_COLOR_CYANteam-color-cyanType: color
Default value: #0ff
Defines the color for the cyan team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-dead=<value>LW6_TEAM_COLOR_DEADteam-color-deadType: color
Default value: #000
Defines the color for the teams when they are dead. By default it is black, this means when a team is weak it becomes black. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-green=<value>LW6_TEAM_COLOR_GREENteam-color-greenType: color
Default value: #0f0
Defines the color for the green team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-lightblue=<value>LW6_TEAM_COLOR_LIGHTBLUEteam-color-lightblueType: color
Default value: #8bf
Defines the color for the light blue team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-magenta=<value>LW6_TEAM_COLOR_MAGENTAteam-color-magentaType: color
Default value: #f0f
Defines the color for the magenta team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-orange=<value>LW6_TEAM_COLOR_ORANGEteam-color-orangeType: color
Default value: #f80
Defines the color for the orange team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-pink=<value>LW6_TEAM_COLOR_PINKteam-color-pinkType: color
Default value: #f8b
Defines the color for the pink team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-purple=<value>LW6_TEAM_COLOR_PURPLEteam-color-purpleType: color
Default value: #b8f
Defines the color for the purple team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-red=<value>LW6_TEAM_COLOR_REDteam-color-redType: color
Default value: #f00
Defines the color for the red team. Syntax is HTML-like, #RGB or #RRGGBB.
--team-color-yellow=<value>LW6_TEAM_COLOR_YELLOWteam-color-yellowType: color
Default value: #ff0
Defines the color for the yellow team. Syntax is HTML-like, #RGB or #RRGGBB.
--view-color-cursor-bg=<value>LW6_VIEW_COLOR_CURSOR_BGview-color-cursor-bgType: color
Default value: #333
Defines the background cursor color. Will typically be used to draw the shape of the cursor. Ignored if view-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--view-color-cursor-fg=<value>LW6_VIEW_COLOR_CURSOR_FGview-color-cursor-fgType: color
Default value: #fff
Defines the foreground cursor color. Will typically be used to draw text in the cursor. Ignored if view-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--view-color-map-bg=<value>LW6_VIEW_COLOR_MAP_BGview-color-map-bgType: color
Default value: #000
Defines the background map color. If there's no map texture defined or if use-texture is false, this is the color of the places where armies will go. Ignored if view-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--view-color-map-fg=<value>LW6_VIEW_COLOR_MAP_FGview-color-map-fgType: color
Default value: #ccc
Defines the foreground map color. If there's no map texture defined or if use-texture is false, this is the color of walls, what armies can't go through. Ignored if view-color-auto is set. Can be #RGB, #RGBA, #RRGGBB or #RRGGBBAA.
--view-style=<value>LW6_VIEW_STYLEview-styleType: string
Default value: flat
The view style conditions which renderer is used for the map, the area where fighters are displayed. This is not the graphics backend. Indeed, the graphics backend defines which technical tool one uses (which library) one runs, wether this parameter says what kind of rendering one wants.
--waves=<value>LW6_WAVESwavesType: boolean
Default value: true
Activates the wave effect, that's to say level appears to be under water when playing.
--x-wrap=<value>LW6_X_WRAPx-wrapType: boolean
Default value: true
Defines wether the map should be wrapped on the x axis. This is the companion of 'x-polarity', if no polarity is defined, map can't be wrapped, but in some cases, one might wish to have a map with polarity but without wrapping if, for instance, textures do not tile nicely.
--y-wrap=<value>LW6_Y_WRAPy-wrapType: boolean
Default value: true
Defines wether the map should be wrapped on the y axis. This is the companion of 'y-polarity', if no polarity is defined, map can't be wrapped, but in some cases, one might wish to have a map with polarity but without wrapping if, for instance, textures do not tile nicely.
--zoom=<value>LW6_ZOOMzoomType: float
Default value: 1.0f
Defines the map zoom. If lower than 1.0, map will occupy only a fraction of the screen, if greater than 1.0, some areas will be outside the screen, and the player will need to scroll through it.
--zoom-max=<value>LW6_ZOOM_MAXzoom-maxType: float
Default value: 30.0f
Defines the max map zoom. If set to a high value, you'll be able to dynamically view the map with hudge fighters, seeing only a fraction of the level.
--zoom-min=<value>LW6_ZOOM_MINzoom-minType: float
Default value: 0.3f
Defines the min map zoom. If set to a low value, you'll be able to dynamically view a very small, reduced map.
--bot-iq=<value>LW6_BOT_IQbot-iqType: integer
Default value: 100 Min value: 0 Max value: 200
The IQ (intelligence quotient) of bots. Typically, a value of 100 will make the bot behave normally, performing at its best. A value of 0 will just make it act the worst way it can. Values over 100 probably won't change anything compared to 100, but this truely depends on which bot backend you're running.
--bot-speed=<value>LW6_BOT_SPEEDbot-speedType: float
Default value: 1.0f
The speed of bots, 1 means normal speed, higher value will speed it up, lower will slow it down. Note that this only has an impact on bot engines, not on the game speed itself.
--bot1-ai=<value>LW6_BOT1_AIbot1-aiType: string
Default value: idiot
AI engine for bot number 1.
--bot1-color=<value>LW6_BOT1_COLORbot1-colorType: string
Default value: green
Color for bot number 1.
--bot2-ai=<value>LW6_BOT2_AIbot2-aiType: string
Default value: idiot
AI engine for bot number 2.
--bot2-color=<value>LW6_BOT2_COLORbot2-colorType: string
Default value: blue
Color for bot number 2.
--bot3-ai=<value>LW6_BOT3_AIbot3-aiType: string
Default value: random
AI engine for bot number 3.
--bot3-color=<value>LW6_BOT3_COLORbot3-colorType: string
Default value: yellow
Color for bot number 3.
--bot4-ai=<value>LW6_BOT4_AIbot4-aiType: string
Default value: follow
AI engine for bot number 4.
--bot4-color=<value>LW6_BOT4_COLORbot4-colorType: string
Default value: cyan
Color for bot number 4.
--bot5-ai=<value>LW6_BOT5_AIbot5-aiType: string
Default value: random
AI engine for bot number 5.
--bot5-color=<value>LW6_BOT5_COLORbot5-colorType: string
Default value: magenta
Color for bot number 5.
--bot6-ai=<value>LW6_BOT6_AIbot6-aiType: string
Default value: follow
AI engine for bot number 6.
--bot6-color=<value>LW6_BOT6_COLORbot6-colorType: string
Default value: orange
Color for bot number 6.
--bot7-ai=<value>LW6_BOT7_AIbot7-aiType: string
Default value: idiot
AI engine for bot number 7.
--bot7-color=<value>LW6_BOT7_COLORbot7-colorType: string
Default value: lightblue
Color for bot number 7.
--bot8-ai=<value>LW6_BOT8_AIbot8-aiType: string
Default value: idiot
AI engine for bot number 8.
--bot8-color=<value>LW6_BOT8_COLORbot8-colorType: string
Default value: purple
Color for bot number 8.
--bot9-ai=<value>LW6_BOT9_AIbot9-aiType: string
Default value: idiot
AI engine for bot number 9.
--bot9-color=<value>LW6_BOT9_COLORbot9-colorType: string
Default value: pink
Color for bot number 9.
--nb-bots=<value>LW6_NB_BOTSnb-botsType: integer
Default value: 2 Min value: 0 Max value: 9
Number of bots on the map. 0 means no bots, if set to 1 the the bot1-... settings will be used, if set to 2 then bot1-... and bot2-... will be used, and so on.
--player1-color=<value>LW6_PLAYER1_COLORplayer1-colorType: string
Default value: red
Color of the first player, must be red, green, blue, yellow, cyan, magenta, orange, lightblue, purple or pink
--player2-color=<value>LW6_PLAYER2_COLORplayer2-colorType: string
Default value: green
Color of the second player, must be red, green, blue, yellow, cyan, magenta, orange, lightblue, purple or pink
--player3-color=<value>LW6_PLAYER3_COLORplayer3-colorType: string
Default value: blue
Color of the third player, must be red, green, blue, yellow, cyan, magenta, orange, lightblue, purple or pink
--player4-color=<value>LW6_PLAYER4_COLORplayer4-colorType: string
Default value: yellow
Color of the fourth player, must be red, green, blue, yellow, cyan, magenta, orange, lightblue, purple or pink
--base64-decodeIf specified, program will take stdin and base64 decode it to stdout. This is for testing purpose (for network messages for instance). Will decode in standard base64 encoding using characters + and / but also the url-compliant version using - and /, see RFC 4648 for details.
--base64-encodeIf specified, program will take stdin and base64 encode it to stdout. This is for testing purpose (for network messages for instance). Will *not* use standard base64 encoding using characters + and / but - and _ instead to be url-compliant, see RFC 4648 for details.
--benchRuns a benchmarking test which will report an approximative performance estimation of the game on your computer.
--bench-value=<value>LW6_BENCH_VALUEbench-valueType: integer
Default value: 20
Contains the current bench value of the computer running the game. This is used internally to choose the right map settings. You can override this value and use your own but... use at your own risk. Pretending you have a faster computer than what you really have can lead to confusion.
--bin-id=<value>LW6_BIN_IDbin-idType: integer
Default value: 0
The internal 'bin-id' value. Note that this is not necessarly equal to the value returned by 'show-build-bin-id'. When they are different, it is assumed this is because of a software upgrade.
--checkRunning the game with '–check' is almost like running '–test', the difference is that '–check' will not run tests which involve graphics or sound backends, so it's adapted to pure console mode. This can be usefull for automated checks on a build farm, or if you want to check things in a headless (pure console) environment.
--commands-per-sec=<value>LW6_COMMANDS_PER_SECcommands-per-secType: integer
Default value: 10
Defines the number of commands per second. When a command is generated, orders are actually sent to the game engine, for instance, 'this cursor moved there'. So this option will affect game responsiveness, setting this to a high value will make the game more responsive but consume bandwidth on network games.
--daemonStart the game in daemon mode, this is typically used with the server mode, if you want the process to be detached from the console and executed in the background.
--debug-layer-id=<value>LW6_DEBUG_LAYER_IDdebug-layer-idType: integer
Default value: 0 Min value: 0 Max value: 6
A team id which will be used for debugging purposes, for instance when displaying gradient.
--debug-team-id=<value>LW6_DEBUG_TEAM_IDdebug-team-idType: integer
Default value: 0 Min value: 0 Max value: 9
A team id which will be used for debugging purposes, for instance when displaying gradient.
--dirty-read=<value>LW6_DIRTY_READdirty-readType: integer
Default value: 2 Min value: 0 Max value: 2
How to handle dirty reads and locks when displaying stuff. If set to 0, there will be no dirty reads at all, a lock (mutex) will be set whenever it's needed. If set to 1, display might be done with inconsistent data, however the data itself won't be modified while displaying. If set to 2, displayed data can (and will) be modified while the rendering thread is running.
--display-background=<value>LW6_DISPLAY_BACKGROUNDdisplay-backgroundType: boolean
Default value: true
Decides wether the background animation/image should be displayed at all.
--display-console=<value>LW6_DISPLAY_CONSOLEdisplay-consoleType: boolean
Default value: false
Defines wether the interactive system console must be displayed. Note that console support must have been enabled at compilation time. It might not be available on your computer, for instance if you are running a system such as Microsoft Windows.
--display-cursors=<value>LW6_DISPLAY_CURSORSdisplay-cursorsType: boolean
Default value: true
Debugging option which can be set to 'false' to disable the display of cursors when playing.
--display-debug-gradient=<value>LW6_DISPLAY_DEBUG_GRADIENTdisplay-debug-gradientType: boolean
Default value: false
Set this to 'true' to display the gradient, this is usefull to debug the core algorithm or understand how it works.
--display-debug-zones=<value>LW6_DISPLAY_DEBUG_ZONESdisplay-debug-zonesType: boolean
Default value: false
Set this to 'true' to display the zones, this is usefull to debug the core algorithm or understand how it works.
--display-fighters=<value>LW6_DISPLAY_FIGHTERSdisplay-fightersType: boolean
Default value: true
Debugging option which can be set to 'false' to disable the display of fighters when playing.
--display-fps=<value>LW6_DISPLAY_FPSdisplay-fpsType: boolean
Default value: false
Set this to 'true' to display the number of frames per second. When this gets too low... play a smaller map, buy a new computer or contribute and hack Liquid War 6 so that it runs faster!
--display-hud=<value>LW6_DISPLAY_HUDdisplay-hudType: boolean
Default value: true
Decides wether the hud (informations while playing) should be displayed.
--display-log=<value>LW6_DISPLAY_LOGdisplay-logType: boolean
Default value: true
Set this to 'false' to disable the display of error messages on the screen. Mote that you can miss valuable informations.
--display-map=<value>LW6_DISPLAY_MAPdisplay-mapType: boolean
Default value: true
Debugging option which can be set to 'false' to disable map (level) display when playing.
--display-menu=<value>LW6_DISPLAY_MENUdisplay-menuType: boolean
Default value: true
Debugging option which can be set to 'false' to disable the display of menus.
--display-meta=<value>LW6_DISPLAY_METAdisplay-metaType: boolean
Default value: true
Set to 'false' to disable the display of meta information, this includes the help, tootips and breadcrumbs in menus.
--display-mouse=<value>LW6_DISPLAY_MOUSEdisplay-mouseType: boolean
Default value: true
Set this to 'false' to always hide the mouse pointer.
--display-mps=<value>LW6_DISPLAY_MPSdisplay-mpsType: boolean
Default value: false
Set this to 'true' to display the number of moves per second. In theory the game should maintain this constant but in practise it can get low if your computer is too slow or too busy.
--display-preview=<value>LW6_DISPLAY_PREVIEWdisplay-previewType: boolean
Default value: true
Decides wether a map preview should be displayed when choosing a level.
--display-progress=<value>LW6_DISPLAY_PROGRESSdisplay-progressType: boolean
Default value: true
Decides wether a progress bar should be displayed when a long operation is realized as a background task.
--display-score=<value>LW6_DISPLAY_SCOREdisplay-scoreType: boolean
Default value: true
Decides wether the score screen should be displayed.
--display-splash=<value>LW6_DISPLAY_SPLASHdisplay-splashType: boolean
Default value: true
Set this to 'false' to disable the display of the splash screen at game startup.
--display-url=<value>LW6_DISPLAY_URLdisplay-urlType: boolean
Default value: false
Set this to 'true' to display the URL (homepage) of the game. This is mostly used when doing screenshots, so that generated images contain a link to the homepage.
--executed-again=<value>LW6_EXECUTED_AGAINexecuted-againType: boolean
Default value: false
This environment variable/keyword is used to detect wether the program has been launched by itself with an internal execv call. This is used as a workarround to set some environment variables (DYLD_LIBRARY_PATH on Mac OS X for instance) before the program is run, as sometimes using setenv() inside the program does not work.
--gfx-cpu-usage=<value>LW6_GFX_CPU_USAGEgfx-cpu-usageType: float
Default value: 0.75 Min value: 0 Max value: 1
Percentage of the CPU which will be used by the display thread. It's wise to leave some time to other threads to execute. The OS does it naturally, but setting this helps the whole process by explicitely pausing (sleep call) the display thread. You could change this to a low value if you have lagging games but smooth display.
--gfx-debug=<value>LW6_GFX_DEBUGgfx-debugType: boolean
Default value: false
Enables dedicated graphics debugging tools. This is different from 'debug' mode which is global, this one is really graphics specific.
--io-per-sec=<value>LW6_IO_PER_SECio-per-secType: integer
Default value: 20
Defines the number of calls to input/output functions per second. This can affect speed of menus but also cursors, but won't change the speed of the game itself. It's a cosmectic, comfort option.
--loader-sleep=<value>LW6_LOADER_SLEEPloader-sleepType: float
Default value: 0.5
Defines how long the loader thread should wait between two polls. Default value should fit in most cases.
--log-level=<value>LW6_LOG_LEVELlog-levelType: integer
Default value: 3 Min value: 0 Max value: 4
Defines the log level, that is, how verbose the program will be regarding logs and console output. 0 (ERROR) is the minimum, only errors are reported. 1 (WARNING) means errors + warnings. 2 (NOTICE) displays most important messages. 3 (INFO) is the default, the log file will contain all messages but debug stuff. 4 (DEBUG) logs everything, including debug informations.
--log-timeout=<value>LW6_LOG_TIMEOUTlog-timeoutType: integer
Default value: 5000
Delay, in msec, for which a log message will stay displayed on the screen.
--magic-number=<value>LW6_MAGIC_NUMBERmagic-numberType: integer
Default value: 14741
This 'magic' number probably requires an explanation. It's used to estimate how big a map can be built. The calculus is very approximative, basically bench_value*magic_number=total_fighters_on_map*rounds_per_sec*moves_per_round with total_fighters_on_map depending on various parameters such as map size but also how many fighters are on the map. The map loader will try and adjust the map size so that it is just big enough not to saturate your CPU while being as high-res as possible. The magic number in itself has no real meaning, the higher it gets, the more optimized it means the game is. Normally you shouldn't change this but if you find the map resizing is too agressively pessimistic, or if for some reason bench returns bogus values, you can modify it.
--max-local-bench-value=<value>LW6_MAX_LOCAL_BENCH_VALUEmax-local-bench-valueType: integer
Default value: 800
Even if your computer is very fast, this parameter will be used to tame the optimism of the test, and do not load maps in very high detail. It's believed at some point, it's best to keep your extra power to deal with unordinary situations rather than waste it on useless details. Game should be fun with that setting, but if you really want to use your shiny CPU at its maximum, raise this.
--max-network-bench-value=<value>LW6_MAX_NETWORK_BENCH_VALUEmax-network-bench-valueType: integer
Default value: 200
On network games, we need to be sure everyone can play in correct conditions, therefore maps won't be loaded with more details than this, by default. You're free to increase this parameter but it can cause your games to be unjoignable by some people.
--memory-bazooka-eraser=<value>LW6_MEMORY_BAZOOKA_ERASERmemory-bazooka-eraserType: boolean
Default value: true
The memory eraser is a tool which will systematically fill allocated memory with 'M', and overwrite all allocated bytes with 'F' before freeing memory. It will even handle realloc calls. This is usefull to track bugs. Indeed, with this option enabled, freshly allocated memory will never contain zeroes unless one calls calloc, and if you ever free some memory zone before being done with it, it will be filled with junk and therefore not be usable. The memory bazooka must be big enough if you want this feature to actually work.
--memory-bazooka-size=<value>LW6_MEMORY_BAZOOKA_SIZEmemory-bazooka-sizeType: integer
Default value: 99991
The memory bazooka is a brute-force tool, conceived after a full night spent tracking some memory leak. The idea is to keep a track of all allocated pointers, when the data was allocated (timestamp), where in the code (file, line), and even point out what data there is in that place. A memory bazooka report at the end of the game will just show what's left. There should be nothing. This parameter is here to avoid wasting CPU cycles on a feature which is very debug-oriented and does not really make sense for the casual user. Set it to 0 for best performance, something like 100 might just be helpfull, but 1000000 is the right way to seriously debug code.
--net-log=<value>LW6_NET_LOGnet-logType: boolean
Default value: false
Activates network log, that is, logs everything sent/received over the network, except data which is sent through a third party library such as libCurl. This is mostly for debugging purpose, it can lead to rather big log files.
--network-reliability=<value>LW6_NETWORK_RELIABILITYnetwork-reliabilityType: integer
Default value: 1000 Min value: 1 Max value: 1000000000
The program assumes network is non-reliable, however the problem with those assumptions is that when you test, network is always reliable, even with non-garanteed protocols like UDP. This option will force the program to actually ignore some calls to send or recv functions, simulating a network disfunction. This is to ensure the internal mecanisms correcting network problems do work for good, on daily regular use. It's not possible to set it to a perfect behavior, never dropping any packet, however using the default settings you probably won't even notice the performance drop induced by having to fix problems. The highest the number is, the most reliable network will look, the algorithm is simply to drop one message out of X.
--open-relay=<value>LW6_OPEN_RELAYopen-relayType: boolean
Default value: false
Enables forwarding of abritrary network messages. If open relay is forbidden, the game will only forward messages when physical sender and logical sender are the same. This is to say if messages come from A for C and is sent by A to B, B will forward it to C. But if message comes from X to C and is sent by A to B, then B won't forward it. In practice, it means without open relay, messages can only be forwarded once.
--pilot-lag=<value>LW6_PILOT_LAGpilot-lagType: integer
Default value: 10
Maximum lag, in rounds, until the game engine is slowed down. This will typically be usefull if your computer is too slow for the map resolution and the game speed you set up.
--quick-startStart the game just like if the player had requested a quick start, without showing any menu.
--resetClears the config file so that the game will run with defaults next time. The idea is to get rid of traces of previous executions. The difference with '–defaults' is that '–reset' does not run the game, while '–defaults' does.
--reset-config-on-upgrade=<value>LW6_RESET_CONFIG_ON_UPGRADEreset-config-on-upgradeType: boolean
Default value: true
If set, then a reset (config file set to defaults) is run every time you upgrade the game.
--serverStart the game in server mode, without requiring any graphics backend. Server mode is usefull if you just want to start a network node without hosting any real game on it. It can be used to list existing nodes and sessions or as a bounce server in case some clients can't contact each other because firewalled. If you only want to start a server game on your computer, don't use this option, just start the game normally and start a game server by clicking on the GUI buttons.
--simulate-basicSimulates some fights using the basic colors red, green, yellow and blue. Will output on the console a percentage based on scores obtained by the teams. This is typically for map designers and/or people who want to fiddle with team profiles, if some team is really stronger than another one, it should appear in these percentages.
--simulate-fullSimulates some fights using all available colors. This can be very long, it will run approximatively 1000 games consecutively, you can look in the log file to see the progress. Will output on the console a percentage based on scores obtained by the teams. This is typically for map designers and/or people who want to fiddle with team profiles, if some team is really stronger than another one, it should appear in these percentages.
--target-fps=<value>LW6_TARGET_FPStarget-fpsType: integer
Default value: 60
Defines how many frames will be displayed per second. Of course this is a maximum value, if your hardware can't keep up with this value, display will just be slow, no matter what value you define here. Note that you might really wish to have something rather low here, to keep network and 'logic' function responsiveness. Passed 60 frames per second, speed is really only for visual comfort, as Liquid War 6 is now so fast-paced that it requires 200 frames/sec to outperform opponents.
--trap-errors=<value>LW6_TRAP_ERRORStrap-errorsType: boolean
Default value: true
If set to true, will trap segmentation fault and floating point errors, and display messages about those in a custom box instead of the default one
--trojan=<value>LW6_TROJANtrojanType: boolean
Default value: false
Make the program act like a (stupid) trojan horse, trying to fake messages, sending various inconsistent informations. This is to check the normal version of the program is able to detect such a fake and kick it out of the game. It's of no use for regular players, be sure to unset this if you want to play for good.
--z-decodeIf specified, program will take stdin and z-decode it to stdout. This is for testing purpose (for network messages for instance). Z-decoding, here means verifying there a Z at the beginning, base64 decode and pass the content through Zlib inflating. I content is not Z-prefixed, will be returned as is.
--z-encodeIf specified, program will take stdin and z-encode it to stdout. This is for testing purpose (for network messages for instance). Z-encoding, here means passing the message through Zlib deflating then base64 encoding and prefix it with a Z.
c-gettextCalls GNU gettext to convert string in current locale. Note that '_' (plain underscode) is exported as well, so that code can be written using '_' as a function.
c-lw6cfg-unified-get-log-fileWrapper on lw6cfg_unified_get_log_file.
c-lw6cfg-unified-get-map-pathWrapper on lw6cfg_unified_get_map_path.
c-lw6cfg-unified-get-music-pathWrapper on lw6cfg_unified_get_music_path.
c-lw6cfg-unified-get-user-dirWrapper on lw6cfg_unified_get_user_dir.
c-lw6dsp-get-fullscreen-modesWrapper on lw6dsp_get_fullscreen_modes.
c-lw6dsp-get-last-frame-rendering-timeWrapper on lw6dsp_get_last_frame_rendering_time.
c-lw6gui-joystick1-get-move-padWrapper on lw6gui_joystick1_get_move_pad.
c-lw6gui-joystick1-pop-button-aWrapper on lw6gui_joystick1_pop_button_a.
c-lw6gui-joystick1-pop-button-bWrapper on lw6gui_joystick1_pop_button_b.
c-lw6gui-joystick1-pop-button-cWrapper on lw6gui_joystick1_pop_button_c.
c-lw6gui-joystick1-pop-button-dWrapper on lw6gui_joystick1_pop_button_d.
c-lw6gui-joystick1-pop-button-eWrapper on lw6gui_joystick1_pop_button_e.
c-lw6gui-joystick1-pop-button-fWrapper on lw6gui_joystick1_pop_button_f.
c-lw6gui-joystick1-pop-pad-downWrapper on lw6gui_joystick1_pop_pad_down.
c-lw6gui-joystick1-pop-pad-leftWrapper on lw6gui_joystick1_pop_pad_left.
c-lw6gui-joystick1-pop-pad-rightWrapper on lw6gui_joystick1_pop_pad_right.
c-lw6gui-joystick1-pop-pad-upWrapper on lw6gui_joystick1_pop_pad_up.
c-lw6gui-joystick2-get-move-padWrapper on lw6gui_joystick2_get_move_pad.
c-lw6gui-joystick2-pop-button-aWrapper on lw6gui_joystick2_pop_button_a.
c-lw6gui-joystick2-pop-button-bWrapper on lw6gui_joystick2_pop_button_b.
c-lw6gui-joystick2-pop-button-cWrapper on lw6gui_joystick2_pop_button_c.
c-lw6gui-joystick2-pop-button-dWrapper on lw6gui_joystick2_pop_button_d.
c-lw6gui-joystick2-pop-button-eWrapper on lw6gui_joystick2_pop_button_e.
c-lw6gui-joystick2-pop-button-fWrapper on lw6gui_joystick2_pop_button_f.
c-lw6gui-joystick2-pop-pad-downWrapper on lw6gui_joystick2_pop_pad_down.
c-lw6gui-joystick2-pop-pad-leftWrapper on lw6gui_joystick2_pop_pad_left.
c-lw6gui-joystick2-pop-pad-rightWrapper on lw6gui_joystick2_pop_pad_right.
c-lw6gui-joystick2-pop-pad-upWrapper on lw6gui_joystick2_pop_pad_up.
c-lw6gui-keyboard-get-move-padWrapper on lw6gui_keyboard_get_move_pad.
c-lw6gui-keyboard-pop-arrow-downWrapper on lw6gui_keyboard_pop_arrow_down.
c-lw6gui-keyboard-pop-arrow-leftWrapper on lw6gui_keyboard_pop_arrow_left.
c-lw6gui-keyboard-pop-arrow-rightWrapper on lw6gui_keyboard_pop_arrow_right.
c-lw6gui-keyboard-pop-arrow-upWrapper on lw6gui_keyboard_pop_arrow_up.
c-lw6gui-keyboard-pop-key-altWrapper on lw6gui_keyboard_pop_key_alt.
c-lw6gui-keyboard-pop-key-ctrlWrapper on lw6gui_keyboard_pop_key_ctrl.
c-lw6gui-keyboard-pop-key-enterWrapper on lw6gui_keyboard_pop_key_enter.
c-lw6gui-keyboard-pop-key-escWrapper on lw6gui_keyboard_pop_key_esc.
c-lw6gui-keyboard-pop-key-pgdownWrapper on lw6gui_keyboard_pop_key_pgdown.
c-lw6gui-keyboard-pop-key-pgupWrapper on lw6gui_keyboard_pop_key_pgup.
c-lw6gui-menu-set-breadcrumbsWrapper on lw6gui_menu_set_breadcrumbs.
c-lw6gui-mouse-pop-button-leftWrapper on lw6gui_mouse_pop_button_left.
c-lw6gui-mouse-pop-button-middleWrapper on lw6gui_mouse_pop_button_middle.
c-lw6gui-mouse-pop-button-rightWrapper on lw6gui_mouse_pop_button_right.
c-lw6gui-mouse-pop-double-clickWrapper on lw6gui_mouse_pop_double_click.
c-lw6gui-mouse-pop-simple-clickWrapper on lw6gui_mouse_pop_simple_click.
c-lw6gui-mouse-pop-triple-clickWrapper on lw6gui_mouse_pop_triple_click.
c-lw6gui-mouse-pop-wheel-downWrapper on lw6gui_mouse_pop_wheel_down.
c-lw6ker-game-struct-checksumWrapper on lw6ker_game_struct_checksum.
c-lw6map-exp-get-unlocked-team-colorWrapper on lw6map_exp_get_unlocked_team_color.
c-lw6map-exp-get-unlocked-weaponWrapper on lw6map_exp_get_unlocked_weapon.
c-lw6map-exp-is-team-color-allowedWrapper on lw6map_exp_is_team_color_allowed.
c-lw6map-exp-is-weapon-allowedWrapper on lw6map_exp_is_weapon_allowed.
c-lw6map-team-color-index-to-keyWrapper on lw6map_team_color_index_to_key.
c-lw6map-team-color-index-to-labelWrapper on lw6map_team_color_index_to_label.
c-lw6map-team-color-key-to-indexWrapper on lw6map_team_color_key_to_index.
c-lw6map-weapon-index-to-labelWrapper on lw6map_weapon_index_to_label.
c-lw6pil-get-reference-current-seqWrapper on lw6pil_get_reference_current_seq.
c-lw6pil-get-reference-target-seqWrapper on lw6pil_get_reference_target_seq.
c-lw6pil-local-cursors-set-mainWrapper on lw6pil_local_cursors_set_main.
c-lw6pil-local-cursors-set-mouse-controlledWrapper on lw6pil_local_cursors_set_mouse_controlled.
c-lw6sys-build-get-configure-argsWrapper on lw6sys_build_get_configure_args.
c-lw6sys-build-get-enable-allinoneWrapper on lw6sys_build_get_enable_allinone.
c-lw6sys-build-get-enable-consoleWrapper on lw6sys_build_get_enable_console.
c-lw6sys-build-get-enable-fullstaticWrapper on lw6sys_build_get_enable_fullstatic.
c-lw6sys-build-get-enable-gcovWrapper on lw6sys_build_get_enable_gcov.
c-lw6sys-build-get-enable-gprofWrapper on lw6sys_build_get_enable_gprof.
c-lw6sys-build-get-enable-gtkWrapper on lw6sys_build_get_enable_gtk.
c-lw6sys-build-get-enable-instrumentWrapper on lw6sys_build_get_enable_instrument.
c-lw6sys-build-get-enable-mod-csoundWrapper on lw6sys_build_get_enable_mod_csound.
c-lw6sys-build-get-enable-mod-glWrapper on lw6sys_build_get_enable_mod_gl.
c-lw6sys-build-get-enable-mod-httpWrapper on lw6sys_build_get_enable_mod_http.
c-lw6sys-build-get-enable-mod-oggWrapper on lw6sys_build_get_enable_mod_ogg.
c-lw6sys-build-get-enable-openmpWrapper on lw6sys_build_get_enable_openmp.
c-lw6sys-build-get-enable-optimizeWrapper on lw6sys_build_get_enable_optimize.
c-lw6sys-build-get-enable-paranoidWrapper on lw6sys_build_get_enable_paranoid.
c-lw6sys-build-get-enable-profilerWrapper on lw6sys_build_get_enable_profiler.
c-lw6sys-build-get-enable-valgrindWrapper on lw6sys_build_get_enable_valgrind.
c-lw6sys-build-get-endiannessWrapper on lw6sys_build_get_endianness.
c-lw6sys-build-get-gcc-versionWrapper on lw6sys_build_get_gcc_version.
c-lw6sys-build-get-includedirWrapper on lw6sys_build_get_includedir.
c-lw6sys-build-get-package-nameWrapper on lw6sys_build_get_package_name.
c-lw6sys-build-get-package-stringWrapper on lw6sys_build_get_package_string.
c-lw6sys-build-get-package-tarnameWrapper on lw6sys_build_get_package_tarname.
c-lw6sys-build-get-pointer-sizeWrapper on lw6sys_build_get_pointer_size.
c-lw6sys-build-get-top-srcdirWrapper on lw6sys_build_get_top_srcdir.
c-lw6sys-get-default-config-fileWrapper on lw6sys_get_default_config_file.
c-lw6sys-get-default-data-dirWrapper on lw6sys_get_default_data_dir.
c-lw6sys-get-default-log-fileWrapper on lw6sys_get_default_log_file.
c-lw6sys-get-default-map-pathWrapper on lw6sys_get_default_map_path.
c-lw6sys-get-default-music-dirWrapper on lw6sys_get_default_music_dir.
c-lw6sys-get-default-music-pathWrapper on lw6sys_get_default_music_path.
c-lw6sys-get-default-script-fileWrapper on lw6sys_get_default_script_file.
c-lw6sys-get-default-user-dirWrapper on lw6sys_get_default_user_dir.
c-lw6sys-openmp-get-num-procsWrapper on lw6sys_openmp_get_num_procs.
c-lw6sys-set-memory-bazooka-eraserWrapper on lw6sys_set_memory_bazooka_eraser.
c-lw6sys-set-memory-bazooka-sizeWrapper on lw6sys_set_memory_bazooka_size.
This chapter contains a description of all modules and a list of all documented C functions in the program. It contains many references and is self-generated from C comments using gdoc by Simon Josefsson.
In order to reduce the number of pages of printed output, this complete reference is, by default, disabled in printable versions of the documentation (PostScript, PDF). This is both to make the manual more readable and to avoid wasting paper. Think about the environment.
It is however available in the HTML version of the documentation, which you can read online on http://www.gnu.org/software/liquidwar6/manual/html_node/.
Additionnally, the following adresses contain various view on the source code, giving informations on all the internal and public C interfaces:
./liquidwar6 --test.
It shows what functions are actually tested, and how many times they are called.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/index.html.
video_mode: the new video mode
This callback is here because gfx needs to update the config when the screen is resized. But... we did not want to make gfx depend on cfg "directly". It's cleaner to pass parameters with Scheme, in the long run, it should make things easier. So this callback is the solution. Another side effect is that this way there's a tangible obvious trace of this updating of config status by the gfx module. Seeing it sticking out like a thumb isn't a bad thing.
Return value: none
Functions which will call
quit(),free(),destroy() on whatever smob object that has threads and/or requires hardware ressources. This is to be called before the Guile interpreter ends. This is because when it garbage collects objects at the end of the program, it has no idea of what order to use when freeing objects. So if an object which uses another one in a thread is freed after the other is freed, you get a (rather unexplainabled if not warned) segfault.Return value: none
argc: number of args as passed to main argv: array of strings as passed to main
Fixes environment variables (path related) so that program can find its requirements. This must be called early in the program flow (else other calls might fail).
Return value: 1 if success, 0 if failure
Register all the functions, make them callable from Guile. This is a very simple yet long and very usefull function, without it Guile has no knowledge of what LW6 is.
Return value: 1 on success, 0 if failed.
c_line: the line typed by the user
This function will be called every time a message is typed on the console. It runs the given line in the current Guile environment.
Return value: none
argc: number of args as passed to main argv: array of strings as passed to main
Initializes global values to their defaults.
Return value: 1 on success, 0 if failed
argc: number of args as passed to main argv: array of strings as passed to main
Frees global values. Will also garbage collect objects in case Guile failed to do it perfectly (or we failed to tell Guile how to do it).
Return value: none.
argc: the argc parameter of the
main() function, that is, the number of command-line args.argv: the argv parameter of the
main() function, that is, an array containing pointers on command-line args.This function is directly called by
main(). This means by linking against libliquidwar6 and calling it, you would have a program that is almost exactly the "official" upstream liquidwar6 binary, except you can tweak it and have all the power to call whatever other functions you like, embed it. In short, everything the binary does, you can do it in your own binarn, by linking against the library and calling this function.Return value: 1 if success, zero if failure. Note that this is the "standard" C / liquidwar6 way to proceed, but your
main() function should return 0 if success, else an error code. Typical use is "return !lw6_main(argc, argv);".
argc: the number of command-line args, as passed to
main()argv: an array of strings containing command-line args, as passed to
main()run_game: a pointer to a boolean which will contain true (1) if the game must be launched, or false (0) if the option is such that game must be skipped. Example: –copyright, –help, ...
Return value: non-zero if success, 0 if error. The error can be, for instance, the test suite returning "no, tests were not OK".
Displays the copyright of the game (short version).
Return value: none
Displays the copyright of the game (long version).
Return value: none
Displays the program bench value.
Return value: none
Displays the program pedigree, think of this as version on steroids.
Return value: none
Displays the host on which the program was compiled.
Return value: none
Displays various paths used by the game.
Return value: none
Displays the list of modules compiled with the game.
Return value: none
Displays the list of 'players' options.
Return value: none
Displays the list of 'graphics' options.
Return value: none
Displays the list of 'network' options.
Return value: none
Displays the list of 'map rules' options.
Return value: none
Displays the list of 'map hints' options.
Return value: none
Displays the list of 'map style' options.
Return value: none
Displays the list of 'map teams' options.
Return value: none
Displays the list of 'advanced' options.
Return value: none
Displays the about message for a keyword.
Return value: none
Displays 'hello' at the beginning of the program.
Return value: none
Displays 'goodbye', typically use at end of program to know it's over and everything went fine.
Return value: none
c_dsp: the display object
Creates an SCM 'dsp' object from C data.
Return value: the SCM object
dsp: the dsp to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'dsp' object.
Return value: a pointer, *not* a copy, must not be freed
dsp_smob: the smob to free
Frees a dsp smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_snd: the sound object
Creates an SCM 'snd' object from C data.
Return value: the SCM object
snd: the snd to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'snd' object.
Return value: a pointer, *not* a copy, must not be freed
snd_smob: the smob to free
Frees a snd smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_map: the map object
Creates an SCM 'map' object from C data.
Return value: the SCM object
map: the map to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'map' object.
Return value: a pointer, *not* a copy, must not be freed
map_smob: the smob to free
Frees a map smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_menu: the menu object
Creates an SCM 'menu' object from C data.
Return value: the SCM object
menu: the menu to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'menu' object.
Return value: a pointer, *not* a copy, must not be freed
menu_smob: the smob to free
Frees a menu smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_game_struct: the game struct object
map: the map (SCM object) referenced
Creates an SCM 'game-struct' object from C data. Passing the map object enables the garbage collector not to free the map until the game struct is freed.
Return value: the SCM object
game_struct: the game_struct to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'game_struct' object.
Return value: a pointer, *not* a copy, must not be freed
game_struct_smob: the smob to free
Frees a game_struct smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_game_state: the game state object
game_struct: the game struct (SCM object) referenced
Creates an SCM 'game_state' object from C data. Passing game_struct enables the garbage collector not to free the game_struct until the game_state is freed.
Return value: the SCM object
game_state: the game_state to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'game_state' object.
Return value: a pointer, *not* a copy, must not be freed
game_state_smob: the smob to free
Frees a game_state smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_pilot: the pilot object
Creates an SCM 'pilot' object from C data.
Return value: the SCM object
pilot: the pilot to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'pilot' object.
Return value: a pointer, *not* a copy, must not be freed
pilot_smob: the smob to free
Frees a pilot smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_bot: the bot object
game_state: the game state
pilot: the pilot
Creates an SCM 'bot' object from C data. Passing game_state and pilot enables the garbage collector not the free them until bot is freed.
Return value: the SCM object
bot: the bot to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'bot' object.
Return value: a pointer, *not* a copy, must not be freed
bot_smob: the smob to free
Frees a bot smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_look: the look object
Creates an SCM 'look' object from C data.
Return value: the SCM object
look: the look to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'look' object.
Return value: a pointer, *not* a copy, must not be freed
look_smob: the smob to free
Frees a look smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_loader: the loader object
Creates an SCM 'loader' object from C data.
Return value: the SCM object
loader: the loader to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'loader' object.
Return value: a pointer, *not* a copy, must not be freed
loader_smob: the smob to free
Frees a loader smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_db: the database object
Creates an SCM 'db' object from C data.
Return value: the SCM object
db: the db to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'db' object.
Return value: a pointer, *not* a copy, must not be freed
db_smob: the smob to free
Frees a db smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
c_node: the node object
db: the db (SCM object) referenced
Creates an SCM 'node' object from C data. Passing db enables the garbage collector not to free db until node is freed.
Return value: the SCM object
node: the node to convert (SCM object)
Gets the internal C pointer corresponding to the scheme 'node' object.
Return value: a pointer, *not* a copy, must not be freed
node_smob: the smob to free
Frees a node smob, we need a special function to do that as structures like assoc hold pointers to these objects and therefore need a proper callback when being destroyed.
Return value: none
Register all smobs to Guile.
Return value: 1 on success, 0 if failed.
mode: 0 for check only, 1 for full test
Runs the liquidwar6 core module test suite, this will mostly test how Guile script integration works, loading a sample script and running it. It does not launch all the other sub modules tests.
Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/bot/index.html.
backend: backend to use
seed: parameters required to build bot (game state, among other things)
Initializes a bot object. Must be performed before any other call. The seed is absolutely required, for a bot really needs to know what map/context it's working on, including at creation time
Return value: 1 on success, 0 on failure.
backend: unitialize a bot backend
Closes a bot, but does not free all ressources.
backend: bot to work on
x: next x position (out param)
y: next y position (out param)
Queries the bot for its next move, this is actually the one interesting function in the whole bot API.
Return value: 1 on success, 0 on failure.
backend: bot to represent
Gives a human readable representation of bot
Return value: dynamically allocated string.
argc: argc, as passed to
mainargv: argv, as passed to
mainList available bot backends. The hash contains pairs with id and name for each backend. The id is the technical key you can use to load the backend, the name is something more readable you can display in an interface. The backend objects themselves are not instanciated by this (in fact, they are, but released on the fly) you need to load and initialize them afterwards.
Return value: hash containing id/name pairs.
argc: argc, as passed to
mainargv: argv, as passed to
mainname: string containing bot key, typically got from
lw6bot_get_backendsCreates a bot backend, this is just about loading the dynamic library if needed, and/or check bot engine is available, and connect to it. It does not perform initialization.
Return value: bot backend.
backend: bot backend to destroy
Frees the ressources associated to a bot, which must have been properly uninitialized before.
Return value: none.
mode: 0 for check only, 1 for full test
Runs the
botmodule test suite. Will try several engines and query basic moves.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/bot/mod-brute/index.html.
Defined to tell mod_brute is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-brute, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-brute backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/bot/mod-follow/index.html.
Defined to tell mod_follow is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-follow, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-follow backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/bot/mod-idiot/index.html.
Defined to tell mod_idiot is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-idiot, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-idiot backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/bot/mod-random/index.html.
Defined to tell mod_random is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-random, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-random backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cfg/index.html.
context: opaque pointer on a context
Overwrites any existing option with command line args
Return value: 1 if success, 0 if error
context: opaque pointer on a context
Sets all values to their defaults.
Return value: 1 if success, 0 if error
cfg_context: a context returned by
lw6cfg_initOverwrites any existing vale in the config with environment variables prefixed by LW6_.
Return value: 1 if successfull, 0 if error.
user_dir: the user directory
exp: the exp (out param)
Gets exp from file.
Return value: 1 on success, 0 on failure
user_dir: the user directory
exp: the exp
Saves exp to file.
Return value: 1 on success, 0 on failure
key: the key of the value to format
value: the value to format
type: the type of the value to format
Formats, converts, a given value to its cannonical representation. Booleans will be converted to true/false, strings containing integers will be stripped from junk, and so on. This is a performance killer but will ensure everything is correct.
Return value: a newly allocated string, containing the same as the input, but reformatted the pedantic way.
key: the key of the value to format
value: the value to format
Formats, converts, a given value to its cannonical representation. Booleans will be converted to true/false, strings containing integers will be stripped from junk, and so on. This is a performance killer but will ensure everything is correct. This function will automatically guess the type of the value from its description in the help system.
Return value: a newly allocated string, containing the same as the input, but reformatted the pedantic way.
cfg_context: a context returned by
lw6cfg_initfilename: a file path, absolute or relative
Loads the given config file, and stores its values into the current context. Parameters which are both in the config file and given as command line parameters, will be taken from the command-line.
Return value: 1 if successfull, 0 if error.
context: context to query
key: key to search
Returns wether a key exists within context or not.
Return value: 1 if exists, 0 if not
context: context to query
key: key to search
Returns the current value for a given query, the returned value is always a string, typically the string one would pass on the command line or set in a config file
Return value: pointer to string, must not be freed.
context: context to modify
key: key to search and change
value: new value
Sets a given key to the specified value, this is a string only function, pass the value you would pass on the command line or set in a config file.
Return value: none
context: context to query
key: key to search
Returns an option as an integer. Note that this function does not know wether the parameter should really be an integer or not, so you can call it even on non-integer values, but of course results will have no real meaning.
Return value: option value converted to int
context: context to modify
key: key to search and change
value: new value
Set a config option to an integer value. Note that this function does not know wether the parameter should really be an integer or not, so you can call it even on non-integer values, at your own risk.
Return value: none.
context: context to query
key: key to search
Returns an option as a boolean. Note that this function does not know wether the parameter should really be a boolean or not, so you can call it even on non-boolean values, but of course results will have no real meaning.
Return value: option value converted to boolean
context: context to modify
key: key to search and change
value: new value
Set a config option to a boolean value. Note that this function does not know wether the parameter should really be a boolean or not, so you can call it even on non-boolean values, at your own risk.
Return value: none.
key: key to test
Tells wether a key should be saved in the config file. Typically, some options you don't want to savem such as the location of the config file itself. Most of those non-savable parameters are path-related. This does not mean no paths are saved in the config file.
Return value: 1 if must be saved, 0 if not
cfg_context: a context returned by
lw6cfg_initfilename: a file path, absolute or relative
Save current options into the given config file. Before saving the file, all command line arguments will be read and will override current values. This means the saved file will contain values given as command line arguments.
Return value: 1 if successfull, 0 if error.
argc: number of command line arguments, as given to
mainargv: a list of command line arguments, as given to
mainInitializes a config context object. This object is hidden behind an opaque void * pointer to avoid direct access to its elements.
Return value: an opaque pointer, must be freed with
lw6cfg_quit.
cfg_context: a context returned by
lw6cfg_initFrees a config cfg_context object. You must call this once you're done with the context.
Return value: none.
argc: number of command line arguments, as given to
mainargv: a list of command line arguments, as given to
mainOverwrites the config file with defaults. Use this to get rid of old configurations.
mode: 0 for check only, 1 for full test
Runs the
cfgmodule test suite.Return value: 1 if test is successfull, 0 on error.
argc: number of command-line args, as passed to
mainargv: arry of command-line args, as passed to
mainkey: the key to query
Unified "value" getter, which gets informations from environment variables, command line, and config file. The rules is that the command-line argument always has the last word. It will override any other value. Follows environment variables, which will be used if no command-line argument is supplied. Note that these are "LW6_" prefixed and uppercased environment variables as opposed to lowercased and "dash-separated" keys. Finally, if there's no environment variable, nor any config-file corresponding entry, the value will be searched in the config file. If there's no information in the config file, NULL is returned.
Return value: a string with the value. Can be NULL. Must be freed.
argc: number of command-line args, as passed to
mainargv: arry of command-line args, as passed to
mainGets the user dir, taking all parameters in account, that's to say the "LW6_USER_DIR" env value, the "–user-dir" command-line paramater and the LW6DEF_USER_DIR config file entry.
Return value: the directory path, might be NULL, must be freed.
argc: number of command-line args, as passed to
mainargv: arry of command-line args, as passed to
mainGets the log file, taking all parameters in account, that's to say the "LW6_LOG_FILE" env value, the "–log-file" command-line paramater and the LW6DEF_LOG_FILE config file entry.
Return value: the directory path, might be NULL, must be freed.
argc: number of command-line args, as passed to
mainargv: arry of command-line args, as passed to
mainGets the user dir, taking all parameters in account, that's to say the "LW6_MUSIC_PATH" env value, the "–music-path" command-line paramater and the LW6DEF_MUSIC_PATH config file entry.
Return value: the directory path, might be NULL, must be freed.
argc: number of command-line args, as passed to
mainargv: arry of command-line args, as passed to
mainGets the user dir, taking all parameters in account, that's to say the "LW6_MAP_PATH" env value, the "–map-path" command-line paramater and the LW6DEF_MAP_PATH config file entry.
Return value: the directory path, might be NULL, must be freed.
type: type as an enum
Returns the string corresponding to a given type, suitable for use in XML files. For instance if you pass
LW6HLP_TYPE_INTthen you will obtain the string int (string of 3 chars containing i, n and t.Return value: string, must not be freed.
xml_key: key found in XML file
xml_value: value found in XML file
target_key: key we're searching for
value: the value if found (out param)
Tries to find a value in a key/value pair. If
xml_keyandtarget_keymatch, then will put the corresponding value (converted to int) in thevalueparam. Typically, you would call this in a loop on every single entry found in an XML file, in an expat callback.Return value: none.
xml_key: key found in XML file
xml_value: value found in XML file
target_key: key we're searching for
value: the value if found (out param)
Tries to find a value in a key/value pair. If
xml_keyandtarget_keymatch, then will put the corresponding value (converted to boolean) in thevalueparam. Typically, you would call this in a loop on every single entry found in an XML file, in an expat callback.Return value: none.
xml_key: key found in XML file
xml_value: value found in XML file
target_key: key we're searching for
value: the value if found (out param)
Tries to find a value in a key/value pair. If
xml_keyandtarget_keymatch, then will put the corresponding value (converted to float) in thevalueparam. Typically, you would call this in a loop on every single entry found in an XML file, in an expat callback.Return value: none.
xml_key: key found in XML file
xml_value: value found in XML file
target_key: key we're searching for
value: the value if found (out param)
Tries to find a value in a key/value pair. If
xml_keyandtarget_keymatch, then will put the corresponding value (as a string) in thevalueparam. Typically, you would call this in a loop on every single entry found in an XML file, in an expat callback.Return value: none.
xml_key: key found in XML file
xml_value: value found in XML file
target_key: key we're searching for
value: the value if found (out param)
Tries to find a value in a key/value pair. If
xml_keyandtarget_keymatch, then will put the corresponding value (converted to a color) in thevalueparam. Typically, you would call this in a loop on every single entry found in an XML file, in an expat callback.Return value: none.
filename: full path of file to read
callback_func: callback function to be called on each element
callback_data: additionnal pointer passed to callback function
Will parse a file and call the given callback on each element. This is an over-simplified way to read XML file, in fact we just explain plain non-nested simple elements but this is exactly what LW config files are made of.
Return value: 1 on success, 0 on failure.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes an int entry into an opened XML file.
Return value: none.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes a boolean entry into an opened XML file.
Return value: none.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes a float entry into an opened XML file.
Return value: none.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes a string entry into an opened XML file.
Return value: none.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes a color entry into an opened XML file.
Return value: none.
f: file to write data to (append mode)
key: key to write
value: value to write
Writes an entry into an opened XML file, will try and guess type from the internal help system, typically, if this is a standard config file entry (the one documented by the about command line function) it will pick up the right type. The reason not to use this all the times is that sometimes, one might to to store non-standard options, and additionnally, guessing the type does consume some CPU.
Return value: none.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cli/index.html.
backend: backend to use
Initializes a client backend. Must be performed before any other call.
Return value: 1 on success, 0 on failure
backend: unitialize a cli backend
Closes a cli, but does not free all ressources.
backend: backend to use
node_info: information on the current node
oob_data: data of the out-of-band request
Processes the required out-of-band tasks, this typically, for a client, includes broadcasting. Depending on parameters passed in oob_data, might actually do a broadcast or simply call a given host and see what's the answer. A typicall exchange is PING then INFO and finally LIST. It's the responsability of the client to take the OOB initiative and contact the server.
Return value: 1 on success, 0 on failure.
backend: backend to use
local_url: our local public url
remote_url: the remote url we want to connect to
remote_ip: remote IP address
remote_port: remote IP port
password: password to use (if needed)
local_id: our local id
remote_id: the remote id
dns_ok: wether the remote announced URL matches DNS information
network_reliability: network reliability (the highest, the better)
recv_callback_func: callback func to be called when data is received
recv_callback_data: pointer on additionnal data to pass to callback func
Opens a connection with a remote host. Be carefull with the implementation of
recv_callback_func, it should be at least reentrant, and when it accesses shared data, use locks.Return value: new object.
backend: backend to use
connection: connection to use
Closes a connection, this will free the connection object.
Return value: none.
backend: backend to use
connection: connection to use
physical_ticket_sig: signature of physical sender
logical_ticket_sig: signature of logical sender
logical_from_id: id of logical sender
logical_to_id: id of logicial target
message: text of message to send
Sends a message to a peer over a given connection.
Return value: 1 on success, 0 on failure.
backend: backend to use
connection: connection to use
Performs required duty on connection, depending on the backend, this can include sending messages and/or receiving them. Must be called on a regular basis.
Return value: none.
backend: backend to use
connection: connection to represent
Gives a human readable representation of the connection.
Return value: dynamically allocated string.
public_url: the address of the distant server to test
verify_callback_func: a function which will be called when a node has been verified
verify_callback_data: additionnal data passed to the callback func
Create a new OOB structure, copying required objects. We need to make copies for this is for usage in a separate thread. The thread member is not set here since the right way to do things is first to set up data then to fire the thread.
Return value: new object
oob: the object to free
Frees an OOB structure.
Return value: none
Returns the list of the default cli backends.
Return value: comma separated string, must not be freed.
argc: argc, as passed to
mainargv: argv, as passed to
mainList available cli backends. The hash contains pairs with id and name for each backend. The id is the technical key you can use to load the backend, the name is something more readable you can display in an interface. The backend objects themselves are not instanciated by this (in fact, they are, but released on the fly) you need to load and initialize them afterwards.
Return value: hash containing id/name pairs.
argc: argc, as passed to
mainargv: argv, as passed to
mainname: string containing cli key, typically got from
lw6cli_get_backendsCreates a cli backend, this is just about loading the dynamic library if needed, and/or check cli engine is available, and connect to it. It does not perform initialization.
Return value: cli backend.
backend: backend to destroy
Destroys a cli backend.
Return value: none.
mode: 0 for check only, 1 for full test
Runs the
climodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cli/mod-http/index.html.
Defined to tell mod_http is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-http, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-http backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cli/mod-tcp/index.html.
Defined to tell mod_tcp is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-tcp, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-tcp backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cli/mod-udp/index.html.
Defined to tell mod_udp is compatible with GNU General Public License. Of course it is. This function does nothing, but the fact it's declared makes its GPL compatibility obvious. Having this declared is required.
Return value: none
Returns the pedigree for mod-udp, giving details about the module, including name, description, licence, date/time of compilation.
Return value: dynamically allocated object.
Creates a mod-udp backend.
Return value: backend pointer.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cns/index.html.
callback: handler function.
Installs a console handler.
Return value: none.
Polling function for console, must be called on a regular basis.
Return value: none.
line: line to add
Adds a line to the console history, won't add it if it's NULL or empty.
Return value: none.
Tells wether console is supported.
Return value: 1 if console can be enabled, 0 if not
mode: 0 for check only, 1 for full test
Runs the
cnsmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/cnx/index.html.
local_url: the local public URL
remote_url: the remote public URL
remote_ip: the remote IP address
remote_port: the remote port
password: the password to use
local_id: the local ID
remote_id: the remote ID
dns_ok: 1 if no DNS mismatch, 0 if IP does not match public URL
network_reliability: drop 1 out of X packets
recv_callback_func: a callback to call when data is received
recv_callback_data: additionnal data to pass to the callback
Create a connection object. This object in itself does nothing, it's just to share common structures among modules, more precisely, between cli and srv code. It's the responsability off the caller/backend to handle the
backend_specific_datafield which is NULL after this call.Return value: newly allocated object.
connection: object to free
Frees a connection object. It's the responsibility of the caller/backend to handle the
backend_specific_datafield.Return value: none.
connection: the connection concerned
now: the current timestamp
Tells wether a new foo message must be issued.
Return value: 1 if true, 0 if false.
connection: the connection concerned
now: the current timestamp
next_foo_delay: the delay (msec) before next foo message is sent
Generates a new foo_bar_key, and schedules the next foo message send timestamp.
Return value: none.
connection: the connexion to lock
Acquires a "send" lock on the connexion, the idea is to avoid too threads sending data using the same socket at the same time. Note that each backend must call this when accessing the socket, there's no top-level lock for the sake of performance.
Return value: 1 on success, 0 if not.
connection: the connexion to lock
Releases a "send" lock on the connexion, the idea is to avoid too threads sending data using the same socket at the same time. Note that each backend must call this when accessing the socket, there's no top-level lock for the sake of performance.
Return value: none.
connection: the connexion concerned
Will filter and return true only in "rare" cases when packets must be artificially dropped for testing purpose.
Return value: 1 if message must be sent/received, 0 if not
seed: a seed to blur the password, can be NULL
password: the password, can be NULL
Calculates the checksum of a password, and returns it as a string, ready to be sent on the network. If password is empty or NULL, then an empty (but not NULL unless internal error) string will be returned. All LW6 protocols should send these checksums instead of real passwords, then on server side value can be checked against both real password and its checksum. The seed is here so that eavesdropper can't reuse the checksum to connect on random sessions. Seed can typically be the node 'public_url' value.
Return value: a dynamically allocated string
seed: a seed to blur the password, can be NULL
password_here: the local password, can be NULL
password_received: the password received from network, can be NULL
Tells wether a password received over the network is valid. The
password_hereargument (the local password) will be checksumed so thatpassword_receivedis checked against both clear and checksumed values, so it can be in any form.Return value: 1 if OK, passwords are the same, 0 if not.
mode: 0 for check only, 1 for full test
Runs the
cnxmodule test suite.Return value: 1 if test is successfull, 0 on error.
ticket_table: the ticket table to fill with zero
Fills the ticket table struct with 0s.
Return value: none.
ticket_table: the ticket table to init
hash_size: the hash size for both recv/send hashs
Initialize a ticket table, that is, set it up with two empty hashs. Recv hash is filled automatically as it's queried for tickets, send hash must be filled explicitely with info from the network.
Return value: none.
ticket_table: the ticket table to clear
Clears the object (frees memory).
Return value: none.
ticket_table: the ticket table to query
peer_id: the id of remote node
Gets the ticket used to communicate with peer, to check its incoming (recv) messages. If ticket does not exist yet, it's automatically generated so tunction will always return a non-zero value.
Return value: the ticket used to check incoming messages.
ticket_table: the ticket table to query
peer_id: the id of remote node
Acknowledges the ticket used to communicate with peer, to check its incoming (recv) messages has been received. This is to avoid sending it again when it has been received, as it's kept "forever" by peer, we never need to send it again.
Return value: none.
ticket_table: the ticket table to query
peer_id: the id of remote node
Acknowledges the ticket used to communicate with peer, to check its incoming (recv) messages has been received. This is to avoid sending it again when it has been received, as it's kept "forever" by peer, we never need to send it again.
Return value: the ticket used to check incoming messages.
ticket_table: the ticket table to query
peer_id: the id of remote node
Gets the ticket used to communicate with peer, to stamp the outgoing messages. If ticket does not exist yet, 0 is returned, indeed this value must be initialized with the value the peer gives us.
Return value: the ticket used to stamp outgoing messages.
ticket_table: the ticket table to query
peer_id: the id of remote node
send_ticket: the ticket to use to stamp outgoing messages
Sets the ticket used to communicate with peer, to stamp the outgoing (send) messages. This value should be received from the network. Note that once it's set, it's impossible to change it, it will remain the same for the whole duration of the node existence.
Return value: NULL
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/dat/index.html.
mode: 0 for check only, 1 for full test
Runs the
datmodule test suite.Return value: 1 if test is successfull, 0 on error.
Creates a new warehouse object.
Return value: new object, allocated dynamically
warehouse: the object to free
Frees a warehouse object.
Return value: new object, allocated dynamically
warehouse: the object to purge
Purges a warehouse object.
Return value: new object, allocated dynamically
warehouse: the warehouse object to query.
Tells how many nodes are registered in the object.
Return value: integer, number of nodes
warehouse: the warehouse object to query.
Returns the local id.
Return value: 64-bit id.
warehouse: the warehouse object to query.
Returns the latest (highest) serial number given for local node.
Return value: integer, latest serial number
warehouse: warehouse object to use
logical_from: from who the message came from originally
full_str: message of the form serial i n seq from cmd
Puts an atomic string in the object, this kind of string is typically received on the network.
Return value: 1 on success, 0 on error
warehouse: object to work on
The various
get_seqfunctions can perform slowly if we don't pre-calculate the serial number of draft and reference atoms. So this calculation is not within the functions themselves but can be cached by using this function. Just call it and after you might query the object for reference and draft info.Return value: 1 on success, 0 on failure.
warehouse: warehouse object to use
msg: message
Puts a message in the object. The message will be splitted into several atoms if needed, it can be arbitrary long.
Return value: 1 on success, 0 on error
warehouse: object to query
Tells the lowest seq referenced in the warehouse. Does not mean this is the lowest ever received, only we really have no chances of going below that point, nothing is stored, either complete or partial, below that.
Return value: integer.
warehouse: object to query
Tells the highest seq referenced in the warehouse. Does not mean an actual message can be built from it, only we've got some traces of such a high seq.
Return value: integer.
warehouse: object to query
Tells the highest seq that can be considered as a valid draft. This is not exactly the maximimum seq encountered, for here we want at least one complete message and not just one chunk of data (an atom) referring to a high seq, we want the complete stuff. However there can be missing messages in between.
Return value: integer.
warehouse: object to query
Tells the highest seq that can be considered as a reference. Being considered as a reference means we received all messages for this seq *and* at least one message from the following seq, and this for every node involved. This being said, we're sure to have the right information, nothing is missing.
Return value: integer.
warehouse: object to query
seq_min: lowest sequence number (round or chat index)
seq_max: highest sequence number (round or chat index)
Gets the list of messages for a given sequence (round or chat index), polling all the nodes. The from and to boundaries are included.
Return value: a list of strings.
warehouse: object to query
logical_to: the id of the node that we want to send data to
Returns all the messages that were not sent for the given warehouse.
Return value: a list of strings, containing atoms.
There are no functions in libdef, only a header file with constants.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/dsp/index.html.
argc: argc as passed to
mainargv: argv as passed to
maingfx_backend_name: the id/name of the gfx backend to use
Creates a dsp_backend object. The created object won't be displaying things until
lw6dsp_initis called. No thread is created, but the graphics backend is loaded into memory. If video mode is not available, it will appear later, when trying to start displaying things, this function only allocates memory and checks code is available in case of a dynamically loaded gfx backend.Return value: a newly allocated object.
dsp_backend: the dsp_backend object to free
Frees all ressources used by a dsp_backend object. Note that you must call this on a inactive 'stopped' dsp_backend object.
Return value: none.
dsp_backend: the object to represent
Gives a short human-readable description of the object.
Return value: a newly allocated string, must be freed.
dsp_backend: the dsp_backend to start
param: parameters to pass to the display funcs
resize_callback: a function which will be called when there's a resize event
Starts a dsp_backend object, that is, fire a separate thread and start rendering. This will set up a video mode, so it's very likely to fail if for some reason the video context isn't right, for instance if you try to set up graphical stuff but only have console access.
Return value: 1 if success, 0 if error.
dsp_backend: the dsp_backend to stop
Stops a dsp_backend, that is, cancel rendering and unset the video mode, hardware shouldn't be used any more after this call.
Return value: none.
dsp_backend: the dsp_backend to update
param: parameters to pass to the dsp_backend funcs
Passes a new set of parameters to the display function. This is in fact the only way to pass informations to the dsp_backend object once it's been started. This function will acquire a mutex, copy parameters, then give control back to the main thread while display keeps on going with new parameters in the background. It will get input informations. You really must call it often otherwise the screen won't get updated, or, at least, it will always display the same informations. It should be reasonnable to call this 10 or 20 times per second, the display itself can be faster, run at 60 or 100 fps to show smooth animation (eye candy).
Return value: 1 if success, 0 if error.
dsp_backend: the dsp_backend to query
Returns the number of frames displayed since the display was started.
Return value: the number of frames displayed.
dsp_backend: the dsp_backend to query
Returns the rendering time of the last frame. Gives clues about performance.
Return value: the number of milliseconds it took to draw screen
dsp_backend: the dsp_backend to query
Returns the current frames per sec display rate. This is the instant value, it changes very often even if display seems smooth.
Return value: the current instant display rate.
dsp_backend: the dsp_backend to query
Returns the current frames per sec display rate. This is not absolutely accurate but fits for displaying info to the player, it's an average.
Return value: the current averaged display rate.
dsp_backend: the dsp_backend to query
video_mode: a structure which will contain the results
Returns the current video mode, the one obtained by the driver. This function is also a way to know wether display is running correcly or not, by testing its return value.
Return value: 1 if ok, 0 if failure (mode not set)
dsp_backend: the dsp_backend to query
fullscreen_modes: a structure which will contain the results
Returns the current available fullscreen modes. Note that this one will only work if display is started, unlike
lw6gfx_get_fullscreen_modeswhich is used internally. The reason is that in this dsp module context, we need the thread to be launched, and the thread does start/stop display on its own.Return value: 1 if ok, 0 if failure (mode not set)
param: the structure to initialize
Fills a display param struct with zeros, this is mandatory before any use. Think of it as a raw memset.
Return value: none.
mode: 0 for check only, 1 for full test
Runs the test suite for the dsp module. In check (0) mode, won't test much to avoid failure because of missing graphical environment.
Return value: 1 if OK, 0 if error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/dyn/index.html.
Opens a .so file directly, using a valid (full) path name.
Return value: a handle to the module, once it's opened. You might still need to call a module specific
init() function, but it's another story.
argc: the number of command-line arguments as passed to
maintop_level_lib: the top-level library concerned, this means is it "cli", "gfx", "snd" or "srv". This will tell the function to search for the .so file in the correct subdirectory. Think of this as a category.
Opens a .so file corresponding to the given backend, it is capable to search for system libraries installed after "make install" but if not found, it will also search in the current build directory, finding the .so files in hidden .libs subdirectories.
Return value: a handle to the module, once it's opened. You might still need to call a module specific
init() function, but it's another story.
handle: the backend to close.
Closes an opened backend. Note that you must call any backend specific clear, destroy, deinit, exit, function before.
Return value: 1 if success, 0 on error.
handle: the backend concerned
func_name: the function name, as a NULL terminated string
Finds a C function in the given backend.
Return value: a pointer to the function, NULL if not found.
argc: the number of command line args, as passed to main
argv: the commind line args, as passed to main
top_level_lib: the library category to query (gfx, snd, cli, srv ...)
Returns an assoc which lists all the available modules. The key of the assoc entries in the module internal name such as 'gl' and the value associated is a NULL terminated string describing the module, for instance 'OpenGL'.
Return value: an assoc object containing key/label pairs.
argc: the number of command-line arguments as passed to
maintop_level_lib: the top-level library concerned, this means is it "cli", "gfx", "snd" or "srv". This will tell the function to search for the .so file in the correct subdirectory. Think of this as a category.
backend_name: the actual name of the backend, this is the name of the .so file, between "libmod_" and ".so". For instance, to find "libmod_gl.so", the right argument is "gl".
Get the full path to a .so file corresponding to the given backend, it is capable to search for system libraries installed after "make install" but if not found, it will also search in the current build directory, finding the .so files in hidden .libs subdirectories.
Return value: the full path of the .so file, needs to be freed.
mode: 0 for check only, 1 for full test
Runs the
dynmodule test suite, testing most (if not all...) functions. Will try to load libraries and query them for standard LW6-expected functions.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/gfx/index.html.
backend: the graphical backend to use
video_mode: the video mode to use at start up
resize_callback: a callback function which will be called at each resize event
Sets up the graphical backend for good, initializing a video mode and allocating ressources. This call can typically fail if there's no device available, if the user doesn't have enough rights to access the hardware, and so on.
Return value: 1 on success, 0 if not
backend: the backend to quit
Uninitializes the backend, that is, exits the graphical mode. All threads that use graphics must be closed when this is called.
Return value: none.
backend: the backend to represent
Returns a readable version of the backend object.
Return value: a newly allocated pointer.
backend: the backend to use
video_mode: the new video mode
This function changes the video mode. Note that the first time you set up the graphical environment you must call
lw6gfx_initbut to change the current mode, use this function. It should reload backend data automatically if needed (textures for instance). Note that before giving up and failing this function will try alternate video modes, and you're not garanteed to have the right mode after the call, even if it returns true. To check this, uselw6gfx_get_video_mode.Return value: 1 on success, 0 on failure;
backend: the backend to use
video_mode: the current video mode (will be overwritten, out parameter)
This function returns the current video mode.
Return value: 1 on success, 0 on failure;
backend: the backend to use
fullscreen_modes: the available fullscreen modes (will be overwritten, out parameter)
This function returns the current video mode.
Return value: 1 on success, 0 on failure;
backend: the backend to use
This function "pumps" events, that is gets pending events, puts them in queues, maintains internal states up to date. You really must call this very often or no input will be processed at all.
Return value: a pointer on the internal input state, musn't be freed.
backend: the graphical backend to use
mask: display flag, tells what to display
look: the look, the skin, contains display options
level: the level to display
game_struct: the game_struct associated with the level
game_state: the game_state associated with the level
local_cursors: the cursor to center the focus on
menu: the menu to display
progress: the value of the progress indicator
fps: the number of frames per second to display
mps: the number of moves per second to display
log_list: log messages to display
capture: wether to enable capture mode or not
gfx_debug: wether to enable gfx debugging tools
debug_team_id: for debug display, team to display informations about
debug_layer_id: for debug display, layer to display
This is the major drawing function, the one that encapsulates all others. As the program uses a separate thread to display things, we just pass this function many parameters, and let it do its job alone. So many parameters might sometimes be useless. It also allows the graphics backend decide wether menus and hud and background should interact. Or not.
Return value: 1 on success, 0 on failure.
argc: argc, as passed to
mainargv: argv, as passed to
mainList available gfx backends. The hash contains pairs with id and name for each backend. The id is the technical key you can use to load the backend, the name is something more readable you can display in an interface. The backend objects themselves are not instanciated by this (in fact, they are, but released on the fly) you need to load and initialize them afterwards.
Return value: hash containing id/name pairs.
argc: argc, as passed to
mainargv: argv, as passed to
mainname: string containing gfx key, typically got from
lw6gfx_get_backendsCreates a gfx backend, this is just about loading the dynamic library if needed, and/or check gfx engine is available, and connect to it. It does not perform initialization.
Return value: gfx backend.
backend: gfx backend to destroy
Frees the ressources associated to a gfx, which must have been properly uninitialized before.
Return value: none.
mode: 0 for check only, 1 for full test
Runs the
gfxmodule test suite. In check-only mode, this function won't test many things, for it requires a graphical mode to be available to perform the complete test.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/gfx/mod-gl/gl-utils/index.html (as there are many sub-directories in this module, please refer to the test coverage directory index for complete information).
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/glb/index.html.
buf: the data to encode
size: the size of data to encode
Encodes data into base64. Memory allocation is done automatically.
Return value: newly allocated string.
size: the size of the decoded data
base64_str: the string to decode
Decodes data from base64. Memory allocation is done automatically. Note that this function only works for strings, other data might not be handled correctly.
Return value: newly allocated pointer, NULL on error.
str: the string to encode
Encodes a string into base64.
Return value: newly allocated string.
str: the string to decode
Decodes a string from base64.
Return value: newly allocated string, NULL on error.
buf: the data to encode
size: the size of data to encode
prefix: a prefix string
Encodes data into base64. Memory allocation is done automatically. The encoded string will be prefixed with
prefix.Return value: newly allocated string.
size: the size of the decoded data
base64_str: the string to decode
prefix: a prefix string
Decodes data from base64. Memory allocation is done automatically. Note that this function only works for strings, other data might not be handled correctly. The encoded is expected to start with prefix
prefixand then contain base64 data.Return value: newly allocated pointer, NULL on error.
str: the string to encode
prefix: a prefix string
Encodes a string into base64. The encoded string will be prefixed with
prefix.Return value: newly allocated string.
str: the string to decode
prefix: a prefix string
Decodes a string from base64. The encoded is expected to start with prefix
prefixand then contain base64 data.Return value: newly allocated string, NULL on error.
key: the key buffer
key_sizebuf: the data to analyse
buf_size: the size of data to analyse
Calculates an SHA-1 sum of buffer, using key to seed calc.
Return value: newly allocated string, containing 20 chars checksum.
key: a key (string)
str: the string to calculate the checksum for
Calculates an SHA-1 sum of a string, using key to seed calc.
Return value: newly allocated string, containing 20 chars checksum.
key: the key buffer
key_sizebuf: the data to analyse
buf_size: the size of data to analyse
Calculates an SHA-1 sum of buffer, using key to seed calc.
Return value: a 32-bit unsigned integer
key: a key (string)
str: the string to calculate the checksum for
Calculates an SHA-1 sum of a string, using key to seed calc.
Return value: a 32-bit unsigned integer
mode: 0 for check only, 1 for full test
Runs the
glbmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/gui/index.html.
button: the button to update
timestamp: the current ticks (milliseconds)
Registers a "down" (press) event on a button.
Return value: none.
button: the button to update
Registers a "up" (release) event on a button.
Return value: none.
button: the button to query
Tells wether a button is pressed or not.
Return value: 1 if pressed, 0 if not.
button: the button to query
Tells how many times the button has been pressed. Typical usage: the button is pressed, released, pressed, released several times. Then, after all this, you want to know how many times it has been pressed. Querying its state with
lw6gui_button_is_pressedwon't tell you much but thispop_pressfunction will return 1 for each press there's been.Return value: 1 if there's a press event in the queue, 0 if empty.
button: the button to query
Tells how many times the button has been simpleclicked. This is different from a simple press, in fact, there's a delay, we must wait until the double-click delay is elapsed to make sure this is a simple click... Designed for use with mouse to differentiate fire and alternate fire.
Return value: 1 if there's a simpleclick event in the queue, 0 if empty.
button: the button to query
Tells how many times the button has been doubleclicked. Typical usage: the button is doubleclicked, released, doubleclicked, released several times. Then, after all this, you want to know how many times it has been doubleclicked.
Return value: 1 if there's a doubleclick event in the queue, 0 if empty.
button: the button to query
Tells how many times the button has been tripleclicked. Typical usage: the button is tripleclicked, released, tripleclicked, released several times. Then, after all this, you want to know how many times it has been tripleclicked.
Return value: 1 if there's a tripleclick event in the queue, 0 if empty.
button: the button to update
repeat_settings: the repeat settings
timestamp: the current ticks (milliseconds)
Updates the repeat informations for a button, must be called regularly, as often as possible.
Return value: none.
dst: the target button object
src: the source button object
Synchronizes two button objects. This is typically used to pass data from one thread to another. This is not a simple copy, it will handle data such as "when was it pressed last" it an intelligent manner, popping src data to put it in dst, and clearing src.
Return value: 1 if success, O if failure.
dst_x: the x coord to return
dst_y: the y coord to return
dst_x0: the x coord of point 0 in destination coord system
dst_y0: the y coord of point 0 in destination coord system
dst_w: the width of the area in destination coord system
dst_h: the width of the area in destination coord system
src_x: the x coord in source coord system
src_y: the y coord in source coord system
src_x0: the x coord of point 0 in source coord system
src_y0: the y coord of point 0 in source coord system
src_w: the width of the area in source coord system
src_h: the width of the area in source coord system
Registers a "down" (press) event on a button.
Return value: 1 if OK, 0 if error (unable to calculate).
x: x coord (in/out param)
y: y coord (in/out param)
x_flip: flip on x (out param, -1 or +1)
y_flip: flip on y (out param, -1 or +1)
w: width
h: height
x_polarity: x polarity (-1, 0 or 1)
y_polarity: y polarity (-1, 0 or 1)
Same as
lw6map_fix_coordsexcept it operates on floats. Usefull for cursor and other rendering operations. Additionnally, will keep track of inversions, that is to say if map is flip in one or another way. Be carefull, the flip values are -1 or 1 so that it's easy to multiply an offset by it, for instance, but this means testing if flip is not 0 will always return true, you must test if flip is stritly positive or negative.Return value: none
input: the input struct to initialise
Initialises an input structure, don't use twice, it won't free a previous init.
Return value: a pointer to the newly allocated object.
input: the input struct to uninitialise
Unitialises an input structure, need to call it to free event queue.
Return value: a pointer to the newly allocated object.
Creates an input structure, which can be used to handle input state & buffer.
Return value: a pointer to the newly allocated object.
input: the input object to free.
Deletes an input structure.
Return value: none.
input: the input struct to reset
Resets an input structure. Must have been initialized before. It will empty all queues and mark everything as unpressed.
Return value: 1 on success, 0 if failure.
input: the input to update
repeat_settings: the repeat settings (delay + interval)
timestamp: the current ticks (milliseconds)
Updates the repeat informations for an input, must be called regularly, as often as possible.
Return value: none.
input: the input to update
Tells an input object that one of its descendants has been modified. This will affect the return value of
lw6gui_input_need_syncReturn value: none.
input: the input to test
Tests wether an input object contains was modified and needs synchronisation.
Return value: 1 if sync is need, 0 if not.
dst: the target input object
src: the source input object
Synchronizes two input objects. This is typically used to pass data from one thread to another. This is not a copy, it will brute-force copy the static data such as mouse position, but anything like a queue will be treated in a "empty source and fill target with data" scheme. So source will be affected by this, the key buffer will be emptied, and so on. And if there are key in the target buffer, they won't be overwritten but kept in front of the FIFO list.
Return value: 1 if success, O if failure.
i: index to check
Checks wether the index is correct. Does not mean the joystick exists, it's just to avoid out of bounds errors.
Return value: 1 if within range, 0 if not.
joystick: joystick to update
x: x-axis position, as returned by the driver
limit: the limit, under this, buttons are considered unpressed.
timestamp: current ticks (timestamp in ms)
Updates the x axis of a joystick, this will convert an information of analog type such as "joystick is here" to a pad-like information such as "pressed in that direction".
Return value: 1 if within range, 0 if not.
joystick: joystick to update
limit: the limit, under this, buttons are considered unpressed.
timestamp: current ticks (timestamp in ms)
Updates the y axis of a joystick, this will convert an information of analog type such as "joystick is here" to a pad-like information such as "pressed in that direction".
Return value: 1 if within range, 0 if not.
joystick: the joystick to update
repeat_settings: the repeat settings (delay + interval)
timestamp: the current ticks (milliseconds)
Updates the repeat informations for a joystick, must be called regularly, as often as possible.
Return value: none.
dst: the target joystick object
src: the source joystick object
Synchronizes two joystick objects. This is typically used to pass data from one thread to another.
Return value: 1 if success, O if failure.
joystick: the joystick to query
move_pad: the structure which will contain the results
Returns the state of the joystick in a uniform, non-device specific structure containing only the up/down/left/right information.
Return value: none, the value are stored in
move_pad.
keysym: the keysym to check
Tells wether the keysym is valid or not.
Return value: 1 if valid, 0 if not
keyboard: the keyboard structure which stores keyboard state
Pops (in FIFO mode) a keypress stored in the keyboard buffer. You must free the obtained keypress object after you're done with it.
Return value: a newly allocated pointer, or NULL if no keypress pending.
keyboard: the keyboard structure which stores keyboard state
Tells wether a key is pressed or not. The function will test out of bound values.
Return value: 1 if pressed, 0 if not.
keyboard: the keyboard structure which will store the keypress
keysym: the keysym for the keypress
unicode: the ASCII/unicode code for the keypress
label: the label for the keypress
timestamp: the current ticks (timestamp in ms)
Registers a keypress event, that is, puts it in the event queue. This function does not take an
lw6gui_keypress_tstructure but separated args, this is because it will construct the object internally. You may freelabelafter calling this, an internal copy will be done. This function will also maintain the array of key states up to date.Return value: 1 if success, O if failure.
keyboard: the keyboard structure which will store the keypress
keysym: the keysym for the keypress
Registers a key release event.
Return value: 1 if success, O if failure.
keyboard: the keyboard to update
repeat_settings: the repeat settings (delay + interval)
timestamp: the current ticks (milliseconds)
Updates the repeat informations for a keyboard, must be called regularly, as often as possible.
Return value: none.
dst: the target keyboard object
src: the source keyboard object
Synchronizes two keyboard objects. This is typically used to pass data from one thread to another. Will pop the src queue to fill the dst queue.
Return value: 1 if success, O if failure.
keyboard: the keyboard to query
move_pad: the structure which will contain the results
Returns the state of the keyboard in a uniform, non-device specific structure containing only the up/down/left/right information.
Return value: none, the value are stored in
move_pad.
keysym: the keysym to use
unicode: the unicode value for this keysym
label: the label (optional, might be NULL)
Creates a keypress structure, the only reason for needing a contructor is that the label field needs be duplicated.
Return value: a pointer to the newly allocated object.
keypress: the keypress object to free.
Deletes a keypress structure.
Return value: none.
keypress: the keypress to work on
Returns a human-readable representation of the keypress.
Return value: a newly allocated string
title: the string to be displayed, what the user sees. Can be freed after the call is done, function will make a copy internally.
help: a string introducing the menu, describing what it does, giving hints on how to use it.
popup: a string to be displayed in popup mode when menu is displayed for the first time.
esc: the label to be displayed in the ESC button
enable_esc: wether to enable the escape button.
Constructs a new menu object. Note that you can always call other functions to modify it afterwards.
Return value: a pointer to the newly allocated object.
menu: a pointer to the menu.
Frees the menu, checking if things are OK before doing so.
Return value: none.
menu: a pointer to the menu.
Gets the memory occupied by the menu. Could be usefull to help a garbage collector taking decisions or reporting erros, for instance.
Return value: the number of bytes used.
menu: a pointer to the menu.
Constructs a readable description of the object. Usefull for debugging, or to introspect things using scripts, at run-time. Does not necessarly describe all the informations about the object, but helps knowing what it is.
Return value: a string describing the object, must be freed.
menu: a pointer to the menu.
title: the new title, you can free it after calling the function, an internal copy will be made.
Change the title of the menu. Use this function to change the title, don't try to access the struct directly. The idea is to have safe memory management.
Return value: none
menu: a pointer to the menu.
help: the new help, you can free it after calling the function, an internal copy will be made.
Change the help of the menu. Use this function to change the help, don't try to access the struct directly. The idea is to have safe memory management.
Return value: none
menu: a pointer to the menu.
popup: the new popup, you can free it after calling the function, an internal copy will be made.
Change the popup of the menu. That is to say, its popup. Use this function to change the popup, don't try to access the struct directly. The idea is to have safe memory management.
Return value: none
menu: a pointer to the menu.
Closes the popup, in practice, this is equivalent to setting the popup string to "" or NULL.
Return value: none
menu: a pointer to the menu.
Tells wether a popup is defined. Behavior is simplistic, at creation (when a non-NULL non-empty popup string has been set) then the popup is displayed. In this state, popup is considered to be defined. Then it can be close, and after this action the popup ain't here anymore, program continues the way it started.
Return value: 1 if has popup, 0 if does not
menu: the menu we want to query
position: the order of the item we want
Gets the menu item at the given position. First item is 0, last is N-1. Returns a pointer on the real object, not a copy.
Return value: a pointer to a menu item, NULL if out of range.
menu: the menu we want to modify
position: the position of the item we want to select
allow_scroll: wether scrolling should be allowed when displaying it
now: the current time, as a timestamp.
Selects the item at the given position. Use this function to be sure that only one item is selected, and all other states are consistent. Timestamp is needed for the sake of eye-candy.
Return value: 1 if success, 0 if failure (out of range).
menu: the menu we want to modify
state: 1 to select, 0 to unselect
now: the current time, as a timestamp.
Selects the escape item, this does not affect other items, it's mostly. to handle eye candy.
Return value: none.
menu: the menu we want to modify
state: 1 to enable, 0 to disable
now: the current time, as a timestamp.
Enables the escape item, this does not affect other items, it's mostly. to handle eye candy.
Return value: none.
menu: the menu to scroll
Scrolls a menu up, used as a callback for mouse wheel up for instance. The idea is just to decrement the first displayed item index.
Return value: 1 if OK, 0 if failed (out of range).
menu: the menu to scroll
Scrolls a menu down, used as a callback for mouse wheel down for instance. The idea is just to increment the first displayed item index.
Return value: 1 if OK, 0 if failed (out of range).
menu: the menu to scroll
breadcrumbs: list of strings containing breadcrumbs
Set the breadcrumbs, that's to say the readable, logical path to get to a given menu. This is just eye candy, not linked to any logic at this level.
Return value: 1 if OK, 0 if failed.
menu: the menu to center
position: the position of the menuitem to be put in the center
max_displayed_items: the maximum number of items displayed
Centers the menu on a given menuitem. Typically used when pushing a menu with a menuitem selected 'anywhere' in the list.
Return value: none.
menu: the menu we want to modify
menuitem: the item to insert
position: the position the new item will occupy ("insert before" mode)
now: the current time, as a timestamp.
Inserts the given item in the menu. All items starting at the insert position will be "pushed" (that is, their position incremented by 1). Once the menuitem is inserted, the menu object will take care of memory management and automatically free it when needed.
Return value: 1 if success, 0 if failure (memory problem, out of range).
menu: the menu we want to modify
menuitem: the item to insert
now: the current time, as a timestamp.
Appends the given item to the menu. Once the menuitem is appended, the menu object will take care of memory management and automatically free it when needed.
Return value: 1 if success, 0 if failure (memory problem).
menu: the menu we want to modify
position: the item to insert
now: the current time, as a timestamp.
Removes an item from the menu. It will automatically be freed.
Return value: 1 if success, 0 if failure (out of range).
menu: the menu concerned
max_displayed_items: the maximum number of items to display at once
Updates the display range. The reason for having this is that the first item, that is, how far we scroll in a very long menu, depends on the previous position. Plus you have to handle limit cases (begin/end). Thus, this function, which will automatically pick-up a suitable position. Of course,
first_item_displayedis not necessarly equal toselected_item.Return value: none.
menu: the menu to work on
label: the label of the menuitem to append
tooltip: the tooltip of the menuitem to append
value: the value of the menuitem to append
enabled: wether the inserted menuitem should be enabled
selected: wether the inserted menuitem should be selected
colored: wether the inserted menuitem should use value as its color
now: current time (timestamp)
Inserts a menu item at the given position. The idea is that the menu item object is automatically constructed on the fly, and an id is returned, which can be passed to '_using_id' menu-related functions. This is typically for using in scripts. The idea is that the script just keeps a copy of the id returned, and can this way operate directly on the menuitem without keeping a pointer, a smob or anything internally. From the C point of view, having a real C structure enables persistent data from one display to the other, and this is nice and conveninent. I acknowledge the prototype is scary.
Return value: 0 if error, or else an id which will later be used with '_using_id' functions.
menu: the menu to work on
label: the label of the menuitem to append
tooltip: the tooltip of the menuitem to append
value: the value of the menuitem to append
enabled: wether the appended menuitem should be enabled
selected: wether the appended menuitem should be selected
colored: wether the appended menuitem should use value as its color
now: current time (timestamp)
Appends a menuitem using the same logic as
lw6gui_menu_insert_for_id_usethat is to say a parameter is returned which can later be used to directly operate on a given menuitem, without having its pointer, and even if its position changes.Return value: 0 if error, or else an id which will later be used with '_using_id' functions.
menu: the menu to work on
menuitem_id: the id of the menuitem to remove
now: current time (timestamp)
Deletes the menuitem with the given id. Very important: the id is not the position. Id are arbitrary numbers that stick to menuitems, but they are not directly linked with the position. This function is practical to use if, for some reason, you don't have the pointer on the menuitem.
Return value: 1 if success, 0 if failure (out of range).
menu: the menu to work on
menuitem_id: the id of the menuitem to synchronize
label: menu label
tooltip: menu tooltip
value: value
enabled: wether it's usable or not
selected: 1 if the menuite is current item
colored: wether to use color
now: current time (timestamp)
Updates the menuitem with the given id. Very important: the id is not the position. Id are arbitrary numbers that stick to menuitems, but they are not directly linked with the position. This function is practical to use if, for some reason, you don't have the pointer on the menuitem. In practice, it's heavily used in the game to transmit informations from the scripts to the core C engine. Additionnaly, this function will automatically synchronize the
selected_itemfield of the menu struct.Return value: 1 if success, 0 if failure (out of range).
menu_a: first item to compare
menu_b: second item to compare
Compares two menus.
Return value: 1 if they are the same, 0 if not
menu: the menu to duplicate
Duplicates a menu structure.
Return value: a pointer to the new menu.
dst: the target menu
src: the source menu
Synchronizes two menus, this supposes that they represent the same menu, but simply in a different state. This function does not really copy src to dst, it has a special behavior, indeed everything is copied from src to dst, except the
first_item_displayedandnb_items_displayedwhich are taken from dst and copied to src. This is because in practise, those values are updated in the display loop/thread, which is the one which uses the target. This is not very orthodox, but should work.Return value: 1 if success, 0 if failure
label: the string to be displayed, what the user sees. Can be freed after the call is done, function will make a copy internally.
tooltip: the string to be displayed as a tooltip, describing the menu item in detail. Can be NULL if you don't want to use this feature.
value: the value. No GUI function uses this, this is the "real" value associated to the item.
enabled: wether the menu item can be selected, used, and so on
selected: wether the menu item is the item selected among all menu items.
colored: wetherr the menu item must, when drawn, be colored according to its value.
Constructs a new menuitem object. Note that you can always call other functions to modify these values afterwards, this might change rendering since
lw6gui_menuitem_set_valueorlw6gui_menuitem_set_labelwill, for instance, modify the "when was that item last modified" information.Return value: a pointer to the newly allocated object.
menuitem: a pointer to the menuitem.
Frees the menuitem, checking if things are OK before doing so.
Return value: none.
menuitem: a pointer to the menuitem.
Gets the memory occupied by the menuitem. Could be usefull to help a garbage collector taking decisions or reporting erros, for instance.
Return value: the number of bytes used.
menuitem: a pointer to the menuitem.
Constructs a readable description of the object. Usefull for debugging, or to introspect things using scripts, at run-time. Does not necessarly describe all the informations about the object, but helps knowing what it is.
Return value: a string describing the object, must be freed.
menuitem: a pointer to the menuitem.
label: the new label, you can free it after calling the function, an internal copy will be made.
now: the current time, as a timestamp.
Change the label of the menu item. That is to say, what the user sees. Use this function to change the menuitem value, don't try to access the struct directly. The idea is 1) to have safe memory management and 2) to keep the
last_changemember up to date. It can be later used for eye-candy effects.Return value: none
menuitem: a pointer to the menuitem.
tooltip: the new tooltip, you can free it after calling the function, an internal copy will be made.
now: the current time, as a timestamp.
Change the tooltip of the menu item (the explanation of what the item is about) Use this function to change the menuitem value, don't try to access the struct directly. The idea is 1) to have safe memory management and 2) to keep the
last_changemember up to date. It can be later used for eye-candy effects.Return value: none
menuitem: a pointer to the menuitem.
value: the new value.
now: the current time, as a timestamp.
Changes the value of a menuitem. This is the internal value, not what the user sees. Use this function to change the menuitem value, don't try to access the struct directly. The idea is to keep the
last_changemember up to date. It can be later used for eye-candy effects.Return value: none
menuitem: a pointer to the menuitem.
state: 1 to select, 0 to unselect
now: the current time, as a timestamp.
Switches the menuitem to (un)selected state. Use this function, don't try to modify the struct members directly. The idea is to have the
last_selectparameter up to date. It can be later used for eye-candy effects.Return value: none
menuitem: a pointer to the menuitem.
state: 1 to enable, 0 to disable
now: the current time, as a timestamp.
Switches the menuitem to enabled/disabled state. Use this function, don't try to modify the struct members directly. The idea is to have the
last_selectparameter up to date. It can be later used for eye-candy effects.Return value: none
menuitem: the menuitem we want to identify
Returns a checksum which can be used to know, for instance, wether the menuitem has changed or not, and if we should redraw it.
Return value: a checksum.
menuitem_a: first item to compare
menuitem_b: second item to compare
Compares two menuitems.
Return value: 1 if they are the same, 0 if not
menuitem: the menuitem to duplicate
The menuitem to duplicate.
Return value: a pointer to the duplicted menuitem.
dst: the target menuitem
src: the source menuitem
Synchronizes two menuitems, this supposes that they represent the same item, but simply in a different state.
Return value: 1 if success, 0 if failure
mouse: the mouse object to work on
screen_pos_x: the x position on screen
screen_pos_y: the y position on screen
timestamp: current timestamp
Registers a mouse move event.
Return value: note.
mouse: the mouse object to poll
screen_pos_x: pointer to the x position (can be NULL), will be updated even if no move
screen_pos_y: pointer to the y position (can be NULL), will be updated even if no move
Asks wether the mouse has moved or not.
Return value: 1 if mouse was moved since last call, 0 if not.
mouse: the mouse to update
repeat_settings: the repeat settings (delay + interval)
timestamp: the current ticks (milliseconds)
Updates the repeat informations for a mouse, must be called regularly, as often as possible.
Return value: none.
dst: the target mouse object
src: the source mouse object
Synchronizes two mouse objects. This is typically used to pass data from one thread to another. Will handle "mouse move" attribute and clear it in src if needed while setting it in dst.
Return value: 1 if success, O if failure.
mouse: mouse struct to update
To be called when one wants to start recording a drag session, typically when left button is pressed.
Return value: none.
mouse: mouse struct to update
To be called when one wants to stop recording a drag session, typically when left button is released.
Return value: none.
mouse: mouse struct to query
delta_x: x movement (on screen, out param can be NULL)
delta_y: y movement (on screen, out param can be NULL)
pos_x: x pos (on screen, out param can be NULL)
pos_y: y pos (on screen, out param can be NULL)
speed_x: x speed (on screen, out param can be NULL)
speed_y: y speed (on screen, out param can be NULL)
To be called when one wants to stop recording a drag session, typically when left button is released.
Return value: none.
point: point to test
rect: rectangle in which point is supposed to be
Tests wether a point is inside a rectangle, this is typically used to know if a point is inside the right texture or if we're outside.
Return value: 1 if OK, 0 if outside
quad: quad to test
rect: rectangle in which quad is supposed to be
Tests wether a quad is inside a rectangle, this is typically used to know if a quad is inside the right texture or if we're outside.
Return value: 1 if OK, 0 if outside
rect: the structure to initialize
x1: x for top left corner
y1: y for top left corner
x2: x for bottom right corner
y2: y for bottom right corner
Initializes a rect structure, will calculate w & h.
Return value: none.
rect: the structure to initialize
x: x for top left corner
y: y for top left corner
w: width
h: height
Initializes a rect structure, will calculate x2 & y2.
Return value: none.
dst: the structure which will contain the result
src: the source rect
clip: the clipping rect (boundaries)
Clips a rect (think of rectangle clips).
Return value: none.
segment: segment to test
rect: rectangle in which segment is supposed to be
Tests wether a segment is inside a rectangle, this is typically used to know if a segment is inside the right texture or if we're outside.
Return value: 1 if OK, 0 if outside
smoother: the structure to initialize
value: the value to use for now
duration: the duration of a standard move, in ticks (msec)
Initializes a smoother object, with a default value. The important point is the duration which will condition all the behavior of the object.
Return value: none.
smoother: the structure to use
value: the target value
Forces a smoother object to immediately point on a value.
Return value: none.
smoother: the structure to use
value: the target value
now: the current timestamp
Sets a new target, will automatically calculate current speed to smooth the next returned values.
Return value: none.
smoother: the structure to use
now: the current timestamp
Returns the current value of the smoother.
Return value: a float.
smoother: object to modify
step: step size, typically twice the map size
Companion function of
lw6pil_coords_fix_x10, this one will fix a smoother target to avoid crazy scrolls when cursor is on a map edge.Return value: none.
mode: 0 for check only, 1 for full test
Run tests in the gui module.
Return value: 1 if successfull, 0 if failed.
triangle: triangle to test
rect: rectangle in which triangle is supposed to be
Tests wether a triangle is inside a rectangle, this is typically used to know if a triangle is inside the right texture or if we're outside.
Return value: 1 if OK, 0 if outside
closest: the closest video_mode found
wished: the wished video_mode
available: a list of available video_modes (list of lw6gui_video_mode_t *)
Finds the closest video_mode available, this is just a small utility to cope with different screen shapes and avoid requesting 640x480 when it's just not available but there's a 640x400 instead.
Return value: 1 if the wished video_mode exists in available list and was found, else 0 if the wished video_mode doesn't exist and an approximative match was picked.
mode_a: first mode to compare
mode_b: second mode to compare
Compares two video modes, to know if they're the same.
Return value: 1 if equal, 0 if not.
dst: the target video mode
src: the source video mode
Applies the ratio of src to dst, for instance if src is 16/9, then dst will be made 16/9 too, trying to keep the same surface.
Return value: 1 on success, 0 on failure
viewport: the viewport to initalize
screen_w: screen width
screen_h: screen height
drawable_x1: viewport min x
drawable_y1: viewport min y
drawable_x2: viewport max x
drawable_y2: viewport max y
center_x: center of display (in map coordinates)
center_y: center of display (in map coordinates)
map_w: map width (shape)
map_h: map height (shape)
x_polarity: x polarity
y_polarity: y polarity
x_wrap: wether to wrap horizontally
y_wrap: wether to wrap vertically
keep_ratio: wether to adapt to viewport shape or keep original
global_zoom: global zoom is style_zoom * dynamic_zoom
scroll_limit: inside this zone, don't scroll
use_old_center: wether to take previous center in account
Initializes all the (jumbo?) viewport structure which will contain valuable informations for a simple "flat" display. Special renderers might not find usefull some fields and handle wrapping and zooming their own way, but this offers a basic skeleton.
Return value: 1 if ok, 0 on failure
viewport: the viewport to use
screen_x: the x coord on the screen
screen_y: the y coord on the screen
map_x: the x coord in map coordinates
map_y: the y coord in map coordinates
clip: wether to clip returned values
Translates from map coords to screen coords. Returned values might be outside screen boundaries if clip is 0. If screen coords are outside drawable area anc clip is 1, then they will be clipped.
Return value: NULL
viewport: the viewport to use
map_x: the x coord in map coordinates
map_y: the y coord in map coordinates
screen_x: the x coord on the screen
screen_y: the y coord on the screen
wrap: wether to use polarity informations to wrap coords.
Translates from screen coords to map coords. If wrap is set, it will interpret coords the way
lw6map_coords_fix_xywould, only it can still be formally outside map boundaries for it can return a value exactly equal to w,h while in interger mode it would be w-1,h-1.Return value: NULL
viewport: viewport to work on
map_dst_x: map det x coord (out param)
map_dst_y: map dst y coord (out param)
map_src_x: map src x coord
map_src_y: map src y coord
screen_dx: drag x (on screen)
screen_dy: drag y (on screen)
Used to calculate the new "center" when in drag mode.
Return value: none.
zone: the structure to initialize
x1: x for top left corner
y1: y for top left corner
x2: x for bottom right corner
y2: y for bottom right corner
Initializes a zone structure, will calculate w & h.
Return value: none.
zone: the structure to initialize
x: x for top left corner
y: y for top left corner
w: width
h: height
Initializes a zone structure, will calculate x2 & y2.
Return value: none.
dst: the structure which will contain the result
src: the source zone
clip: the clipping zone (boundaries)
Clips a zone (think of rectangle clips).
Return value: none.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/hlp/index.html.
keyword: the keyword we want to check out
Checks wether a given keyword is documented or not.
Return value: 1 if documented, 0 if not.
type: the type of the data associated to the keyword, will be written
default_value: the default value for the keyword, will be written
min_value: the min value for the keyword, will be written
max_value: the max value for the keyword, will be written
keyword: the keyword we want help about
Returns the documentation string associated to a keyword. The keyword might be a command-line option, a Guile function, an XML file entry. Raises a warning if the keyword is undocumented, but never returns NULL, you can use the returned value without checking it. String is localized if a translation is available. It's safe to call this function with type or other parameters being NULL.
Return value: a help string, never NULL, must not be freed. Additionnally, type will be updated.
keyword: the keyword we want the type of
Returns the type of a keyword. Calls lw6hlp_about internally.
Return value: the type, might be LW6HLP_TYPE_VOID.
keyword: the keyword we want the default for
Returns the default value for a keyword. Note that it can be NULL! The returned value is always a string, it's suitable to store in the config file, it's the value a user would pass on a command line, the one he wants documented.
Return value: a pointer, which can be NULL, must not be freed.
keyword: the keyword we want the min for
Returns the min value for a keyword. Wether this is relevant for a given keyword does not affect the fact that you can call this function. A min and max of zero means min and max make no sense.
Return value: the value (integer)
keyword: the keyword we want the max for
Returns the max value for a keyword. Wether this is relevant for a given keyword does not affect the fact that you can call this function. A min and max of zero means min and max make no sense.
Return value: the value (integer)
id: the id of the credits line to return
Returns a "credit line", that is a short sentence, about 30 to 50 chars, saying who developped the game, created graphics, giving important URLs, and so on. One can pass an arbitraty high
id, no risk.Return value: the string, must be freed.
keyword1: the 1st keyword
keyword2: the 2nd keyword
Checks wether a keyword matches another. Not only a string comparison, will also try and guess if the error is only about dash "-" replaced by underscode "_", for instance.
Return value: 1 if matches, 0 if different.
Returns the list of keywords concerning quick options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning self-documentation system.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the show options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the path options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the players options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the input options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the graphics options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the sound options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the network options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the map options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the rules options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the hints options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the style options.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning the teams options.
Return value: list of static strings (can't modify them)
Returns the list of C-function exported to Guile.
Return value: list of static strings (can't modify them)
Returns the list of hooks.
Return value: list of static strings (can't modify them)
Returns the list of keywords concerning advanced options.
Return value: list of static strings (can't modify them)
Returns the list of command-line aliases.
Return value: list of static strings (can't modify them)
Returns the list of team_colors.
Return value: list of static strings (can't modify them)
Returns the list of weapons.
Return value: list of static strings (can't modify them)
Returns the list of all available keywords.
Return value: list of static strings (can't modify them)
list: a pointer to a list of keywords
f: the file to print the content to
Prints all the keywords from the list. One keyword per line.
Return value: none.
list: a pointer to a list of keywords
f: the file to print the content to
Prints all the keywords from the list, with the associated keyword help, to the given file. Output is formatted to fit on the standard terminal/console.
Return value: none.
keyword: the keyword to print help about
f: the file to print the content to
Displays the help about a keyword, to a file, directly. It's formatted for the purpose of the –about=<value> option.
Return value: none
Initializes the help reference, this must be called before any call to lw6hlp_about or such help related functions.
Return value: 1 on success, 0 if failed
un-initializes the help reference, this must be called at the end of the program.
Return value: 1 on success, 0 if failed
mode: 0 for check only, 1 for full test
Runs the
hlpmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/img/index.html.
mode: 0 for check only, 1 for full test
Runs the
imgmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/ker/index.html.
game_state: game state to represent
Gives a string representation, an ASCII capture of the game. This representation is suitable for debugging, typically print it to a VT100 console.
Return value: dynamically allocated string.
cursor: the cursor to reset
Sets a cursor to defaults (disabled). This function will not touch the node_id and cursor_id fields, so you can call it on an already used cursor, it will stay usable.
Return value: none
game_struct: game_struct use to construct the object
progress: progress indicator
Creates a game state from a game struct. The game struct must be kept (never freed) while game_state is in use.
Return value: newly created object.
game_state: the object to free
Frees a game_state object, releases all required objects. At this stage the map_struct must still be available.
Return value: none
game_state: the game_state to modify
game_struct: the game_struct to point to
This can be used when one makes a copy (dup) of a game struct and for some reason want the game_state to point on this new copy. Of course you should make the game_state point to a game_struct that is identical to the one that was used to construct the object in the first place. Use at your own risk.
Return value: none
game_state: the game_state to query
Returns the approximative amount of memory taken by the object.
Return value: number of bytes (approximation)
game_state: the game_state to query
Gives a readable representation of the object.
Return value: newly allocated string, must be freed
dst: the destination game_state
src: the source game_state
Tells wether src and dst can be synced. This is not a fool proof function but in most cases it will raise the error, use it to avoid blunders. It just compares
dstandsrcand tries to guess if they correspond to the same logical objects.Return value: 1 if they are syncable, 0 if not.
dst: the destination game_state
src: the source game_state
Fundamental function, used to carbon copy a game state to another, this is intensively used to keep too tracks of the game state, one most-up-to-date but probably wrong, the one we use to display on the screen, and one slightly outdated (or very outdated if network is slow) but that we're sure of, something 100% bullet proof we can rely on.
Return value: 1 on success, 0 on error
game_state: the game_state to copy
progress: progress indicator
Dups (copy) a game_state object. The newly created object points to the same game_struct but is an independant copy, you can play a whole different game on it. In practice this is often used to create the game_state objects for anticipation in network games.
Return value: newly created object
game_state: the game_state to query
Calculates the checksum of a game_state, this can be very usefull to make sure two states are identicall (prevent network errors and/or cheating).
Return value: 32-bit checksum
game_state: the game_state to query
shape: the shape (out param)
Retrieves the shape (w*h*d)of the game_state.
Return value: none.
game_state: the game_state to query
Retrieves the width (shape.w) of the game_state.
Return value: the width.
game_state: the game_state to query
Retrieves the height (shape.h) of the game_state.
Return value: the height.
game_state: the game_state to query
Retrieves the depth (shape.d, AKA number of layers) of the game_state.
Return value: the depth.
game_state: the game_state to act on
node_id: the id of the node to register
Registers a node in the game, this must be done, else no action will be allowed (such as adding a cursor or moving it). There's a limited number of nodes allowed, and ids must be unique.
Return value: 1 on success, 0 on failure.
game_state: the game_state to act on
node_id: the id of the node to register
Unregisters a node in the game, this must be done when a node leaves the game, it will free ressources and allow others to connect.
Return value: 1 on success, 0 on failure.
game_state: the game_state to query
node_id: the node to test
Tells wether a node is present in a game.
Return value: 1 if node is in game, 0 if not
game_state: game_state to query
node_id: the node to get info about
last_command_round: the last round for which a command was issued (out parameter)
Queries information about a given node, mostly, what was the last round we got a command.
Return value: 1 on success, 0 on error.
game_state: the game_state to act upon
node_id: the node issuing the command
cursor_id: the id of the cursor to add
team_color: the color we wish
Adds a cursor in a game. Note that if there's already a cursor with that id, it will fail, and the color is only the color we wish, we might indeed be attributed another color on a successfull call.
Return value: 1 on success, 0 on error.
game_state: the game_state to act upon
node_id: the node issuing the command
cursor_id: the id of the cursor to remove
Removes a cursor from the game, corresponding teams will be removed if needed.
Return value: 1 on success, 0 on failure.
game_state: the game_state to query
cursor_id: the cursor to test
Tells wether a cursor is present in the game.
Return value: 1 if cursor exists, 0 if not.
game_state: the game_state to query
cursor: the cursor data (out param)
cursor_id: the cursor to query
Return value: 1 on success, 0 on failure.
game_state: the game state to query
cursor: the cursor (out param)
i: the index
Gets the cursor information, using its index. This is usefull to walk the whole cursor without knowing their ids.
Return value: none.
game_state: the game_state to act upon
cursor: the cursor
Sets a cursor, that is, changes its position, this is pretty much anything we can do about a cursor except adding or removing it, just because of Liquid War very simple rules. The passed pointer may be freed after the call, only the
cursor_id,node_id,x,yandfirefields are used, others are ignored. More precisely, theenabledwill be ignored, it's not a valid way to add/remove teams.Return value: 1 on success, 0 on failure
game_state: the game_state to query
team_color: the team color to test
Tells wether a team color is present in the game. Note that this is different from cursor ids.
Return value: 1 if team exists, 0 if not.
game_state: the game_state to query
team_color: the color to get informations about
nb_cursors: number of cursors with this color (out param)
nb_fighters: number of fighters with this color (out param)
Gets informations about a given color. Indeed, a color can have several cursors, and knowing how many fighters there are with a given color is probably the most important things about a color.
Return value: 1 on success, 0 on failure.
game_state: the game_state to query
Tells how many teams there are in a game. This is different from the cursors number, there can be more cursors than teams, because a team can have several cursors.
Return value: the number of teams.
game_state: the game_state to act upon
team_mask: a binary mask of which gradients (teams) must be spreaded
Spreads the gradient, that is, calculates the potential of each point on the map, ie the distance to the closest cursor. The binary mask allows gradient to be spread for only some teams, this is usefull in a multithreaded context, as gradients can be calculated separately.
Return value: none
game_state: the game_state to act upon
team_mask: a binary mask of which teams must be moved
Moves the fighters, note that you must calculate the gradient from time to time else they go to the wrong places. The
team_maskallows the moving of only some given teams, but moving (for instance) even teams then odd teams isn't the same as moving odd teams then even teams. Whereas as far as gradient calculation is concerned, this could have been true, you could have multithreaded that.Return value: none.
game_state: the game_state to act upon
Finishes a round, that is, vaccums various stuff, checks if some team has lost, and so on. This is complementary to the spread and move steps, it should be called at each round.
Return value: none.
game_state: the game_state to act upon
This is a fundamental function, it's called at each round, it fires all the complex calculations in the game, the real core algorithm. Every time this function is called, the round is "over" and the game state is ready for the next... round. It's equivalent to calling the spread, move and finish functions.
Return value: none.
game_state: the game_state to query
Returns the number of moves done on this game.
Return value: number of moves.
game_state: the game_state to query
Returns the number of spreads done on this game.
Return value: number of spreads.
game_state: the game_state to query
Returns the number of rounds done on this game.
Return value: number of rounds.
game_state: the game_state to query
Returns the number of playable rounds in the game, that is the number of rounds to be played if game goes up to the time limit. This is a fixed number, if game slows down then time is stretched, but the the exact maximum number of rounds is known at game start, and it is the number returned by this function.
Return value: number of rounds in the game
game_state: the game_state to query
Tells wether the game is over or not. The answer depends on time limit, game rules, and of course what happened on the battlefield.
Return value: 1 if over, 0 if not.
game_state: game_state to query
cursor_id: the cursor to test
Tells wether a cursor was the winner after a game is over.
Return value: 1 if cursor is in winning team, 0 if not.
game_state: the game_state to query
excluded_team: a team to exclude
Returns the winner, if you set excluded_team to something else than a valid team number (for instance -1, but 0 is a valid team) then this team will be excluded from search. This is usefull if you want to find out who's the best positionned player while excluding yourself, for instance if you're a bot.
Return value: the winner team number, note that it can be invalid (-1) if there's no winner (for example, there are no teams on the map).
game_state: the game_state to query
excluded_team: a team to exclude
Returns the looser, if you set excluded_team to something else than a valid team number (for instance -1, but 0 is a valid team) then this team will be excluded from search. This is usefull if you want to find out who's the worst positionned player while excluding yourself, for instance if you're a bot.
Return value: the looser team number, note that it can be invalid (-1) if there's no looser (for example, there are no teams on the map).
game_state: the game_state to query
Gets the number of active fighters, this is relatively constant within the game, it does not change when someone looses, but it can vary when a new team arrives or disappears.
Return value: number of fighters.
game_state: the game_state to query
Returns the time elapsed, this is not the real time you'd time with an atomic clock, rather the time that would have elapsed if game had been run at its nominal speed. There can be a difference if your computer is too slow, among other things.
Return value: time elapsed, in seconds.
game_state: the game_state to query
Returns the time left, this is not the real time you'd time with an atomic clock, rather the time that would theorically be left is game was to be run at its nominal speed. There can be a difference if your computer is too slow, among other things. You shouldn't rely on this to know wether a game is over or not, there's another dedicated function for that.
Return value: time left, in seconds.
game_state: the game_state to query
i: the index of the history point
team_id: the team to query
Returns the number of fighters at some point in the past (the lower i, the oldest). The history scrolls automatically and erases itself at some point, it's of constant length. This is the global, long term history, reflects the whole game and could be used for an end-game score screen.
Return value: number of fighters at that time.
game_state: the game_state to query
i: the index of the history point
team_id: the team to query
Returns the number of fighters at some point in the past (the lower i, the oldest). The history scrolls automatically and erases itself at some point, it's of constant length. This is the latest, short term history, reflects the recent game evolutions and could be used to display an in-game monitor.
Return value: number of fighters at that time.
game_state: game_state to query
Returns the maximum value, that is, the maximum number of fighters, all teams combined, for this history. This can be used to scale charts. This function for the global long term history.
Return value: max number of fighters.
game_state: game_state to query
Returns the maximum value, that is, the maximum number of fighters, all teams combined, for this history. This can be used to scale charts. This function for the latest short term history.
Return value: max number of fighters.
game_state: game_state to query
x: x position
y: y position
z: z position
Gets the id of a fighter in a given position. Previous versions of the game used to have this declared inline static for speed, but the price to pay in terms of maintainability was too high: too much stuff from the ker module had to be kept public. This functions is very likely to be called often when one wants to know what's happening on the battlefield, to draw it, for instance. If there's no fighter, the id is negative, any id equal or greater than 0 (returned by this function) is valid.
Return value: the id of the fighter at that position.
game_state: game_state to query
fighter_id: the id of the fighter
Gets a fighter by its id. Internally, all fighters are stored in an array so it could be "safe" to get fighter with id 0 then walk the array. Previous versions of the game used to have this public (the array), it has been hidden since.
Return value: pointer to the fighter with the given id.
game_state: game_state to query
x: x position
y: y position
z: z position
Gets a fighter by its position. This function will check for boundaries, if there's no fighter in this place, it will return NULL, but nothing worse can happen. More precisely, if the place is in a wall, it won't bug, unlike the non-bullet-proof equivalent of this function.
Return value: pointer to the fighter at this position, or NULL if none.
game_state: game_state to query
x: x position
y: y position
z: z position
Gets a fighter by its position. This function will not check for boundaries, if there's no fighter in this place, not only will it probably not return a valid value, but it will also even segfault before that, trying to access non-existing structures in menory. So only call this if you're sure there's a fighter here.
Return value: pointer to the fighter at this position, or NULL if none.
game_state: the game_state to query
team_id: the team id (color)
Gets the potential of a zone. In practice this is not needed to make the game function, you need not call this to know how to move fighters, however the information can be interesting for debugging.
Return value: the potential
game_state: game_state to query
team_color: the team color to query
Returns the charge ratio for a given team/color. A value of 100 means fire is enabled, more than 1000 means super-charge, under 100 means you have to wait.
Return value: integer value.
game_state: game_state to query
team_color: the team color to query
Returns how much of the weapon is yet to be consumed for a given team. More than 1000 means extra time, 1000 is standard time to be elapsed, 0 means it's over.
Return value: integer value.
game_state: game_state to query
team_color: the team color corresponding to last weapon (out param)
weapon_id: the corresponding weapon_id (out param)
per1000_left: how much of the weapon is yet to be spent (out param)
Returns informations about the latest weapon, this is typically for drawing purposes, just query this and you know if you need to paint everything in red, green, whatever, as far as the default backend is concerned. In case there's no weapon, well, parameters are untouched. Pointers can be passed as NULL.
Return value: 1 if found, 0 if not.
level: the level on which the game_struct is based
progress: progress indicator
Creates a new game_struct from a level. The game_struct is different from the level in the sense that the game_struct does contain algorithmic specific optimizations, it's a ready-to-use struct desgined for execution speed, while the plain level just stores information.
Return value: newly allocated object
game_struct: the game_struct to free
Frees a game_struct object, releasing all required stuff. The source level must still be available when freeing this.
Return value: none
game_struct: the game_struct to modify
level: the level to point to
This can be used when one makes a copy (dup) of a level and for some reason want the game_struct to point on this new copy. Of course you should make the game_struct point to a level that is identical to the one that was used to construct the object in the first place. Use at your own risk.
Return value: none
game_struct: the game_struct to query
Returns the approximative amount of memory taken by the object.
Return value: number of bytes (approximation)
game_struct: the game_struct to query
Gives a readable representation of the object.
Return value: newly allocated string, must be freed
game_struct: the game_struct to copy
progress: progress indicator
Dups (copy) a game_struct object. The newly created object points to the same game_struct but is an independant copy, you can play a whole different game on it. In practice this is often used to create the game_struct objects for anticipation in network games.
Return value: newly created object
game_struct: the game_struct to query
Calculates the checksum of a game_struct, this can be very usefull to make sure two structs are identicall (prevent network errors and/or cheating).
Return value: 32-bit checksum
game_struct: the game_struct to query
shape: the shape (out param)
Retrieves the shape (w*h*d)of the game_struct.
Return value: none.
game_struct: the game_struct to query
Retrieves the width (shape.w) of the game_struct.
Return value: the width.
game_struct: the game_struct to query
Retrieves the height (shape.h) of the game_struct.
Return value: the height.
game_struct: the game_struct to query
Retrieves the depth (shape.d, AKA number of layers) of the game_struct.
Return value: the depth.
game_struct: the game_struct to query
x: x position
y: y position
z: z position
Tests wether a given position is foreground, that is, occupied by a wall.
Return value: 1 if foreground (wall, fighters can't move), 0 if not
game_struct: the game_struct to query
x: x position
y: y position
z: z position
Tests wether a given position is background, that is, there's no wall.
Return value: 1 if background (wall, fighters can move), 0 if not
game_struct: game_struct to query
nb_zones: the maximum zone size (out param, can be NULL)
max_zone_size: the maximum zone size (out param, can be NULL)
This function gets information about the internal zoning system, can be used for debugging.
Return value: none.
game_struct: game_struct to query
i: index of the zone to query
zone_pos: coord of the zone, top-left corner (out param, can be NULL)
zone_size: size of the zone (out param, can be NULL)
This function gets information about the internal zoning system, can be used for debugging.
Return value: none
game_struct: the game_struct to query
x: x pos
y: y pos
z: z pos
Gets the zone id for a given position. The id returned can then be used to query for a potential, for instance.
Return value: the zone id
game_struct: the game_struct to query
there: the closest free slot (out param)
here: where we'd like to be
Tries to find the closest free slot (there) near a given position (here). This is typically used internally to find out where to apply the cursor when it's flying over walls.
Return value: none
game_state: the game_state to work on
next_pos: the next position (out param)
current_pos: the current position
team_color: the team color
Tries to find the best move given a position and a team. Note that this function does not check for the presence of another fighter, it will only check walls and can even (sometimes) fail when there's a path. The reason is that it uses the game_state at a given round and does not recalculate gradient while a real fighter has an ever-changing gradient. Whatsoever, this can be used to move cursors like they were fighters, it's not perfect but gives a good illusion.
Return value: 1 if best place found, 0 if not.
score_array: the score array to modify
game_state: the game_state to get the information from
Updates a score array, that is, calculates all scores, so that they can be displayed, for instance.
Return value: 1 on success, 0 on failure.
even: even team mask (out param)
odd: odd team mask (out param)
round: round concerned
Returns a default team mask for a given round, even and odd will contain ready to use masks (for spread and move functions for instance).
Return value: none.
even: even team mask (out param)
odd: odd team mask (out param)
game_state: the game_state concerned
Returns an optimal team mask for a given round, even and odd will contain ready to use masks (for spread and move functions for instance). The difference with the default team mask is that this one will test for which teams are present and try and manage to find an equilibrated set of odd/even teams.
Return value: none.
team_color: color index
team_mask: team mask
Tells wether a given team is concerned by a team mask.
Return value: 1 if concerned, 0 if not.
team_color: color index
Gives the mask corresponding to a given color.
Return value: bitwise mask.
mode: 0 for check only, 1 for full test
Runs the
kermodule test suite. Will perform deep checksums and *really* check many things. If this passes, the algorithm is fine. What could make it fail is a serious bug and/or some weird combination of endianess, byte alignment...Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/ldr/index.html.
body: the body to read, must point to allocated memory
dirname: the directory of the map
param: map parameters
hints: map hints
display_w: the display width
display_h: the display height
ratio: wished map ratio
bench_value: the bench value (depends on computer capacity)
magic_number: arbitrary constant
progress: structure to transmit loading progress
Reads the map body, that is, all the layers.
Return value: 1 if OK, 0 if failed.
style: the style structure to process.
hints: additionnal hints to know what to set automatically
Deduces all colors from background color, if needed. The function will check color_auto parameters and replace all other colors by base and alternate colors if needed. Note that the background color itself is not changed by this function. Background can only be guessed from texture.
Return value: none.
cursor_texture: the cursor texture (out param)
dirname: the directory we load the data form (map dir)
Reads the cursor texture information, if not available, will use defaults
Return value: 1 on success, 0 on failure.
entry: the entry to free
Frees a map entry.
Return value: none.
entry: the entry to dup
Dup a map entry.
Return value: newly allocated object.
map_path: the map_path environment config variable, delimited path list
relative_path: the relative path to use to find the map directory
user_dir: the user directory
Lists all maps in a given directory. Returns a list of lw6ldr_entry_t which can contain both directories with subdirs and actual maps. Maps are sorted before being returned, first directories, then maps, sorted in alphabetical order.
Return value: a list of dynamically allocated lw6ldr_entry_t.
map_path: the map_path environment config variable, delimited path list
relative_path: the relative path to use to find the map directory
user_dir: the user directory
recursive: if non-zero, map search will recurse in subdirs
callback_func: the function which will be called on each entry
func_data: an extra pointer to pass data to callback_func
Executes a given function on all maps in a given place, typically used in test programs.
Return value: none.
map_path: the map_path environment config variable, delimited path list
relative_path: the relative path to use to find the map directory
user_dir: the user directory
Gets the next entry used in test programs.
Return value: none.
level: the level to validate
user_dir: user directory
Validates a level, acknowledges you've won it. Upgrades exp.
Return value: 1 on success, 0 on failure.
layer: the layer on which to apply the grease
rules: map rules
hints: map hints
progress: structure to transmit loading progress
Reads the map body, that is, all the layers.
Return value: 1 if OK, 0 if failed.
hints: data to initialize
Set the hints struct to its defaults.
Return value: none.
hints: data to initialize
Zeros the hints struct, this is not the same as setting to defaults.
Return value: none.
hints: data to initialize
Clears the hints struct, this is not the same as setting to defaults.
Return value: none.
dirname: the directory of the map
Read the hints (hints.xml) of a map. Pointer to hints must be valid, and values already initialized, either zeroed or filled in with defaults or custom values.
Return value: 1 if success, 0 if failed.
hints: the hints to modify
key: the key to modify
value: the value to affect to the key, as a string
Sets one single parameter in a hints structure. Value must always be passed as a string, will be converted to the right type automatically when storing it in the structure.
Return value: 1 if success, 0 if failed. Note that while 0 really means there's a problem, some affectations can fail and return 1, needs to be worked on.
hints: the hints to modify
key: the key to modify
Gets one single parameter in a hints structure. Value is converted as a string.
Return value: dynamically allocated string, NULL on error.
key: the key we want informations about.
Gets the default value for a given hints key.
Return value: dynamically allocated string, NULL on error.
hints: the hints struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides hints with values. Pointer to hints must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing hints.
Return value: 1 if success, 0 if failed.
metadata: structure containting read data (out param)
dirname: map dirname (absolute path)
Reads the metadata, will first parse metadata.xml, and if not available read README and guess a title from map path. When function returns, all fields in structure are non-NULL.
Return value: 1 on success, 0 on failure.
meta_layer: the meta layer to read
filename: the file to open
target_w: the wanted width
target_h: the wanted height
analog: wether to use analog info (0-255) or boolean (0-1)
Reads a meta-layer from the disj, resampling is done according to the given parameters.
Return value: 1 on success, 0 on failure
meta_layer: the meta layer to read
dirname: the map directory
file_only: the meta-layer file name only (without the path)
target_w: the wanted width
target_h: the wanted height
analog: wether to use analog info (0-255) or boolean (0-1)
Reads a meta-layer from the disj, resampling is done according to the given parameters. This function is different from
lw6ldr_meta_layer_readfor it will 1) concatenatedirnameandfile_onlyand 2) return OK (1) if file does not exist.Return value: 1 on success, 0 on failure
param: the parameter struct to fill with values (read/write parameter)
dirname: the directory of the map
Read the parameters associated to a map. Pointer to param must be valid, and values already initialized, either zeroed or filled in with defaults or custom values.
Return value: 1 if success, 0 if failed.
param: the parameter struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides param with values. Pointer to param must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing param.
Return value: 1 if success, 0 if failed.
f: file to output content to
Print to a file a typical map rules.xml file.
Return value: none.
f: file to output content to
Print to a file a typical map hints.xml file.
Return value: none.
f: file to output content to
Print to a file a typical map style.xml file.
Return value: none.
f: file to output content to
Print to a file a typical map teams.xml file.
Return value: none.
user_dir: the user directory or at least, a writable one
Writes all example XML files in 'user_dir/example/', will create the directory if needed.
Return value: 1 if success, 0 if failed.
dirname: the directory containing the map
default_param: default parameters, as strings
forced_param: forced parameters, as strings
display_w: the width of the display output (resolution)
display_h: the height of the display output (resolution)
bench_value: the bench value (depends on computer capacity)
magic_number: arbitrary constant
user_dir: the user directory
progress: information used to handle the progress bar
Loads a map from dist. The default_param and forced_param can contain values corresponding to rules.xml and style.xml entries. Parameters are read in 4 steps. 1st, a default value is picked by the program. 2nd, any value in
default_paramreplaces previous values. 3rd, any value in rules.xml or style.xml replaces previous values. 4th, any value inforced_paramreplaces previous values. In practice, thedefault_paramallows the user to set defaults which can still be overwritten by the map, whileforced_paramis a definitive 'ignore what is is defined in the map' way of doing things. See alsolw6ldr_read_relative.Return value: 1 if success, 0 if failed.
map_path: a collection of paths where to find maps
relative_path: something which will be appended to a
map_pathmemberdefault_param: default parameters, as strings
forced_param: forced parameters, as strings
display_w: the width of the display output (resolution)
display_h: the height of the display output (resolution)
bench_value: the bench value (depends on computer capacity)
magic_number: arbitrary constant
user_dir: the user directory
progress: information used to handle the progress bar
Reads a map from disk, using the map-path value, which is a collection of paths defined by the command-line, the environment variables, and the config file.
default_paramandforced_paramwork as in the functionlw6ldr_read.Return value: 1 if success, 0 if failure.
resampler: resampler object to init
param: map parameters to use
hints: loading hints
source_w: width of source map
source_h: height of source map
display_w: width of source display
display_h: height of source display
target_ratio: ratio, that is width/height of the target
bench_value: rough estimation of this computer power
magic_number: arbitrary constant, needed to calibrate speed
expected_depth: how thick the map could be (in practice, looks like d in whd)
gray_level: used to estimate capacity, 1.0f is white and means many slots
Initializes a resampler. There is wizardry based on the bench, magic number map size, gray level. This is bot bullet proof, but has been experience driven and is the result of many tries / failures and hopefully successes. Might need tuning as the algorithm evolves. This is the very function that chooses the actual logical map size.
Return value: none.
resampler: resampler to set
source_w: source map width
source_h: source map height
target_w: target map width
target_h: target map height
Initializes a resampler with hardcoded values, does not calibrate according to context, simply set it to rescale the size you want.
Return value: none.
target_x: target x coordinate (out param)
target_y: target y coordinate (out param)
source_x: source x coordinate (in param)
source_y: source y coordinate (in param)
Transforms from source coordinate to target coordinates. Does rounding fine-tuning, it's not a simple integer division.
Return value: none.
source_x: source x coordinate (out param)
source_y: source y coordinate (out param)
target_x: target x coordinate (in param)
target_y: target y coordinate (in param)
Transforms from target coordinate to source coordinates. Yes, target to source. Target is our final logical map, source is what we loaded from disk, here we want to know, given a point in the target, where to fetch its data from source. Does rounding fine-tuning, it's not a simple integer division.
Return value: none.
dirname: the directory of the map
Read the rules (rules.xml) of a map. Pointer to rules must be valid, and values already initialized, either zeroed or filled in with defaults or custom values.
Return value: 1 if success, 0 if failed.
rules: the rules struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides rules with values. Pointer to rules must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing rules.
Return value: 1 if success, 0 if failed.
dirname: the directory of the map
Read the style (style.xml) of a map. Pointer to style must be valid, and values already initialized, either zeroed or filled in with defaults or custom values.
Return value: 1 if success, 0 if failed.
style: the style to modify
key: the key to modify
value: the value to affect to the key, as a string
Sets one single parameter in a style structure. Value must always be passed as a string, will be converted to the right type automatically when storing it in the structure.
Return value: 1 if success, 0 if failed. Note that while 0 really means there's a problem, some affectations can fail and return 1, needs to be worked on.
style: the style struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides style with values. Pointer to style must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing style.
Return value: 1 if success, 0 if failed.
dirname: the directory of the map
Read the teams (teams.xml) of a map. Pointer to teams must be valid, and values already initialized, either zeroed or filled in with defaults or custom values.
Return value: 1 if success, 0 if failed.
teams: the teams struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides teams with values. Pointer to teams must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing teams.
Return value: 1 if success, 0 if failed.
mode: 0 for check only, 1 for full test
Runs the
ldrmodule test suite.Return value: 1 if test is successfull, 0 on error.
texture: structure to hold read data
dirname: map dirname (absolute path)
param: parameters to use
hints: loading hints to use
use_texture: wether to use texture.png
display_w: display width
display_h: display height
ratio: target width/height factor (out param)
texture_exists: true if texture.png is here (out param)
progress: progress indicator (in/out param)
Read the texture associated to a map. Pointer to texture must be valid, it's modified in-place. The function will automatically figure out if texture.png exists or if we must use foreground.png/background.png.
Return value: 1 on success, 0 on failure.
use: struct to initialize
Sets the use structure to its defaults, this structure being used to now wether we should use texture, cursor textures, rules, hints, style, teams and music.
Return value: none.
use: struct to clear
Clears the use structure, set it to the use nothing mode.
Return value: none.
use: struct to modify
key: key to change (as a string)
value: value to set (as a string)
Sets a key to the given value, OK all fields are integer, this is just a convenient function to be called in more general functions which are fed with those string pointers, typically coming from an XML file.
Return value: 1 on success, 0 on failure (key not found).
use: the use struct to fill with values (read/write parameter)
values: an assoc containing strings with the new values
Overrides use with values. Pointer to use must be valid, and values already initialized, either zeroed or filled in with defaults or custom values. Not all parameters need be defined in values. It can even be NULL. The idea is just that if something is defined in values, it will override the existing use.
Return value: 1 if success, 0 if failed.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/map/index.html.
body: the body to initialize
w: the width
h: the height
d: the depth
noise_percent: the noise level to fill meta layers with
rules: the map rules
Sets up a default body structure.
Return value: none
body: the structure to clear
Clears a body structure.
Return value: none.
body: the structure to update
Updates (calculates) the checksum of a map body structure.
Return value: none.
body: the structure to update
rules: the game rules
This (fundamental) function ensures that all playable areas in a map are connected. If isolated zones are found out, then they are marked as walls and not used any more.
Return value: none.
level: the level to work on
body_x: the body (logical) x coord
body_y: the body (logical) y coord
texture_x: the texture x coord
texture_y: the texture y coord
Gets body (logical) coords from texture position.
Return value: 1 on success, 0 on failure (out of bounds)
level: the level to work on
texture_x: the texture x coord
texture_y: the texture y coord
z: the z position (depth related)
Tells wether a given map position is free or not, but using texture coords.
Return value: 1 if position is playable, 0 if not (wall)
color: the color to invert
Inverts a color couple, that is, replace fg by bg and vice-versa.
Return value: none.
color1: 1st color to compare
color2: 2nd color to compare
Compares two colors.
Return value: 1 if equal, 0 if not.
index: index of the color between 0 & 9
Transforms a team color index into its readable string form, which can be used in config files for instance.
Return value: a string, must *not* be freed.
key: key of the color, for instance "red"
The index of the color, between 0 & 9
Return value: an integer.
index: index of the color between 0 & 9
Transforms a team color index into its readable string form, which can be used to display information to players.
Return value: a string, must *not* be freed.
cursor_texture: the cursor texture to clear
Clears a cursor texture (set it all transparent).
Return value: none
cursor_texture: the cursor texture to clear
Sets a cursor texture to the builtin defauts, that is a circle that is black on the outside and gets white/transparent in the middle.
Return value: none
cursor_texture_layer: the cursor texture_layer to change
x: x coord
y: y coord
color: the color
Sets a pixel in the cursor texture_layer.
Return value: none
cursor_texture_layer: the cursor texture_layer to query
x: x coord
y: y coord
Gets a pixel in the cursor texture_layer.
Return value: the color
source: the map to copy
progress: to show advancement
Performs a deep copy of the map, all elements are newly allocated and source can safely be destroyed after it's been duplicated.
Return value: a newly allocated map, may be NULL.
exp: the player experience
Gets the highest color available for a given exp.
Return value: a color id
exp: the player experience
Gets the highest weapon available for a given exp.
Return value: a weapon id
rules: set of rules to use
team_color_id: color id to test
Tests wether a team color is allowed for a given set of rules.
Return value: 1 if allowed, 0 if not.
rules: set of rules to use
weapon_id: weapon id to test
Tests wether a weapon is allowed for a given set of rules.
Return value: 1 if allowed, 0 if not.
exp: exp to test
Get the unlocked team color for a given exp, if applyable.
Return value: -1 if nothing unlocked, else the team color
exp: exp to test
Get the unlocked primary weapon for a given exp, if applyable.
Return value: -1 if nothing unlocked, else the weapon id
Converts a map to something that is later readable by
lw6map_from_hexato reproduce the exact same map. Just a serializer.Return value: a newly allocated pointer, NULL if conversion failed.
hexa: an hexadecimal ASCII string, created by
lw6map_to_hexaConstructs a map from an hexadecimal string generated by
lw6map_to_hexa. Just an un-serializer.Return value: a new map, might be NULL if string isn't correct.
layer: the layer to init
w: width
h: height
Creates a default layer. This is mostly for testing purposes, the default layer is not empty, it contains a simplified map of the world.
Return value: none
layer: the layer to init
Clears a layer struct. This means freeing the pointer if it's non NULL and setting everything to 0.
Return value: none
Creates a new empty map. This object is perfectly unusable as is, since it has a 0x0 size, and many things set to "NULL". Still, it's used internally and is the canonical way to create the object, it ensures later calls that set up default parameters, for instance, will succeed.
Return value: a newly allocated pointer.
Creates a map, set to defaults. This is usefull mostly for testing. This builtin map has walls, paths, it's playable.
Return value: a newly allocated map.
w: the width of the map
h: the height of the map
d: the depth (number of layers) of the map
noise_percent: percentage of noise to use for metalayers
Creates a map, set to defaults. This is usefull mostly for testing. This one, unlike
lw6map_builtin_defaultswill let you give a width, height and a depth.Return value: a newly allocated map.
Frees a map and releases all its internal ressources.
Return value: none.
Reports how many bytes the map needs, in memory. Note that this is not contiguous memory, it involves a bunch of pointers, and possibly much more...
Returns a string describing the map. This is a very short description, use it for logs, and to debug stuff. By no means it's a complete exhaustive description. Still, the string returned should be unique.
Return value: a dynamically allocated string.
level_a: the first level to compare
level_b: the other level to compare
Compares two level structs, the idea is to compare the content, not only the pointers and level ids.
Return value: 1 if they're the same, 0 if not.
local_info: the structure to modify
music_dir: the new music_dir value
Sets the music_dir value, in a 'safe' manner, freeing any previous value and performing a string duplication.
Return value: 1 on success, 0 on failure.
local_info: the structure to clear
Clears the local_info structure, before destroying a level for instance.
Return value: none
metadata: struct to set to defaults
Sets the metadata struct to defaults, this does not set fields to NULL/empty values, but rather fills it with data claiming, for instance, that this is a default map.
Return value: none.
metadata: struct to clear
Clears a metadata, will expect it to be in a consistent state, that is either filled with proper values or completely zeroed.
Return value: none.
metadata_a: first item to compare
metadata_b: second item to compare
Tells wether both metadata items contain the same values.
Return value: 1 if same, 0 if different.
meta_layer: the meta_layer structure
x: x coord
y: y coord
value: the value to set at this place
Simple setter for the meta_layer struct.
Return value: none
meta_layer: the meta_layer structure
x: x coord
y: y coord
Simple getter for the meta_layer struct.
Return value: the value at this place
meta_layer: the meta_layer to clear
Clears a meta_layer struct. This means freeing the pointer if it's non NULL and setting everything to 0.
Return value: none
meta_layer: the object to init
w: width
h: height
analog: wether to use analog mode (0-255) or boolean (0-1)
noise_percent: the quantity of noise to initialise the layer with
seed: a pseudo-random seed to feed the pseudo-random generator
Builds a custom metalyer, suitable for tests or demo, letting the choice of its size and the noise to fill it with. If noise is 100 then metalayer is "full". If noise is 0, then meta layer is empty.
Return value: 1 if OK, 0 on failure.
param: the param struct to modify
Sets a param structure to its default value, note that current structured must be zeroed or correctly initialized.
Return value: none
param: the param struct to modify
Resets a param structure to nothing. Note that current structured must be zeroed or correctly initialized. The idea is just to free member pointers before calling free.
Return value: none
dst: the destination param struct
src: the source param struct
Copies parameters. Both structures must be zeroed or correctly initialized.
Return value: none
param: the param struct to modify
key: the name of the parameter to modify
value: the value of the parameter to modify
Sets an entry in a param struct. All values must be submitted as strings, internally, the function will call atoi to convert to integers if needed, for instance. It will also dispatch automatically between rules, style and teams.
Return value: 1 if parameter successfully set, 0 on error.
param: the param struct to query
key: the name of the parameter to get
Gets an entry from a param struct. All values returned as strings, do not use this in performance bottlenecks, this is just to export values to scripts, for instance.
Return value: dynamically allocated string, NULL on error, might return a string containing 0 on bad keys.
param_a: one struct to compare
param_b: another struct to compare
Compares the contents of two param structs.
Return value: 1 if they contain the same thing, 0 if not
rules: struct to set to defaults
Set rules to default values, as these are all integers, you can call this on any rules object.
Return value: none.
dst: destination (out param)
src: source (in param)
Copies the data from source to destination, simple wrapper on memcpy.
Return value: none.
rules: rules struct to check
checksum: checksum to update (in/out param)
Updates a checksum with the rules data.
Return value: none.
key: key to query
Get the default value for a given string key. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: integer.
key: key to query
Get the min value for a given string key. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: integer.
key: key to query
Get the min value for a given string key. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: integer.
rules: struct to use
key: key to query
Get the value for a given string key, as an integer. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: integer.
rules: struct to use
key: key to set
value: new integer value for key
Set the value for a given string key, as an integer. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: 1 on success, 0 on failure (eg key not found)
rules: struct to use
key: key to query
Get the value for a given string key, as a boolean. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: boolean.
rules: struct to use
key: key to set
value: new boolean value for key
Set the value for a given string key, as a boolean. Of course you could access the member, but this function internally does the conversion between readable string and actual struct offset.
Return value: 1 on success, 0 on failure (eg key not found)
rules: struct to init
Set rules to 0, this is not defaults, this is 0 (probably unusable as a real-world setting).
Return value: none.
rules_a: first item to compare
rules_b: second item to compare
Compares two rules items. Will tell if they contain the same data.
Return value: 1 if same, 0 if different.
style: struct to initialize
Sets a style struct to zero, simply puts zero everywhere without checking what was here before
Return value: none.
style: struct to modify
Sets a style struct to defaults values, expects the object to be in a consistent style, that's to say either containing real data or being zeroed.
Return value: none.
style: struct to clear
Clears a style struct. This function won't work on an unitialized structure, structure must be zeroed by some CALLOC or something, else automatic freeing of pointers will fail.
Return value: none.
dst: destination
src: source
Copies style data from source to destination. Like with clear,
dstmust be either initialized or totally zeroed, else function will fail (core dump)Return value: none.
style: style struct to modify (out param)
key: key to use
value: value to use
Sets a style entry, takes string values and will identify the struct offset and convert the value to whatever C type is needed.
Return value: 1 on success, 0 on failure (key not found)
style: style struct to query
key: key to use
Get a style entry, takes a string key and will identify the struct offset. The return value is converted to string, typically the cannonical representation suitable to write in an XML config file.
Return value: dynamically allocated string.
key: key to query
Get the default value for a style entry. This is quite a cost-expensive function given what it does, indeed it will convert anything to a string, and also perform key lookup to fetch the value.
Return value: dynamically allocated string.
color_set_a: first item to compare
color_set_b: second item to compare
Compares two color sets, telling if they contain the same data.
Return value: 1 if same, 0 if different.
style_a: first item to compare
style_b: second item to compare
Compares two style structures, telling if they contain the same data.
Return value: 1 if same, 0 if different.
teams: data to initialize
Zeros the teams struct, this is not the same as setting to defaults.
Return value: none.
teams: data to initialize
Set the teams struct to its defaults.
Return value: none.
teams: data to initialize
Clears the teams struct, this is not the same as setting to defaults. This one supposes the struct has been properly initialized, at least zeroed before usage, it might contain pointers which should be freed.
Return value: none.
dst: destination
src: source
Copies the contents of the teams struct. It's a real duplicate, any string is reallocated.
Return value: none.
teams: the teams to modify
key: the key to modify
value: the value to affect to the key, as a string
Sets one single parameter in a teams structure. Value must always be passed as a string, will be converted to the right type automatically when storing it in the structure.
Return value: 1 if success, 0 if failed. Note that while 0 really means there's a problem, some affectations can fail and return 1, needs to be worked on.
teams: the teams to modify
key: the key to modify
Gets one single parameter in a teams structure. Value is converted as a string.
Return value: dynamically allocated string, NULL on error.
key: the key we want informations about.
Gets the default value for a given teams key.
Return value: dynamically allocated string, NULL on error.
teams_a: one struct to compare
teams_b: another struct to compare
Compares the contents of two teams structs.
Return value: 1 if they contain the same thing, 0 if not
mode: 0 for check only, 1 for full test
Runs the
mapmodule test suite.Return value: 1 if test is successfull, 0 on error.
texture: texture to load (out param)
body: body to pick data from
color: colors to use
Will create a default bicolor texture from the body data, this is in case we don't want to use the texture or there is none. Result is not beautifull but might be very comfortable to play.
Return value: 1 on success, 0 on failure.
texture: data to clear
Clears a texture object, expects it to be in a consitent state, either filled with real data of zeroed.
Return value: none.
level: map to work on
texture_x: texture x coordinate (out param)
texture_y: texture y coordinate (out param)
body_x: body x coordinate (in param)
body_y: body y coordinate (in param)
Translates from body coordinate space to texture coordinate space.
Return value: 1 on success, 0 if failure.
level: map to use
body_x: x coordinate in body space
body_y: y coordinate in body space
Get the color of a given point in the texture, using the body coordinate space.
Return value: RGBA 8-bit color.
texture: texture object to test
Finds out if the texture is fully opaque or not. If it has an alpha layer (typically, PNG file) but this one is filled at 100% everywhere, then it will consider opaque. This is a slow function but the result is cached in the has_alpha member, so as the function is called at map loading, use the cached value instead.
Return value: 1 if has used alpha layer, 0 if opaque.
index: index of the weapon between 0 & 19
Transforms a team weapon index into its readable string form, which can be used in config files for instance.
Return value: a string, must *not* be freed.
key: key of the weapon, for instance "red"
The index of the weapon, between 0 & 19
Return value: an integer.
index: index of the weapon between 0 & 19
Transforms a team weapon index into its readable string form, which can be used to display information to players.
Return value: a string, must *not* be freed.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/msg/index.html.
info: the node info to use
Generate a HELLO command.
Return value: newly allocated string.
info: the node info to use
ticket: the ticket to send
Generate a TICKET command.
Return value: newly allocated string.
info: the node info to use
key: the key to identify the message
Generate a FOO command.
Return value: newly allocated string.
info: the node info to use
key: the key to identify the message
Generate a BAR command.
Return value: newly allocated string.
info: the node info to use
Generate a GOODBYE command.
Return value: newly allocated string.
serial: the message serial number
i: the message index in the group
n: the number of messages in the group
round: the message round (can have an offset with real round)
ker_msg: the actual content of the message (passed to core algo)
Generate a DATA command. Serial is an ever increasing number, i and n are most of the time 1 and 1, they are usefull only in long multipart messages.
Return value: newly allocated string.
info: will contain (remote) node info on success
msg: the message to analyse
Analyzes a HELLO message.
Return value: 1 on success, 0 on failure
info: will contain (remote) node info on success
ticket: if not NULL, will contain the ticket value on success
msg: the message to analyse
Analyzes a TICKET message.
Return value: 1 on success, 0 on failure
info: will contain (remote) node info on success
key: if not NULL, will contain the foo/bar key on success
msg: the message to analyse
Analyzes a FOO message.
Return value: 1 on success, 0 on failure
info: will contain (remote) node info on success
key: if not NULL, will contain the foo/bar key on success
msg: the message to analyse
Analyzes a BAR message.
Return value: 1 on success, 0 on failure
info: will contain (remote) node info on success
msg: the message to analyse
Analyzes a GOODBYE message.
Return value: 1 on success, 0 on failure
serial: will contain serial number on success
i: will contain group index on success
n: will contain group size on success
round: will contain round on success (can have an offset with real round)
ker_msg: will contain actual message on success
Analyzes a DATA message.
Return value: 1 on success, 0 on failure
msg: the message to analyse
Analyzes a GOODBYE message.
Return value: the from url, if found (dynamically allocated)
mode: mode to use (a la TELNET or URL compatible)
version: the program version to use (note: can be changed when testing)
password_checksum: the password string to send
physical_ticket_sig: the signature of the message, calculated with ticket + physical from/to
logical_ticket_sig: the signature of the message, calculated with ticket + logical from/to
physical_from_id: the sender id
physical_to_id: the receiver id
logical_from_id: the message creator id
logical_to_id: the message final destination id
msg: the body of the message
Generate an envelope, that is, the complete message sendable on the network.
Return value: newly allocated string.
envelope: the envelope to analyse
mode: mode to use (a la TELNET or URL compatible)
local_url: the url of local server (usefull for password)
password: the password to check against
expected_physical_from_id: the sender id, if NULL, no check performed
expected_physical_to_id: the receiver id, if NULL, no check performed
msg: if not NULL, will contain body of the message
physical_ticket_sig: if not NULL, will contain signature of message, calculated with ticket
logical_ticket_sig: if not NULL, will contain signature of message, calculated with ticket
physical_from_id: if not NULL, will contain sender id
physical_to_id: if not NULL, will contain receiver id
logical_from_id: if not NULL, will contain message creator id
logical_to_id: if not NULL, will contain message final destination id
physical_from_url: if not NULL and if message allows, will contain sender public URL
Generate an envelope, that is, the complete message sendable on the network.
Return value: newly allocated string.
info: the node to generate info about
Generates a standard response to the INFO question for OOB (out of band) messages. The same message is sent, be it on http or tcp or udp, so it's factorized here. Function will lock the info object when needed.
Return value: newly allocated string.
info: the node to generate info about
Generates a standard response to the LIST question for OOB (out of band) messages. The same message is sent, be it on http or tcp or udp, so it's factorized here. Function will lock the info object when needed. There's a max length because we don't want the udp buffer to be saturated + too long lists do not really mean anything anyway.
Return value: newly allocated string.
info: the node to generate info about
Generates a standard response to the PING question for OOB (out of band) messages. The same message is sent, be it on http or tcp or udp, so it's factorized here. Function will lock the info object when needed.
Return value: newly allocated string.
command: the command to send (PING, INFO, LIST)
remote_url: the remote URL (used to seed password)
password: the password, can be NULL or ""
local_url: the public URL to send along with the message, can be NULL or ""
Generates a simple clear text OOB request, with a password if needed.
Return value: a newly allocated string
syntax_ok: will contain 1 if syntax is OK, 0 if not
command: the command (out param, needs *not* to be freed)
password_ok: will contain 1 if password is OK, 0 if not
remote_url: the URL detected, if provided (out param, does needs to be freed)
request: the request to analyse
local_url: the local url (used to seed password)
password: the password to check against
Analyses a simple OOB message of the form COMMAND <passwd> <url>.
Return value: 1 if OK, 0 if not. If 0, check the value of password_ok.
text: the text of the message to parse
Analyses a PONG message and gets the public_url from it, if it exists.
Return value: newly allocated string containing public_url if OK, NULL on error.
mode: 0 for check only, 1 for full test
Runs the
nodmodule test suite.Return value: 1 if test is successfull, 0 on error.
ticket: the (private) ticket to use
from_id: the sender/creator
to_id: the receiver/target
msg: the message to sign
Produces a little signature, which is clearly vulnerable to brute-force attacks but makes it possible to be 100% sure if it's wrong, someone is trying to do something nasty (or there's a serious bug!).
Return value: the sig, always non-zero
ticket: the (private) ticket to use
from_id: the sender/creator
to_id: the receiver/target
msg: the message to sign
ticket_sig: the signature to check against
Checks a sig is OK.
Return value: 1 if they are the same, 0 if not.
key: will contain the key detected
value: will contain the value detected
line: the line to analyse
Analyses a trivial "KEY value" line and returns the key and the value in the passed pointers.
Return value: 1 if line OK (and in this case
keyandvalueare set), 0 if not.
assoc: an assoc object which will contain the result
line: the line to analyse
Analyses a trivial "KEY value" line and sets the
assocparameter according to detected values. Note thatassocmust be set to contain string, and free them automatically withlw6sys_free_callbackfor instance.Return value: 1 if line OK (and in this case
associs updated), 0 if not.
assoc: the string assoc to query
key: the key to find in the assoc
default_value: the default value to return
Queries a string assoc for a given value, and if not available, returns default value. Not that default value (nor the assoc value) is copied, so you must take care all remain valid until usage of returned value is over.
Return value: a string, must not be freed.
assoc: the string assoc to query
key: the key to find in the assoc
default_value: the default value to return
Queries a string assoc for a given value, and if not available, returns default value. Not that default value (nor the assoc value) is copied, so you must take care all remain valid until usage of returned value is over. This one will returned an int converted with
lw6sys_atoi.Return value: a string, must not be freed.
word: will contain the parsed word
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message and gets the first word. This word is put in
bufmember with its length.nextis usefull if you want to parse the rest of the message, it points at the beginning of it.Return value: 1 on success, 0 on failure.
word: will contain the parsed word
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message and gets the first word. This word is put in
bufmember with its length.nextis usefull if you want to parse the rest of the message, it points at the beginning of it. This specialxfunction will consider slash ("/") as valid separator. It can't be used all the time but for almost every field but URLs, it's fine. Internally, this one is used to parse integers, IDs, etc.Return value: 1 on success, 0 on failure.
word: will contain the parsed word
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message and gets the first word. This word is put in
bufmember with its length.nextis usefull if you want to parse the rest of the message, it points at the beginning of it. The word is expected to be base64 encoded and is decoded on-the-fly.Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an int.
Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an int. The value must be strictly greater than 0.
Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an int. The value must be strictly greater than 0.
Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an 16-bit id.
Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an 32-bit id.
Return value: 1 on success, 0 on failure.
parsed_value: will contain the parsed value
next: if NOT NULL, will contain a (non freeable) pointer on remaining message
msg: the message to parse
Analyses a message, gets the first word and interpret it as an 64-bit id.
Return value: 1 on success, 0 on failure.
msg: message to encode
limit: if under this limit (length in bytes), do not encode, return as is
Z-encode a message, by "Z-encoding" we mean pass the string through 1) zlib then 2) base64 encoding, this way we get a string without any blank and/or special character, and of reasonnable length. There's an optional limit *not* to encode anything, just when we know there are no special characters to escape and string is small, it's useless to fire this big artillery.
Return value: newly allocated string, 0 terminated, NULL on error.
msg: message to decode
Z-decode a message, by "Z-encoding" we mean pass the string through 1) zlib then 2) base64 encoding, this way we get a string without any blank and/or special character, and of reasonnable length. This decode string does it the reverse way, un64-encode the string then uncompress it back to a readable string.
Return value: newly allocated string, 0 terminated, NULL on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/net/index.html.
ip: the string to check
Tests if a given string is a valid IP (IPV4). Test is only syntaxic, it's just to know if we're likely to need to query the DNS, it does not mean the IP is *really* valid.
Return value: 1 if it's an IP, O if not.
name: name of the host
A wrapper over the standard gethostbyname function, will even accept an IP as an input (in this case, will copy it...) and allocate a new string for the result.
Return value: an IP if success, NULL on error.
Locks access to dns function
lw6net_dns_gethostbyname. This is becausegethostbynameisn't reentrant plus, even if we didn't use it but its multithreadable equivalent (which is however not standard and always available) other libs (such aslibcurlnot to name it) might use this function too so in a general manner it's a good idea to use a mutex to protect multiple accesses to this.Return value: an IP if success, 0 on error.
Unlocks access to dns function
lw6net_dns_gethostbyname.Return value: an IP if success, 0 on error.
Reports the last network error. This is basically a debug function, designed mostly for Microsoft Winsock API, but can be safely called on any platform.
Return value: the last error code, has no universal meaning, depends on the platform you're working on.
Guess the local IP address. This is not fool-proof, and it probably cannot be as we can't handle all user-specific configs involving multiple IP addresses, virtual private networks, and so on. But this is just to provide a default public IP address when starting a network game, saavy users can always specify the right interface/address if needed. Will return NULL if interface can't be guessed.
Return value: the IP as a string, dynamically allocated
bind_ip: the IP address used to bind on
bind_port: the IP port used to bind on
Guess the server public url, based on
lw6net_if_guess_localwhich tries to find a valid local IP address which is not loopback. This is only in casebind_ipis 0.0.0.0 (listen on all addresses) else it will just usebind_ipas you would expect. Function isn't foolproof, that's why one can override its default with a user settings.Return value: the IP as a string, dynamically allocated
sock: the socket descriptor
Receives a line terminated by LF ("\n", chr(10)) or CR/LF ("\r\n", chr(10)chr(13)) on a TCP socket, that is, stream oriented. If there's no complete line available, function returns immediately with NULL. Same if socket is closed, broken, whatever. Only if there's something consistent will the function return non-NULL.
Return value: a dynamically allocated string with the content received. The tailing (CR)/LF is stripped.
sock: the socket descriptor
line: the line to be sent, without the "\n" at the end
Sends a line terminated by LF ("\n", chr(10)) on a TCP socket, that is, stream oriented. The "\n" is automatically added, do not bother sending it.
Return value: non-zero if success
sock: the socket descriptor
incoming_ip: the IP address of the sender (returned)
incoming_port: the IP port of the sender (returned)
Receives a line terminated by LF ("\n", chr(10)) or CR/LF ("\r\n", chr(10)chr(13)) on a UDP socket, that is, datagram oriented. If there's no complete line available, function returns immediately with NULL. Same if socket is closed, broken, whatever. Only if there's something consistent will the function return non-NULL. By-value parameters allow the caller to know where the data come from.
Return value: a dynamically allocated string with the content received. The tailing (CR)/LF is stripped.
sock: the socket descriptor
incoming_ip: the IP address of the sender (returned)
incoming_port: the IP port of the sender (returned)
Receives several lines terminated by LF ("\n", chr(10)) or CR/LF ("\r\n", chr(10)chr(13)) on a UDP socket, that is, datagram oriented. If there's no complete line available, function returns immediately with NULL. Same if socket is closed, broken, whatever. Only if there's something consistent will the function return non-NULL. By-value parameters allow the caller to know where the data come from. This variant of
lw6net_recv_line_tcpwill return a list of lines, this is mandatory since in UDP we can't call recv several times.Return value: a list of dynamically allocated strings. The tailing (CR)/LF is stripped from strings.
sock: the socket descriptor
line: the line to be sent, without the "\n" at the end
ip: the IP address of the target
port: the IP port of the target
Sends a line terminated by LF ("\n", chr(10)) on a UDP socket, that is, datagram oriented. The "\n" is automatically added, do not bother sending it.
Return value: the number of bytes sent, 0 if failure
argc: argc as passed to
mainargv: argv as passed to
mainnet_log: 1 if you want to enable net log, 0 if not
Initializes the low-level network API, you must call this before calling any other network related function, for it allocates a dynamic context which is in turn used by every function.
Return value: non-zero if success
Frees memory, joins active threads, and releases everything set up by network code.
Return value: void
sock: the socket to modify
mode: the mode to use (1 -> blocking mode, 0 -> non-blocking)
Sets the blocking mode of a socket, the reason we use this is that
ioctlisn't portable (ioctlsocketon MS-Windows).Return value: 1 on success, 0 on failure.
sock: the socket to test
Tells if a socket is valid or not. This does not mean the socket is opened/connected and/or the peer is reachable, it just checks the socket is a valid descriptor. In practice it's just to avoid copy/pasting if (sock>=0)" everywhere.
Return value: 1 if valid, 0 if not
sock: the socket to close
Closes a socket, that is, stop activity and free its descriptor.
Return value: none.
ip: IP address to bind to
port: IP port to listen on
Listens in TCP on a given port.
Return value: >=0 on success, -1 on failure.
incoming_ip: address of remote peer (out param, dynamically allocated)
incoming_port: port of remote peer (out param)
listening_sock: socket to listen on
delay_msec: delay, in msec, after which we stop accepting
Accepts for a connexion on the given socket.
Return value: the new socket (>=0) if accepted, else -1
ip: address to connect to
port: port to connect to
delay_msec: delay before we consider it's too late
Tries to connect on a given socket.
Return value: socket (>=0) on success, else -1
sock: socket to use
buf: data buffer
len: data buffer length
delay_msec: delay after which we give up
loop: accept to do several calls if needed
Will send data, possibly looping until all is send, and waiting for a maximum time of delay_msec.
Return value: 1 on success, 0 on failure.
sock: socket to use
buf: data buffer
len: data buffer length
delay_msec: maximum time to wait
Tells wether data is available. Will actually fill the buffer with the data, but not remove it from the fifo list.
Return value: number of bytes available, 0 when nothing
sock: socket to use
buf: data buffer
len: data buffer length
delay_msec: maximum time to wait
loop: wether to loop or not
If data is available, put it in buffer. If needed, will loop until
delay_msecis elapsed. Data is removed from queue.Return value: number of bytes received, 0 when nothing
sock: socket to test
Tells wether a socket is alive and able to send data. This function will attempt a write to test if it's really usable.
Return value: 1 if alive, 0 if not.
mode: 0 for check only, 1 for full test
Runs the
netmodule test suite. This one could fail if some sockets are already bound, for instance. It's still run even in check-only (mode=0) mode.Return value: 1 if test is successfull, 0 on error.
Creates an UDP client socket, that is, creates it and does not bind it to any address.
Return value: socket (>=0) on success, else -1
ip: IP address to bind to
port: IP port to listen on
Creates an UDP listening socket, that is, creates it and binds it on a given address.
Return value: socket (>=0) on success, else -1
sock: socket to use
buf: data buffer
len: data buffer length
ip: IP address to send data to
port: IP port to send data to
Sends an UDP datagram. Size can't be longer than about 1400 bytes, see problems about MTU, in practice all values arround 1000 are quite safe, 500 is pretty much garanteed to work everywhere, and for various reasons 1452 is a good maximum bet.
Return value: number of bytes sent
sock: socket to use
buf: data buffer
len: data buffer length
Peeks for a UDP datagram. Will not remove the data from queue.
Return value: number of bytes received
sock: socket to use
buf: data buffer
len: data buffer length
Receives a UDP datagram. Will remove the data from queue.
Return value: number of bytes received
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/nod/index.html.
dyn_info: the dyn info struct to free
Frees a dyn info object, to be used after a call to
lw6nod_info_dup_dynfor instance.Return value: none
program: the program (normally it's liquidwar6)
version: the version
codename: the codename
stamp: the stamp
id: the node id
url: the node public url
title: the node title
description: the node description
password: the node password
bench: the node bench
open_relay: open relay or not
uptime: uptime in seconds
idle_screenshot_size: the size (bytes) of the image to display when game is idle
idle_screenshot_data: the data (jpeg) of the image to display when game is idle
Creates a node info object. The arguments correspond to the immutable node attributes, other properties such as how many players are connected or set in other functions like
lw6nod_info_updatewhich can be called later.Return value: newly allocated object, NULL on error.
info: the node info to free
Frees a node info object.
Return value: none
info: the node info to lock
Locks a node info object, this is usefull for some members, typically list of servers, can be accessed by separated threads, one reading, many writing, and these objects (chained lists) certainly do not want to be modified while being read.
Return value: 1 if ok, 0 if not.
info: the node info to unlock
Unlocks a node info object, this is the compation of the
lw6nod_info_lockfunction.Return value: 1 if ok, 0 if not.
info: the node info to modify
Clears a node info object and sets all its variable attributes to NULL/default values. This is what we want when the node is idle, not playing.
Return value: none.
info: the node info to update
community_id: the id of the community the node belongs to
round: the current round (can have an offset with real round number)
level: the name of the current level (map)
required_bench: the bench required to connect
nb_colors: number of colors playing
max_nb_colors: max number of colors allowed
nb_cursors: number of cursors playing
max_nb_cursors: max number of cursors allowed
nb_nodes: number of nodes playing
max_nb_nodes: max number of nodes allowed
game_screenshot_size: size of screenshot (bytes)
game_screenshot_data: screenshot data (byte buffer, contains JPEG)
Set a node info object variable attributes. Call this whenever the node has changed some parameter. Not too often for it's not needed and some operations such as modying the screenshot, can be time consuming.
Return value: 1 if OK, 0 if error.
info: the node info containing the dyn info to duplicate
Extracts the dynamic part of an info struct and duplicates it, this is to avoid protection fault error when concurrent threads access this info.
Return value: newly allocated object, must be freed.
Creates a new hash, to be used as a discovered nodes list. Using this function has the advantage of setting the hash options to their defaults. We use a hash to avoid having uselessly long lists containing always the same node due to multiple detections.
Return value: an empty hash
info: the node info to update
public_url: the address of the discovered node
Registers a new server, and queues it as something that should be checked later because it's interesting. We can't insert in the database all the servers we suspect to exist so network threads should use this, then main thread will process discovered servers afterwards. This is also a good way to avoid trivial DOS attacks.
Return value: 1 if OK, O if error.
info: the node info to query
Returns a list of all discovered nodes (their public URL) and empties the current queue as well.
Return value: a list of dynamically allocated strings.
Creates a new list, to be filled with nodes and typically passed to
lw6nod_info_set_verified_nodes. Using this function has the advantage of setting the listh options to their defaults.Return value: an empty list
info: the node info to modify
list: the list of verified nodes, will be freed by this function
Sets the list of verified nodes, that is, the list of nodes we are sure to exist, this is typically the list we will display later on a web page. We can't directly display any discovered node, one needs to filter them through main thread. Something very important about this function is that
listwill be freed by function, that is, if you call this, then you can (you should) forget your object, it will disappear any time soon.Return value: 1 if OK, 0 on error.
info: the node info concerned
func: the function to apply
func_data: arbitrary pointer holding data to pass to function
Calls
lw6sys_hash_mapwithfuncon every member of the list of verified nodes. The reason there's a function for this is that it is very important that list object is locked when doing this. This function does perform a lock/unlock so it is safe.Return value: none.
mode: 0 for check only, 1 for full test
Runs the
nodmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/p2p/index.html.
argc: number of args, as passed to
mainargv: args array, as passed to
mainname: the database name
Creates a new database object. Normally there's only one object like this at a given time, it can be shared among various nodes. The database name is appended to user directory path, this allows different databases to be created, in theory.
Return value: a pointer on the newly created object.
db: the db to close
Closes a db object, memory ressources will be freed.
Return value: none.
db: the db to work on
Gives a readable representation of the db
Return value: a dynamically allocated string
argc: number of args, as passed to
mainargv: args array, as passed to
mainname: the database name
Clears the database. Simply removes the db file, in fact. Do not call while database is used...
Return value: 1 on success, 0 if failed.
Returns the default database name, should be p2p.db (this is a relative path, not an absolute path, will be appended to user dir).
Return value: the default database name, need not (must not) be freed.
db: the db object concerned (used to calculate time origin)
Returns a timestamp suitable for db usage. The reason we don't use regular timestamps is that they are 1) too accurate (msec is useless for what's involved here) and 2) too big and likely to be negative in signed mode even if converted to seconds.
Return value: a timestamp, 0 means "beginning of program" (think of it as uptime)
creation_timestamp: when it has been created, UNIX timestamp
version: version of the node
codename: codename of the node
stamp: stamp of the node
id: id of the node (string representation)
url: public url of the node
title: title of the node
description: description of the node
has_password: wether node is password protected or not
bench: node bench
open_relay: wether the node is in open relay mode or not
round: current round
level: current level played
required_bench: current bench
nb_colors: number of colors playing
max_nb_colors: maximum number of colors
nb_cursors: number of cursors playing
max_nb_cursors: maximum number of cursors
nb_nodes: number of nodes playing
max_nb_nodes: maximum number of nodes
ip: node ip (string representation)
port: node port
last_ping_timestamp: UNIX timestamp of last contact with node
ping_delay_msec: ping delay, in milliseconds
available: wether node is available, wether we can connect to it
Creates a new p2p entry. Will accept NULL parameters for strings as well as arbitrary long strings, will simply cut them short if there aren't already limited to max size.
Return value: newly allocated object
entry: entry to free
Frees a p2p entry.
Return value: none.
entry: entry to represent
Gives a human-readable representation of the entry
Return value: dynamically allocated string
argc: number of args, as passed to
mainargv: args array, as passed to
maindb: the database to use
client_backends: the list of client backends to use
server_backends: the list of server backends to use
bind_ip: the IP address to bind on
bind_port: the IP port to listen on
broadcast: wether broadcast is allowed on this node
public_url: the public URL we want to show
title: the title of the node
description: the description of the node
password: the password to use
bench: the bench of the node (its power)
open_relay: act as an open relay or not
known_nodes: list of already known nodes
network_reliability: drop 1 packet out of X
trojan: act as a stupid trojan to test out automatic kick-off
Creates a new "pear to pear" node. This will fire the server and allow client access, on demand. A lot of stuff can be done in the background once this is called.
Return value: a pointer on the newly created objects.
node: the node to free
Frees a node object, all network communications will be shut.
Return value: none.
node: the node to work on
Gives a readable representation of the node
Return value: a dynamically allocated string
node: the node to poll
Polls a p2p node. This must be called on a regular basis, else network communication is stalled.
Return value: 1 on success, 0 on error.
node: the node to close
Closes a p2p node. Closing is necessary in some contexts, for instance scheme/smob instanciation when you want to release the object ressources (sockets, ports, threads...) *before* it is deleted by, for instance, a garbage collector.
Return value: 1 on success, 0 on error.
node: the node to query
Returns the node id, an id which is supposed to uniquely identify the node at run-time.
Return value: numerical id.
node: node to query
Returns a list of all known nodes, this is a plain table dump, sorted so that the most likely to be interesting to connect oneself to are listed *last*, this is just a (little) optimization, since we know we'll need to parse this list to construct a Guile object, we reverse the order.
Return value: list object containing
lw6p2p_entry_tobjects
mode: 0 for check only, 1 for full test
Runs the
p2pmodule test suite. This test can fail if one cannot bind on some network port, in a general manner it is dependent on the network environment, so it's better if there's some sort of human control on it.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/pil/index.html.
bench_result: pointer to float, will contain the bench result
progress: to inform the caller of the process advancement
Runs a standard, normalized bench on a default map. Results can be interpreted as an estimated speed/power of your computer.
Return value: 1 on success, 0 if failure
rules: the set of rules to use (defines polarity)
shape: the shape of the map (logical part)
x: the x coord to fix
y: the y coord to fix
z: the z coord to fix
Similar to
lw6map_coords_fixbut using floats, this function can be used to check cursor position boundaries. Any float pointer can be NULL.Return value: none.
rules: the set of rules to use (defines polarity)
shape: the shape of the map (logical part)
x: the x coord to fix
y: the y coord to fix
z: the z coord to fix
Similar to
lw6pil_coords_fixbut does use a wider range, say 10 times the actual size of the map, this is not to contain the cursor within the map but just to avoid overflow errors.Return value: none.
Resets a local cursors struct. Note that this need not be called very often, in fact the local cursors can cope with "dead" cursors easily. In practise, in a local game, there are only 4 of them, great maximum.
Return value: none.
cursor_id: the id of the cursor to query
Returns a pointer on the cursor with the given id.
Return value: a pointer (must *not* be freed) which is NULL is cursor does not exist.
x: a pointer to the x position, may be NULL
y: a pointer to the y position, may be NULL
mouse_controlled: a pointer to the mouse_controlled flag, may be NULL
cursor_id: the id of the cursor to query
Gets the x,y position of the cursor, and tells if it's mouse controlled.
Return value: 1 on success (cursor exists), 0 on failure (no such cursor).
cursor_id: the id of the cursor to modify
x: the x position
y: the y position
Sets the position of a cursor in the local cursors struct. If cursor does not exists, it's appended to the list.
Return value: 1 on success (cursor exists), 0 on failure (no such cursor).
cursor_id: the id of the cursor to modify
mouse_controlled: the mouse_controlled attribute
Sets which cursor is mouse controlled. If mouse_controlled is 1, the flag is set for this cursor and cleared for all others. If set to 0, only this cursor's flag is cleared.
Return value: 1 on success (cursor exists), 0 on failure (no such cursor).
cursor_id: the id of the main cursor, may be NULL
x: a pointer to the x position, may be NULL
y: a pointer to the y position, may be NULL
mouse_controlled: a pointer to the mouse_controlled flag, may be NULL
Gets the x,y position of the main cursor, and tells if it's mouse controlled.
Return value: 1 on success (cursor exists), 0 on failure (no such cursor).
cursor_id: the id of the cursor to be labelled as main cursor
Sets the main cursor attribute, the main cursor is later used, for instance, to decide how to display the map (centered on it, for instance).
Return value: 1 on success (cursor exists), 0 on failure (no such cursor).
game_state: the game state we're going to work on
seq_0: the start sequence to use, that is, the seq at round=0
timestamp: the current ticks (1000 ticks per sec, used to calibrate)
progress: object used to show the advancement of the process
Initializes a 'pilot' object, this object is responsible for interpreting messages, transform them into low-level 'ker' module function calls, and handle all the thread-spooky stuff.
Return value: a working pilot object. May be NULL on memory failure.
pilot: the object to free.
Frees a 'pilot' object, note that this might involve joining some threads, so it can 'take some time'.
Return value: none.
pilot: the object to send commands to.
command_text: the text of the command, as received form network
verified: wether we're sure this message is valid.
Sends a command and handles it internally.
Return value: 1 if OK, 0 if not.
pilot: the object to apply the local command on
command_text: the command text
This function is used to fix the annoying fact that by only sending commands a limited number of times per sec to the game state, the display always reflect an outdated position for cursors. But players do not want to see this, they want to see the cursor in the right place. So what we do is that the pilot can process "local" commands which have absolutely no effect on the game but simply update a local cursor state, only used for display. It's here in the pil module for it's where the command interpreting code is, and the fact that there's this lag is directly linked with the pilot way of doing things.
Return value: 1 on success, 0 on failure.
pilot: the object to commit.
Commits all commands sent and actually send them to the corresponding threads. This commit system allows better performance by sending, for instance, all the commands for a given round together.
Return value: none.
pilot: the object to perform the backup on
Makes a new backup in the pilot, that is, copy 'reference' to 'backup'.
Return value: 1 if OK, 0 if not.
target: the target game_state we would sync on
pilot: the object to perform the backup on
Tests wether sync functions are callable with a given game state. It verifies if the internal game_state and the target look the same.
Return value: 1 if sync functions can be called, 0 if not.
target: the game_state structure which will get the informations.
pilot: the object to get informations from.
Gets the backup from the pilot object. This is the last snapshot taken by
make_backupor, by default, the game_state the pilot was constructed with.Return value: 1 if OK, 0 if not.
target: the game_state structure which will get the informations.
pilot: the object to get informations from.
Gets the latest reference game_state, that is, a stable snapshot of the game, with no inconsistency, a game position that exists and that we can rely on. Note that getting this can take time since a global mutex is required, and computations must end before you get the data.
Return value: 1 if OK, 0 if not.
target: the game_state structure which will get the informations.
pilot: the object to get informations from.
dirty_read: wether to allow dirty read or not
Gets the informations from the pilot object, not being worried about game consistency, this one will just return the latest version available. It might even be in an inconsistent state, the position could reflect a position which will never exist. Still, the data returned will not correspond to a half-spread or half-moved game_state if dirty_read is set to 0. In this case the data has at least some basic consistency and getting this does require some mutex lock, however wait time should be fairly small (max. a round). But, in a general manner, this function is only used for display, and we do not care much if there's a small glitch, we prefer fast & smooth display.
Return value: 1 if OK, 0 if not.
pilot: the object to get informations from.
Returns a direct access to the most up-to-date game_state, without locking anything whatsoever. This is clearly to implement a dirty read mode as the name of the function suggests.
Return value: 1 if OK, 0 if not.
Returns a string describing the pilot. This is a very short description, use it for logs, and to debug stuff. By no means it's a complete exhaustive description. Still, the string returned should be unique.
Return value: a dynamically allocated string.
pilot: the object to calibrate
timestamp: the current ticks setting (1000 ticks per second)
seq: the round expected to be returned with this ticks value
Calibrates the pilot, that is, initializes it so that subsequent calls to
lw6pil_pilot_get_roundreturn consistent values.Return value: none.
pilot: the pilot to speed up
seq_inc: the number of seqs
Re-calibrates the pilot so that it speeds up a bit. This will basically increase next_seq by seq_inc.
Return value: none.
pilot: the pilot to speed up
seq_dec: the number of seqs
Re-calibrates the pilot so that it slows down a bit. This will basically decrease next_seq by seq_inc.
Return value: none.
pilot: pilot object to query
Get the initial seq (the one passed at object construction) which says what the seq was at round=0, it's just an offset.
Return value: 64-bit integer
pilot: pilot object to work on
seq: the seq to convert
Converts a seq (64-bit) to a round (32-bit). 64-bit seqs are used to avoid out-of-range errors on very long games, OTOH a round is 32-bit to garantee the atomicity of its affection, even on platforms which are not native 64-bit.
Return value: the round (32-bit integer)
pilot: pilot object to work on
round: the round to convert
Converts a round (32-bit) to a seq (64-bit). 64-bit seqs are used to avoid out-of-range errors on very long games, OTOH a round is 32-bit to garantee the atomicity of its affection, even on platforms which are not native 64-bit.
Return value: the seq (64-bit integer)
pilot: the object to query
timestamp: the current ticks setting (1000 ticks per second)
Returns the seq one should use to generate new events/commands at a given time (given in ticks).
Return value: none.
pilot: the object to query
Returns the seq of the last commit (reference game_state) for this object.
Return value: the commit seq (reference object)
pilot: the object to query
Returns the seq which is targetted in the reference game_state, this is 'how far computation will go in the reference game_state if no new commands are issued'. Note that there can always be some commands which are not yet processed, so you should not rely on this too heavily, however it gives a good idea of how things are going.
Return value: the target seq (reference object)
pilot: the object to query
Returns the current seq in the reference game_state. There's no lock on this call so don't rely on this too heavily, it just gives you an idea of wether the pilot is very late on its objectives or just on time.
Return value: the current seq (reference object)
pilot: the object to query
Returns the max current seq in the reference or draft game states. No lock on this call so don't rely on this too heavily, it just gives you an idea of computation state.
Return value: the current seq (reference object)
pilot: the object to query
Tells wether the game is over or not.
Return value: 1 if over, 0 if not
pilot: the object to query
cursor_id: the cursor_id concerned
Tells wether a given cursor was winner or not.
Return value: 1 if over, 0 if not
pilot: the object to query
Gets the winner color.
Return value: a team color, -1 if no winner and/or error.
pilot: the object to query
Gets the looser color.
Return value: a team color, -1 if no looser and/or error.
pilot: object to query
Returns a pointer on the local_cursors struct used within the object. Beware, this is the *real* pointer, not a copy...
Return value: pointer on internal object
Gets a pseudo-random start seq, why do we use this? Just to make sure even in non-network situations, seq are always very high and random, this way this is one less bug to check in networked context.
Return value: random integer value, always greater than INT_MAX
mode: 0 for check only, 1 for full test
Runs the
pilmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/scm/index.html.
mode: 0 for check only, 1 for full test
Runs the
scmmodule test suite.Return value: 1 if test is successfull, 0 on error.
name: name of the function when called from guile
req: required parameters
opt: optional parameters
rst: ? should RTFM to find that out
fcn: the function itself (pointer on the C executable code)
Wrapper on
scm_c_define_gsubr, one of the value of this function is that it does check wether it's documented before registering it. So if you try to register something not documented, it will fire a warning, which is a very nice code-quality tool.Return value: 1 on success, 0 on failure.
filename: file to execute
Loads and executes a script. Will add a log message while doing it.
Return value: 1 on success, 0 on failure.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/sim/index.html.
results: data to print
f: file to print data to
Pretty prints results on standard output.
Return value: none.
results: out param, will be cleared
Fills the struct with zeroes.
Return value: none.
results: results set to work on (in/out param)
Updates the structure so that the percent members are up to date.
Return value: 1 on success, 0 on failure.
argc: argc as passed to
mainargv: argv as passed to
mainresults: out param, results of the simulation
nb_teams: number of teams
bot_backend: bot backend to use
Runs a simulation of several battle/games on the default map using different team settings. Will test teams up to the given number, for instance if you give 3 as an argument, will run tests with teams 0, 1 and 2 (that's to say a total of 3 teams).
Return value: 1 on success, 0 on failure.
argc: argc as passed to
mainargv: argv as passed to
mainresults: out param, results of the simulation
Runs a simulation of several battle/games on the default map using different team settings. Will test the most common colors only, with the most popular bot.
Return value: 1 on success, 0 on failure.
argc: argc as passed to
mainargv: argv as passed to
mainresults: out param, results of the simulation
Runs a simulation of several battle/games on the default map using different team settings. Will test all colors, with the most popular bot.
Return value: 1 on success, 0 on failure.
mode: 0 for check only, 1 for full test
Runs the
simmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/snd/index.html.
backend: sound backend to use
fx_id: sound fx id
Plays a sound fx.
Return value: 1 on success, 0 on error
backend: sound backend to use
map_dir: map directory, to search additionnal files
music_path: config entry containing multiple paths
music_file: relative/local name of a music file
Tells wether a file is a valid music file, typicallly based on file existence and extension. Not bullet proof, file might actually not be loadable, but chances are 99%.
Return value: 1 if music file, 0 if not
backend: sound backend to use
map_dir: map directory, to search additionnal files
music_path: config entry containing multiple paths
music_file: relative/local name of a music file
Plays a music file.
Return value: 1 if OK, 0 if not.
backend: sound backend to use
music_path: config entry containing multiple paths
music_filter: string filter, must be present
music_exclude: string filter, must not be present
Plays a random music file. The filter and exclude mecanisms are not complete regex filters, only a quick and dirty feature which should still help in some cases, such as sorting musics for the menus and for the rest.
Return value: 1 if OK, 0 if not.
backend: sound backend to use
Stops the music.
Return value: none.
backend: the graphical backend to use
fx_volume: sound fx volume
water_volume: water sounds volume
music_volume: music volume
Sets up the sound backend for good, initializing a playback engine ready to play sounds and set to defaults. This call can typically fail if there's no device available, if the user doesn't have enough rights to access the hardware, and so on.
Return value: 1 on success, 0 if not
backend: sound backend to use
volume: sound fx volume
Changes sound fx volume.
Return value: none.
backend: sound backend to use
volume: water sounds volume
Changes water sounds volume.
Return value: none.
backend: sound backend to use
volume: music volume
Changes music volume.
Return value: none.
backend: sound backend to use
Polling function, must be called on a regular basis.
Return value: none.
backend: the backend to quit
Uninitializes the backend, that is, releases resources, stops playback.
Return value: none.
backend: the backend to represent
Returns a readable version of the backend object.
Return value: a newly allocated pointer.
argc: argc, as passed to
mainargv: argv, as passed to
mainList available snd backends. The hash contains pairs with id and name for each backend. The id is the technical key you can use to load the backend, the name is something more readable you can display in an interface. The backend objects themselves are not instanciated by this (in fact, they are, but released on the fly) you need to load and initialize them afterwards.
Return value: hash containing id/name pairs.
argc: argc, as passed to
mainargv: argv, as passed to
mainname: string containing snd key, typically got from
lw6snd_get_backendsCreates a snd backend, this is just about loading the dynamic library if needed, and/or check snd engine is available, and connect to it. It does not perform initialization.
Return value: snd backend.
backend: snd backend to destroy
Frees the ressources associated to a snd, which must have been properly uninitialized before.
Return value: none.
mode: 0 for check only, 1 for full test
Runs the
sndmodule test suite. If run in check mode (0), won't really perform the test, since it could fail because of hardware problems, context, permissions...Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/snd/mod-csound/index.html.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/snd/mod-ogg/index.html.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/srv/index.html.
backend: backend to use
Initializes a server backend. Must be performed before any other call.
Return value: 1 on success, 0 on failure
backend: unitialize a srv backend
Closes a srv, but does not free all ressources.
backend: server backend to use
tcp_accepter: TCP mode accepter
node_info: this node information
remote_id: remote host id (out param)
remote_url: remote host URL (out param, dynamically allocated)
Analyzes new TCP messages, typically handled within the accepter object. The result is a combination of bitwise flags, namely namely
LW6SRV_ANALYSE_DEAD,LW6SRV_ANALYSE_UNDERSTANDABLE, andLW6SRV_ANALYSE_OOBwhich helps knowing what to do with message.Return value: bitwise flag.
backend: server backend to use
udp_buffer: UDP buffer
node_info: this node information
remote_id: remote host id (out param)
remote_url: remote host URL (out param, dynamically allocated)
Analyzes an UDP buffer, received on a socket. The result is a combination of bitwise flags, namely namely
LW6SRV_ANALYSE_DEAD,LW6SRV_ANALYSE_UNDERSTANDABLE, andLW6SRV_ANALYSE_OOBwhich helps knowing what to do with message.Return value: bitwise flag.
backend: server backend to use
node_info: this node information
oob_data: OOB data received
Processes an OOB message sent from a client.
Return value: 1 if OK, 0 if not.
backend: server backend to use
local_url: local url to use (to send to peer)
remote_url: remote url to communicate with
remote_ip: remote ip to communicate with
remote_port: remote port to communicate with
password: password to use (the real password, not a hash)
local_id: the local 64-bit id
remote_id: the remove 64-bit id
dns_ok: 1 if no DNS mismatch, 0 if situation is unclear
network_reliability: the greater, the more reliable it is
recv_callback_func: callback fired when receiving data
recv_callback_data: additionnal data passed to callback
Opens a server connection. One might wonder, clients open connections, but servers? To some extent, this is the equivalent of
acceptin the socket API, it will actually create an object one can then use to communicate. Be carefull with the implementation of the callback, keep in mind it can be called any time in multithreaded mode, you need to set up locks when accessing shared objects, including, but not limited to, your own data buffers.Return value: new connection object.
connection: connection to use
tcp_accepter: TCP accepter holding data
When data is receivedm feeds the server object with data. Will typically fire the callback receive function if there are actually some data stuff.
Return value: 1 some data processed, else 0
connection: connection to use
When data is receivedm feeds the server object with data. Will typically fire the callback receive function if there are actually some data stuff.
Return value: 1 some data processed, else 0
backend: server backend to use
connection: connection to close
Closes a connection, will also free it.
Return value: none.
backend: server backend to use
connection: connection to use
physical_ticket_sig: physical ticket
logical_ticket_sig: logical ticket
logical_from_id: logical id of sender
logical_to_id: logical id of receiver
message: string with the message to send
Sends a message. The added value with a plain send is that it handles all the special ticket fields.
Return value: 1 on success, 0 if not
backend: server backend to use
connection: connection to use
Polling function, to be called on a regular basis.
Return value: none.
backend: backend to use
connection: connection to represent
Gives a human readable representation of the connection.
Return value: dynamically allocated string.
ip: ip address to listen on
port: port IP to bind to
Starts a server, binds the socket(s) and returns a listener object which can in turn be used to create connections.
Return value: new listener object.
listener: listener to stop
Stops a listener object, and frees it.
Return value: none.
remote_ip: remote IP address
remote_port: remote port
sock: the socket handler (either TCP or UDP)
first_line: the first line of data (can be NULL)
Create a new OOB structure, copying required objects. We need to make copies for this is for usage in a separate thread. The thread member is not set here since the right way to do things is first to set up data then to fire the thread.
Return value: new object
oob: the object to free
Frees an OOB structure.
Return value: none
Returns the list of the default srv backends.
Return value: comma separated string, must not be freed.
argc: argc, as passed to
mainargv: argv, as passed to
mainList available srv backends. The hash contains pairs with id and name for each backend. The id is the technical key you can use to load the backend, the name is something more readable you can display in an interface. The backend objects themselves are not instanciated by this (in fact, they are, but released on the fly) you need to load and initialize them afterwards.
Return value: hash containing id/name pairs.
argc: argc, as passed to
mainargv: argv, as passed to
mainname: string containing srv key, typically got from
lw6srv_get_backendsCreates a srv backend, this is just about loading the dynamic library if needed, and/or check srv engine is available, and connect to it. It does not perform initialization.
Return value: srv backend.
backend: backend to destroy
Destroys a srv backend.
Return value: none.
client_ip: the client ip, will be freed when accepter is freed, do not copy it
client_port: the client port
sock: the socket used
Creates a tcp_accepter object.
Return value: none
tcp_accepter: the object to free
Frees a tcp_accepter object.
Return value: none
mode: 0 for check only, 1 for full test
Runs the
srvmodule test suite.Return value: 1 if test is successfull, 0 on error.
client_ip: the client ip, will be freed when object is freed, do not free it
client_port: the client port
line: the line received, will be freed when object is freed, do not free it
Creates an udp_buffer object.
Return value: none
udp_buffer: the object to free
Frees a udp_buffer object.
Return value: none
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/srv/mod-httpd/index.html.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/srv/mod-tcpd/index.html.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/srv/mod-udpd/index.html.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/sys/index.html.
keyword: the option to match, without the prefix "-" or "–"
argv_string: the argv value, for instance argv[1]
This is an utility function which allow the program to handle options in a uniform manner. Key comparison is insensitive, that is, –option and –OPTION are equivalent. Besides, -option and –OPTION are equivalent too. Liquid War 6 documentation mentions options in lowercase with a double dash (–option) by default, but it's a fact, the program supports variants. This is just for convenience, the philosophy behind this behavior is "be as permissive as possible when interpreting input, and as strict as possible when generating output". In fact, it's even said that Liquid War 6 will accept the argument without any prefix dash as being valid... This is to say running "liquidwar6 –option" is the same as running "liquidwar6 option". But, this is a secret 8-)
Return value: non zero if it matches, 0 if it doesn't.
argc: the number of arguments, as passed to
mainargv: an array of arguments, as passed to
mainkeyword: the keyword to match
Parses all command-line arguments, searching for one precise "–key[=...]" entry.
Return value: 1 if key is present, 0 if not.
argc: the number of arguments, as passed to
mainargv: an array of arguments, as passed to
mainkeyword: the keyword to match
Parses all command-line arguments, searching for one precise "–key=value" pair, and returns the value.
Return value: a pointer to the value. May be NULL. Must be freed.
argc: the number of arguments, as passed to
mainargv: an array of arguments, as passed to
mainkeyword: the keyword to match
Parses all command-line arguments, searching for one precise "–key=value" pair, and returns the value. If a corresponding environment variable is available, but no command-line parameter was passed, the environment variable is intepreted. Such environment variables are uppercased, prefixed by "LW6_" and "_" replaces "-". The environment variable will be overriden if the command-line parameter is present.
Return value: a pointer to the value. May be NULL. Must be freed.
argc: argc as passed to main
argv: argv as passed to main
Chooses between the two test modes "check" or "test". Check (value 0) is a lighter test which should never fail even if some special hardware or environment is missing. Test (value 1) is a more complete test which does things which *can* require some special conditions. Function will log and be verbose is syntax is not correct.
Return value: 1 if complete test must be run, 0 is only check
free_func: optional callback used to free memory when stored date is a pointer. Can be NULL when one stores non dynamically allocated data, such as an integer or a static array.
Creates an empty assoc. There's a difference between NULL and an empty assoc. The empty assoc would (in Scheme) be '() whereas NULL corresponds to undefined "is not a assoc and will generate errors if you ever call assoc functions on it". Such created assoc are not performant hash tables but slowish "strcmp me for each key" associative arrays, the key being a "char *" string and the value a "void *" pointer.
Return value: a pointer to the newly allocated associative array. Must be freed with
lw6sys_assoc_free.
assoc: the assoc to be freed.
The function will cascade delete all elements, using (if not NULL...) the callback passed when first creating the assoc.
Return value: void
assoc: the assoc to test
key: the key to search
Not a very fast function, since on a "big" assoc, strcmp will be called internally until the key is found.
Return value: non-zero if there's an entry with the corresponding key.
assoc: the assoc to query
key: the key of which we want the value
Return value: a void pointer to the data contained in the assoc. Note that the pointer on the actual data is returned, that is, if it's static data, you must not try to free it... As long as memory management is concerned, destroying the assoc will actually free the data if needed.
assoc: the assoc to modify
key: the key we want to updated
value: the new value
Sets a value in an associative array. The key pointer need not be persistent, it can be freed after affectation. In fact a new string will be created internally. This is not true for the value, it's hard to find way to copy "any object". So if you want an associative array of strings, key can disappear after calling this function, but not value. The function passed as free_func when creating the assoc will be used to free stuff whenever needed (unset or free).
Return value: void
assoc: the assoc concerned
key: the key to unset
Clears an entry in an associative array. The callback passed when creating the assoc will be called if needed, to free the data automatically.
Return value: void
assoc: the assoc to work on
Returns a list containing all the keys of the assoc. The list must be free with lw6sys_list_free by the caller. This list copies all the keys of the assoc, so it is safe to use it once the assoc is deleted. However the keys will of course be of little interest in this case. But the program won't segfault.
Return value: the list of keys.
assoc: the assoc to work on
func: a callback to call on each entry
func_data: a pointer on some data which will be passed to the callback
Executes a function on all assoc items. The func_data parameter allows you to pass extra values to the function, such as a file handler or any variable which can not be inferred from list item values, and you of course do not want to make global...
Return value: void
assoc: the assoc to work on
func: a callback to call on each entry, may be NULL
func_data: a pointer on some data which will be passed to the callback
Executes a function on all assoc items, like
lw6sys_assoc_sort_and_mapbut befor doing so, sorts all entries in alphabetical order.Return value: void
assoc: the assoc to duplicate, can be NULL
dup_func: the function which will be called to duplicate data
Duplicates an assoc. All keys will be copied so that if the first assoc is deleted, the duplicated one is fine. Additionnaly, dup_func will be called with all data fields. If dup_func is NULL, then data values will simply be copied. This is likely to be usefull when data is not dynamically allocated.
Returned value: a newly allocated assoc.
skip: number of calls to skip
Returns the current backtrace as a comma separated list. This can typically be used for debugging purposes. Not available on some platforms, including mingw32, it requires backtrace_symbols to be defined. Note that this function calls internal string functions so it makes usage of the sys module in many ways, therefore should be used only in other modules, it can't be used for debugging of internal memory functions for instance. To debug those, use backtrace_symbols_fd directly (or maybe just gdb...). The skip parameter allows you to skip caller's stack, 0 will display everything but
lw6sys_backtraceitself.Return value: dynamically allocated string
Will set up a default memory bazooka, a slow yet convenient tool to track down and hopefully kill memory leaks. Named bazooka after a night wasted to track down an unfoundable leak... BAZOOOOOOKA!!!
Return value: 1 if success, 0 if failed.
size: number of items (calls to malloc) to keep
Resizes, the memory bazooka. What's this? It's an inelegant yet efficient tool to track down memory leak. Memory bazooka will keep track of every call to malloc, keeping a trace of what has been malloced, where it has been called (from which file, which line), how much memory was allocated, it will even show you what's at the address in a 0-terminated string-friendly fashion. Of course this slows down the program, so in production, you might set this to 0, but for debugging, a million bazooka is worth the megabytes and CPU cycles it wastes.
Return value: 1 if success, 0 if failure.
The companion of
lw6sys_set_memory_bazooka_size. This function will return how many calls to malloc can be traced. A return value of 0 indicates that feature is disabled.Return value: size of the bazooka array.
state: the state of the eraser
Sets the memory bazooka eraser state. Note that to really work, it requires the memory bazooka to be "big enough".
Return value: 1 if activated, 0 if not. Note that the main reason for it not to be activated is if the memory bazooka has zero size.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you how many timesmallochas been called.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Provided you have always called the
LW6SYS_FREEmacro to free memory, this function will tell you how many timesfreehas been called.Return value: the number of calls to
lw6sys_freesince program was started.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you the current number of pointer returned byLW6SYS_MALLOCanLW6SYS_CALLOC, currently alive on the heap.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you the maximum of pointers returned bymallocthat were present at the same time on the heap.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you how many bytesmallochas reserved.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Provided you have always called the
LW6SYS_FREEmacro to free memory, this function will tell you how many bytesfreehas freed.Return value: the number of calls to
lw6sys_freesince program was started.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you the current number of bytes returned byLW6SYS_MALLOCanLW6SYS_CALLOC, currently alive on the heap.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Provided you have always called the
LW6SYS_MALLOCanLW6SYS_CALLOCto allocate memory, this function will tell you the maximum bytes returned bymallocthat were present at the same time on the heap.Return value: the number of calls to
lw6sys_mallocorlw6sys_callocsince program was started.
Returns true if memory bazooka data are perfectly trustable, that is, it has never been resetted or resized.
Return value: 1 if trustable, 0 if not.
Reports memory bazooka diagnostics on the console. Carefull, this one is not reentrant, call at the end of your program when all threads are joined.
Return value: 1 if no allocated stuff left, 0 if there are still malloc'ed stuff
Returns the name of the package. This is the
PACKAGE_TARNAMEconstant defined by the GNU Autoconf ./configure script. While it's always possible to use the defined constant directly, using this function will return the value defined when compiling the binary, not the one you're using when compiling another program relying on Liquid War as a library.Return value: a non-NULL string "liquidwar6", must not be freed.
Returns the name of the package, in a user friendly form, which can include spaces, for instance. This is the
PACKAGE_NAMEconstant defined by the GNU Autoconf ./configure script. While it's always possible to use the defined constant directly, using this function will return the value defined when compiling the binary, not the one you're using when compiling another program relying on Liquid War as a library.Return value: a non-NULL string "Liquid War 6", must not be freed.
Returns the description of the package. This is the
PACKAGE_STRINGconstant defined by the GNU Autoconf ./configure script. It's the concatenation ofPACKAGE_NAMEandVERSION. While it's always possible to use the defined constant directly, using this function will return the value defined when compiling the binary, not the one you're using when compiling another program relying on Liquid War as a library.Return value: a non-NULL string "Liquid War 6 <version>", must not be freed.
Returns the version of the program. This is the
VERSIONconstant defined by the GNU Autoconf ./configure script. Same asPACKAGE_VERSION. Note that while using a function to getPACKAGE_TARNAMEmight seem useless, having both ways to get the version, that is, a function and a constant, is very usefull. Think, for instance, that a dynamically loaded shared library might need to check its own version against the version of the core program.Return value: a non-NULL string, which must not be freed.
Returns the the program codename. This is the little name of the version. It's been decided that all LW6 releases would take the name of a famous general, warrior, whatever. For instance, it could be "Napoleon".
Return value: a non-NULL string, traditionnally the name of a famous general, someone which has been involved in war. Must not be freed (I mean, the string, not the general).
Returns the program stamp. This is like a serial number. It's is not the same as the version. The version is meant to be set to something readable. This is just a cryptic thing, incremented at each ./configure or each developper's "I feel like it needs to be incremented". The idea is just to keep (one more...) track of which source code is build. Ideally, this would be plugged to the source revision control system but this has some drawbacks, including that it would require it to modify files before commiting them, which is not safe, and almost impossible if you sign archives. One more point: this is a string. It's true the return value is actually a string containing the representation of an integer, but because all other build parameters are strings, and because we don't know what the future reserves, it's a string.
Return value: a non-NULL string like "42", which must not be freed.
Returns an md5 checkum which is caculated from C (.c and .h) source files. This is complementary with the build stamp. By default the stamp will be enough to check what has been compiled, but one can always imagine a case where Bob compiles something a little different than Alice, with the same stamp, incremented by 1 from a common source tree. They apply their own patches, for instance. This md5sum double-checks that two binaries have been built from the same sources. Note that this is not the md5 checksum of the generated binary. Nor does it include any information about scheme scripts and data.
Return value: a non-NULL string, which must not be freed.
Returns a (very) short copyright information about the program.
Return value: a non-NULL string, single line whithout '\n' at the end. Must not be freed.
Returns the license for the program (GNU GPL v3 or later).
Return value: a non-NULL string, single line whithout '\n' at the end. Must not be freed.
Returns the URL of the game, its homepage.
Return value: a non-NULL string, single line whithout '\n' at the end. Must not be freed.
Returns the URL for bugs, the bug reports page.
Return value: a non-NULL string, single line whithout '\n' at the end. Must not be freed.
Returns the arguments passed to the GNU Autoconf ./configure script when buildling the game. Very usefull to know how the binary was generated, that is, what kind of optimizations are peculiar settings it uses.
Return value: a non-NULL string, which, passed to ./configure again, would hopefully generate the same binary. Must not be freed.
Returns __VERSION__ GCC preprocessor value, that is, the human readable version of the compiler.
Return value: a non-NULL string, must not be freed.
Returns the arguments which would allow another program to use liquidwar6 as a library. Typically, pass this to gcc when compiling your sources. Basically contains "-I" switches which tell where the headers are.
Return value: a non-NULL string, which must not be freed.
Returns the arguments which would allow another program to link against liquidwar6. Pass this to gcc or libtool when compiling your program. Basically contains a "-L" option which says where the library is. Note that this will only allow you to link against the main libliquidwar6 library, but not the dynamically loaded modules.
Return value: a non-NULL string, which must not be freed.
Returns the value return by the standard shell
hostnamecommand on the machine where the game has been built. Usefull to track binaries and know where do they come from.Return value: a non-NULL string, must not be freed.
Returns the compilation date. While this information can easily be obtained with the C
__DATE__macro, having this function is convenient for it returns a value which is the same for the whole program, and does not possibly change in every file.Return value: a non-NULL string, must not be freed.
Returns the compilation date. While this information can easily be obtained with the C
__TIME__macro, having this function is convenient for it returns a value which is the same for the whole program, and does not possibly change in every file.Return value: a non-NULL string, must not be freed.
Returns the CPU this program is designed for. Convenient on i386 compatible CPUs to know which flavor (i386, i586...) the binary is made for.
Return value: a non-NULL string, must not be freed.
Returns the endianness of the computer.
Return value: 'little' (x86-like) or 'big' (ppc-like), as a string. Must not be freed.
Returns the system pointer size, in bytes.
Return value: 4 for 32-bit, 8 for 64-bit.
Tells wether CPU belongs to x86 family or not.
Return value: 1 if x86, 0 if not
Returns the OS this program is designed for. Usefull for bug reports.
Return value: a non-NULL string, must not be freed.
Tells wether the program was compiled for a GNU system, or not.
Return value: 1 if compiled on windows, 0 if not
Tells wether the program was compiled for a UNIX system, or not.
Return value: 1 if compiled on windows, 0 if not
Tells wether the program was compiled for Microsoft Windows, or not.
Return value: 1 if compiled on windows, 0 if not
Tells wether the program was compiled for Mac OS X, or not.
Return value: 1 if compiled on OS X, 0 if not
Tells wether the program was compiled for GP2X, or not.
Return value: 1 if compiled on OS X, 0 if not
Returns the top source directory, when the game was built. This can seem useless and non relevant on the end-user's machine, but... it's a must-have for developpers and packagers. Without this, binaries would never find their associated data, especially when building outside the source tree. Or, testing the game would be impossible without installing it, given the fact that most of the code is in scripts that are stored in /usr/local by default, this would be painfull. So this function is here to help finding data within the source tree when the game is not installed yet. Note that the function is rather clever, since it will automatically try to remove useless '../' sequences at the beginning of a possibly relative path.
Return value: a non-NULL string, must not be freed.
Returns the
prefixvalue as given to the GNU Autoconf ./configure script. Used to deduce the path to other directories and files.Return value: a non-NULL string, "/usr/local" by default. Must not be freed.
Returns the
datadirvalue defined by the GNU Autoconf ./configure script. This is not the value which can be overriden by the Liquid War 6 specific. "–data-dir" option.datadiris usually something like "/usr/local/share" while the actual Liquid War 6 defined data dir is a more profound path which includes the name of the package, its version, and so on.Return value: a non-NULL string, "/usr/local/share" by default. Must not be freed.
Returns the
libdirvalue defined by the GNU Autoconf ./configure script. This is not the value which can be overriden by the Liquid War 6 specific. "–mod-dir" option.libdiris usually something like "/usr/local/lib" while the actual Liquid War 6 defined module dir is a more profound path which includes the name of the package, its version, and so on.Return value: a non-NULL string, "/usr/local/lib" by default. Must not be freed.
Returns the
includedirvalue defined by the GNU Autoconf ./configure script. As for other options, it's interesting to have this value, this enables the program to inform people who want to hack the game of the place headers are supposed to be installed.Return value: a non-NULL string, "/usr/local/include" by default. Must not be freed.
Returns the
localedirvalue defined by the GNU Autoconf ./configure script. Used as an argument for gettext / libintl functions.Return value: a non-NULL string, "/usr/local/share/locale" by default. Must not be freed.
Returns the
docdirvalue defined by the GNU Autoconf ./configure script. Used to write consistent XML file headers.Return value: a non-NULL string, "/usr/local/share/doc/liquidwar6" by default. Must not be freed.
Tells wether console is enabled or not.
Return value: "yes" or "no", must no be freed.
Tells wether gtk is enabled or not.
Return value: "yes" or "no", must no be freed.
Tells wether the graphical mod-gl backend was compiled.
Return value: "yes" or "no", must no be freed.
Tells wether the audio mod-csound backend was compiled.
Return value: "yes" or "no", must no be freed.
Tells wether the audio mod-ogg backend was compiled.
Return value: "yes" or "no", must no be freed.
Tells wether the network mod-http backend was compiled.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled with openmp support.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled in optimize mode.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled in allinone mode.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled in fullstatic mode.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled with paranoid memory management.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled with suitable informations for gprof.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled with the '-finstrument-fonctions' GCC flag.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled for later use with Google Profiler support.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled with suitable informations for gcov.
Return value: "yes" or "no", must no be freed.
Tells wether the game was compiled for later use with valgrind.
Return value: "yes" or "no", must no be freed.
Returns the internal bin-id value, which does not mean anything but changes at each build.
Return value: an integer
Dumps in the log file the whole program pedigree, host, modules, that is, what are the values of all the build options. Usefull for bug reports.
Return value: none.
data: the data to process
len: the length, in bytes, of the data to process
Creates a checksum from a byte array. This could be mapped on any standard CRC-32 and/or MD5 algorithm, but licence issues for those are such a headache that for the sake of simplicity, it's wrapped here. In LW6 context, we do not really really fear any attack for these checksums are used internally to track bugs and check, for instance, that two game states are actually the same on two distant computers in a network game. Data encryption and security of network links is another debate. Additionnally, this function returns an integer, easier to handle in standard C than any malloc'ed stuff.
Return value: the checksum, as an integer.
value: the string to process
Creates a checksum from a string. This is a convenience function to save the programmer the hassle of calling strlen before any checksum calculation.
Return value: the checksum, as an integer.
value: the integer to process
Creates a checksum from an integer. This is a convenience function to save the programmer the hassle of passing a pointer to the integer with the size of it each time there's a checksum to do. Additionnally, with this one you can pass an int8 or an int16, and function will work just the same indenpendantly of endianness.
Return value: the checksum, as an integer.
value: the integer to process
Creates a checksum from an integer. This is a convenience function to save the programmer the hassle of passing a pointer to the integer with the size of it each time there's a checksum to do. This function handles 64-bit long long integers..
Return value: the checksum, as an integer.
whd: a pointer to the wh struct to be processed
Creates a checksum from the given structure. Convenience function to save the hassle of passing a pointer to and the size of the
lw6sys_wh_tstruct each time, knowing that there are very often checksums calculated on it. Also avoids endianess issues.Return value: the checksum, as an integer.
xyz: a pointer to the xy struct to be processed
Creates a checksum from the given structure. Convenience function to save the hassle of passing a pointer to and the size of the
lw6sys_xy_tstruct each time, knowing that there are very often checksums calculated on it. Also avoids endianess issues.Return value: the checksum, as an integer.
checksum: a pointer to the previous checksum
data: the data to process
len: the length, in bytes, of the data to process
Creates a checksum from the given data. The difference with
lw6sys_checksumis that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
checksum: a pointer to the previous checksum
value: the string to process
Creates a checksum from the given string. The difference with
lw6sys_checksum_stris that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
checksum: a pointer to the previous checksum
value: the integer to process
Creates a checksum from the given integer. The difference with
lw6sys_checksum_int32is that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
checksum: a pointer to the previous checksum
value: the integer to process
Creates a checksum from the given integer. The difference with
lw6sys_checksum_int64is that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
checksum: a pointer to the previous checksum
whd: a pointer to the wh struct to be processed
Creates a checksum from the given structure. The difference with
lw6sys_checksum_whdis that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
checksum: a pointer to the previous checksum
xyz: a pointer to the xy struct to be processed
Creates a checksum from the given structure. The difference with
lw6sys_checksum_xyzis that this one updates an existing checksum, thus enabling the programmer to call it sequentially and get a global checksum on different sources.Return value: none.
f: the value to convert, from 0.0f to 1.0f
Converts a floating point value between 0.0f and 1.0f to its 8-bit equivalent between 0 and 255. Usefull in color conversion.
Return value: an integer between 0 and 255.
i: the value to convert, from 0 to 255
Converts an 8-bit value between 0 and 255 to its floating-point equivalent between 0.0f and 1.0f. Usefull in color conversion.
Return value: a float between 0.0f and 1.0f.
color_f: the color to convert
Converts a color from floating point format to the integer "0 to 255" common format. All fields (RGBA) are converted.
Return value: the color in 8-bit format.
color_f: the converted color (pointer must point to writable memory)
color_8: the color to convert
Converts a color from the integer "0 to 255" common format to floating point format. All fields (RGBA) are converted.
Return value: none.
color_f: the color to convert
Converts a color from floating point format to a single integer, where all fields (RGBA) are serialized. This serialization is endianess independant. Could be used directly by low-level libraries such as SDL.
Return value: the color serialized in an integer.
color_8: the color to convert
Converts a color from common "0 to 255" structured format to a single integer, where all fields (RGBA) are serialized. This serialization is endianess independant. Could be used directly by low-level libraries such as SDL.
Return value: the color serialized in an integer.
color_f: the converted color (point must point to writable memory)
color_i: the color to convert
Converts a color from a serialized integer format to a floating point structure.
Return value: none.
color_i: the color to convert
Converts a color from a serialized integer format to a "0 to 255" based structure.
Return value: the converted color (structure).
ascii: the color to convert
Converts a color from a human readable string to a "0 to 255" based structure. The string must be of the form "#RRGGBBAA" or "#RGB", in a general manner any HTML-valid value should work.
Return value: the converted color (structure).
color_f: the converted color (pointer must point to writable memory)
ascii: the color to convert
Converts a color from a human readable string to a float based structure. The string must be of the form "#RRGGBBAA" or "#RGB", in a general manner any HTML-valid value should work.
Return value: none.
color_8: the color to convert
Converts a color from a "0 - 255" integer based structure to its readable form "#RRGGBBAA". If alpha is 255 (0xFF), that is, if it's opaque, then the "AA" part is ommitted.
Return value: a newly allocated string.
color_hsv: the target color, in HSV format
color_8: the source color, in RGB 256 format
Converts from HSV to RGB. Usefull for color manipulation, since most colors are stored in RGB but HSV is convenient for transformation. Alpha layer is kept as is.
Return value: none.
color_hsv: the source color, in HSV format
Converts from RGB to HSV. Usefull to make colors transformed in HSV format usable again by all display routines, which consume RGB. Alpha layer is kept as is.
Return value: the RGB color.
color_hsv: the source color, in HSV format
invert_h: wether to invert the hue
invert_s: wether to invert the saturation
invert_v: wether to invert the value
Inverts an HSV color, calling it with 1,0,0 the color will become a color with opposite hue but same saturation and same value.
Return value: none.
size: number of the color array (number of items)
colors: the colors to compute
Tries to find out the "average" color from an array of colors. The algorithm is far from perfect, but should output a color which reflects the colors passed in.
Return value: the (inexact) average color.
color1: first color
color2: second color
coeff: the ponderation coefficient
Tries to find a color between the two colors passed as an argument. The coefficient can be used, to set the relative weight of each color. Using 0 will return color1, 1 will return color2 and 0.5 will make an average between the two colors. Any value between 0 and 1 can be used.
Return value: the (inexact) ponderated color.
color1: first color
color2: second color
Calculates the distance between two colors. The unit is arbitrary, a big value means "colors are different", 0 means they are the same. A distance of 1 corresponds to colors which have barely anything in common, but the result can still be greater than 1. Alpha layer is not taken in account.
Return value: the distance.
color1: the first color to compare
color2: the second color to compare
Compares two colors.
Return value: 1 if they are the same, 0 if not.
color: the color to modify
Make a color "solid" that is make it not transparent at all.
Return value: none.
color: the color to modify
Make a color "solid" that is make it not transparent at all.
Return value: none.
str: string to convert
Just a plain wrapper on
atoi, it's here for API consistency. Will check if str is NULL (and in this case return 0).Return value: an integer.
str: string to convert
Wrapper on
atoll, it's here for API consistency. Will check if str is NULL (and in this case return 0).Return value: a 64-bit integer.
str: string to convert
Transform a string into a boolean value. Accepts "0"/"1" in input, but also y/n, yes/no, true/false, on/off. Will check if str is NULL (and in this case return 0).
Return value: an integer, 0 or 1.
str: string to convert
A wrapper on
atof, makes sure the locale used is C (default) and won't change the decimal separator whatsoever. Usefull for serialization for instance. Will check if str is NULL (and in this case return 0).Return value: a float.
value: the integer to convert
Converts an integer to a string, the advantage of this function is it allocates memory, and does the dirty job.
Return value: a newly allocated pointer, must be freed, may be NULL.
value: the integer to convert
Converts a 64-bit integer to a string, the advantage of this function is it allocates memory, and does the dirty job.
Return value: a newly allocated pointer, must be freed, may be NULL.
value: the boolean to convert
Converts a boolean to a string, the advantage of this function is it allocates memory, and does the dirty job.
Return value: a newly allocated pointer, must be freed, may be NULL.
value: the float to convert
Converts a float to a string, the advantage of this function is it allocates memory, and does the dirty job.
Return value: a newly allocated pointer, must be freed, may be NULL.
argc: argc as passed to
mainargv: argv as passed to
mainGet the default pid file, used to lock daemon and avoid 2 daemons running at the same time.
Return value: newly allocated string
pid_file: the pid file used for the daemon
Calls
fork() internally to put the process in the program, make it a daemon. Note this won't work on all platforms, for instance it won't work on MS-Windows but this is rarely an issue as MS-Windows users are rarely concerned with detaching a program from a tty. Note that this isn't a wrapper onfork(), the return value is different, 1 on success, 0 if failed.Return value: a process ID on success, 0 on failure.
pid_file: the pid file used for the daemon
Removes the daemon pid file. Can be called safely even if daemon wasn't started.
Return value: 1 on success, 0 on failure
mode: the debug mode, 1 if set, 0 if not.
Sets the debug mode.
user_dir: the user directory, where user can write data.
Clears the dump file. That is, resets it to a "0 byte" file.
Return value: none.
user_dir: the user directory, where user can write data.
content: the content to be written in the dump file.
Writes the dump file onto the disk. The dump is used for special error messages which do not really fit in the standard log, and require a special treatment. In pratice, it's used to log fatal script (Guile) errors.
Return value: 1 if success, 0 if failure.
Gets the ENV separator, that is, for instance, the character used to separate paths in environment variables. Typically, this would be ":" on GNU and ";" on Microsft platforms.
Return value: the ascii character code.
Gets the ENV separator, that is, for instance, the character used to separate paths in environment variables. Typically, this would be ":" on GNU and ";" on Microsft platforms.
Return value: a pointer to a single 0-terminated character string which contains the character. Must not be freed.
value1: the left part to be concatenated
value2: the right part to be concatenated
Concatenates two values and puts the ENV separator, as returned by
lw6sys_env_separator_charbetween them.Return value: the concatenated string, must be freed.
keyword: the keyword to be searched in the environment variables.
Searches environment variables for the given keyword. The keyword will be fixed so that all dashes "-" characters are replaced by underscores "_" characters. Characters will be changed to uppercase. Any non alphanumeric character will be replaced by "_". Finally, an "LW6_" prefix will be added. That is to say, calling this function with "my-param" will search for the "LW6_MY_PARAM" environment variable.
Return value: 1 if the environment variable exists, 0 if not.
key: the environment variable to get.
Searches environment variables for the given value. This is a wrapper over the standard C getenv, the difference is it will return a dynamically allocated pointer, and on some platforms will query specific OS functions.
Return value: the value for the given keyword. May be NULL. Must be freed.
keyword: the keyword to be searched in the environment variables.
Searches environment variables for the given value. The keyword will be fixed so that all dashes "-" characters are replaced by underscores "_" characters. Characters will be changed to uppercase. Any non alphanumeric character will be replaced by "_". Finally, an "LW6_" prefix will be added. That is to say, calling this function with "my-param" will search for the "LW6_MY_PARAM" environment variable.
Return value: the value for the given keyword. May be NULL. Must be freed.
keyword: the environment variable to set
value: the value of the environment variable to set
Sets the environment variable to a given value. If value is NULL, variable is unset. Note that unlike lw6sys_getenv_prefixed, this function does not transform the keyword into "LW6_..." before setting the value, so it's your responsability to call "lw6sys_keyword_as_env" if needed.
Return value: 1 if success, 0 if failed
keyword: the keyword to be searched in the environment variables.
value: the value of the environment variable to set
Sets the environment variable to the given value. The keyword will be fixed so that all dashes "-" characters are replaced by underscores "_" characters. Characters will be changed to uppercase. Any non alphanumeric character will be replaced by "_". Finally, an "LW6_" prefix will be added. That is to say, calling this function with "my-param" will set the "LW6_MY_PARAM" environment variable.
Return value: 1 if success, 0 if failure
value: the value, a list of item separated by... the separator
Splits the environment value into a list of strings containing each element. All strings are dynamically allocated, but they will be freed automatically when the list is freed.
Return value: a list of strings.
Gets the home directory of the user. Used internally to calculate the
user-dir value. Note that Liquid War 6, by default, never stores files under '$HOME', instead it put things in '$HOME/.liquidwar6', that is 'user-dir'. If the environment variable 'HOME' is not set, will return '.'.Return value: a newly allocated pointer, must be freed.
Gets the name of the current user. Difference with the standard function
getloginis that this function will returned a dynamically allocated pointer, and provide a default value if it's undefined. Also, if will look at the content of the 'LOGNAME' environment variable if needed, and will even provide a default value.Return value: a newly allocated pointer, must be freed.
Gets the name of the current host. The name of the computer. Might not work perfectly, this function is just used to provide default values for player names and such things.
Return value: a newly allocated pointer, must be freed.
src: the string to escape
Transforms a string so that it does not contain any non-valid URL chars, it will mostly convert chars over 128 into their XY form where XY is the hexadecimal code. Note that this function is non really standard compliant for it won't encode '%' but keep it the same. This is to allow using it several times on the same string and avoid double-triple encoding of '%'. In practice it's not recommended to have public_url for nodes with '%' in them, and the program will never generate such url when guessing urls.
Return value: newly allocated string.
src: the string to escape
Transforms a string so that it can fit in a html field, this is typically for alt="" or title="" fields so it will convert " into
quot;.Return value: newly allocated string.
src: the string to escape
Transforms a string so that it can fit as an SQL parameter, it will get rid URL chars, it will mostly convert chars over 128 into their XY form where XY is the hexadecimal code.
Return value: newly allocated string.
argc: number of args as passed to main
argv: array of args as passed to main
Finds the path of the program currently run, this is typically to pass it to
lw6sys_exec_againand run it again.Return value: the path (newly allocated string).
argc: number of args as passed to main
argv: array of args as passed to main
Tells wether the program is already executed by itself by
lw6sys_exec_againfunction. Based on environment and command switches.Return value: 1 if executed again, 0 if not.
argc: number of args as passed to main
argv: array of args as passed to main
Runs the program from itsef, that is fires a new program (the same running) and ends up the current one. This is used to fix some environment variable issues. If LW6_EXECUTED_AGAIN (environment variable) is set, will not run the program so this is not really like
execas in the C standard library, this function will actually return and be successfull even if no other process was started. It's just designed to bootstrap/launch the process once.Return value: 1 on success, 0 on failure (always fail)
argc: number of args as passed to main
argv: array of args as passed to main
Restart the program with exactly the same arguments it was given the first time.
Return value: 1 on success, 0 on failure (always fail)
filename: absolute or relative filename
Clears a file, that is, make it a 0 byte file, empty, ready to be filled if needed. If this function is called successfully, program can reasonnably assume file will be writable during its execution.
Return value: 1 if success, 0 if failure.
filename: absolute or relative filename
Reads the content of a file, and returns it as a string. Note that content might or might not be ascii or binary, the function will however put a tailing 0 character at the end so that low-level standard C functions do not segfault when used with the returned value.
Return value: a newly allocated pointer, must be freed.
filesize: will contain the file size, in bytes
filename: absolute or relative filename
Reads the content of a file, and returns it as a binary buffer. Even if not ascii or binary, the function will however put a tailing 0 character at the end so that low-level standard C functions do not segfault when used with the returned value. This 0 character is not included in
filesizeso if there are 4 bytes in the file the 5 bytes will be allocated, this is just for string functions not to explode if called by accident. Thefilesizecan be NULL, in that case function is just like thelw6sys_read_file_contentfunction.Return value: a newly allocated pointer, must be freed.
filename: absolute or relative filename
content: the content to be written.
Writes the content into the file. Content is assumed to be a string, function will segfault if it's not correctly 0 terminated as in C string convention. So this function will not allow you to write down arbitrary binary data, however LW6 uses mostly text files to store information, and opaque binary data usage is not recommended.
free_func: optional callback used to free memory when stored date is a pointer. Can be NULL when one stores non dynamically allocated data, such as an integer or a static array.
size: the estimated size of the hash table. Note that this is an estimation only. You could theorically fit 1000000 objects in a 3-sized hash. Problem -> this is inefficient, you'd better use an assoc or a bigger hash. If you store 3 elements in a 1000000-sized hash, you'll waste memory. It might be wise to use a prime number as the estimated size. 421 is prime ;)
Creates an empty hash. There's a difference between NULL and an empty hash.
Return value: a pointer to the newly allocated hash table. Must be freed with
lw6sys_hash_free.
hash: the hash to be freed.
The function will cascade delete all elements, using (if not NULL...) the callback passed when first creating the hash.
Return value: void
hash: the hash to test
key: the key to search
Not a very fast function, since on a "big" hash, strcmp will be called internally until the key is found.
Return value: non-zero if there's an entry with the corresponding key.
hash: the hash to query
key: the key of which we want the value
Return value: a void pointer to the data contained in the hash. Note that the pointer on the actual data is returned, that is, if it's static data, you must not try to free it... As long as memory management is concerned, destroying the hash will actually free the data if needed.
hash: the hash to modify
key: the key we want to updated
value: the new value
Sets a value in a hash table. The key pointer need not be persistent, it can be freed after affectation. In fact a new string will be created internally. This is not true for the value, it's hard to find way to copy "any object". So if you want a hash table of strings, key can disappear after calling this function, but not value. The function passed as free_func when creating the hash will be used to free stuff whenever needed (unset or free).
Return value: void
hash: the hash concerned
key: the key to unset
Clears an entry in a hash table. The callback passed when creating the hash will be called if needed, to free the data automatically.
Return value: void
hash: the hash to work on
Returns a list containing all the keys of the hash. The list must be free with lw6sys_list_free by the caller. This list copies all the keys of the hash, so it is safe to use it once the hash is deleted. However the keys will of course be of little interest in this case. But the program won't segfault.
Return value: the list of keys.
hash: the hash to work on
func: a callback to call on each entry
func_data: a pointer on some data which will be passed to the callback
Executes a function on all hash items. The func_data parameter allows you to pass extra values to the function, such as a file handler or any variable which can not be inferred from list item values, and you of course do not want to make global...
Return value: void
hash: the hash to work on
func: a callback to call on each entry, may be NULL
func_data: a pointer on some data which will be passed to the callback
Executes a function on all hash items, like
lw6sys_hash_sort_and_mapbut befor doing so, sorts all entries in alphabetical order.Return value: void
hash: the hash to duplicate, can be NULL
dup_func: the function which will be called to duplicate data
Duplicates an hash. All keys will be copied so that if the first hash is deleted, the duplicated one is fine. Additionnaly, dup_func will be called with all data fields. If dup_func is NULL, then data values will simply be copied. This is likely to be usefull when data is not dynamically allocated.
Returned value: a newly allocated hash.
hexa_string: an initialization string, can be NULL.
Creates an hexa serializer object. It can be initialized or not, if an initialization string is provided it must of course be valid hexadecimal ascii code, and all serialized content will simply be appended to it.
Return value: a newly allocated object.
hexa_serializer: an hexa serializer object
Frees an hexa serializer object.
Return value: none.
hexa_serializer: an hexa serializer object
Rewinds the serializer pointer, that is, make it point to start. Usefull before calling pop functions, when one wants to be sure to get the first object.
Return value: none.
hexa_serializer: an hexa serializer object
Tests wether we're at EOF. Usefull when one wants to know if there's still some data or if all objects have been correctly popped.
Return value: 1 if at end of file, 0 if not.
hexa_serializer: an hexa serializer object
Exports the current content of the serializer as a string. String can then safely be sent on the network, for instance. String is copied from internal value, so it's safe to use it after serializer has been freed or modified.
Return value: a newly allocated string, must be freed.
hexa_serializer: an hexa serializer object
value: value to push
Pushes a 64 bit integer in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a 32 bit integer in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a 16 bit integer in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes an 8 bit integer in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a floating point value in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a string in the serializer object. Note that the string is not directly copied in the serializer, instead all its characters are converted to their ASCII equivalent, then appended.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a lw6sys_xyz_t structure in the serializer object. Calling this avoids calling push for 2 integers separately.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a lw6sys_whd_t structure in the serializer object. Calling this avoids calling push for 2 integers separately.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to push
Pushes a color structure in the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a 64 bit integer from the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a 32 bit integer from the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a 16 bit integer from the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops an 8 bit integer from the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a floating point value from the serializer object.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a string from the serializer object. The returned value is a newly allocated pointer, which must be freed, you don't need to provide a buffer, just a valid pointer on a NULL pointer.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a lw6sys_xyz_t structure from the serializer object. Avoids calling two integer pops.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a lw6sys_whd_t structure from the serializer object. Avoids calling two integer pops.
Return value: 1 if success, 0 if failure
hexa_serializer: an hexa serializer object
value: value to pop (returned value)
Pops a color from the serializer object.
Return value: 1 if success, 0 if failure
buf: binary buffer to convert
size: binary buffer length
str: the source string
Converts the stringified hexa representation of a string to its source binary buffer. Buffer must be exactly
strlen(str)/2Return value: 1 on success
buf: the buffer to stringify
size: the length of the buffer
Transforms a binary buffer into its hexa representation.
Return value: newly allocated string.
str: the string containing an hexa representation of pointer
Transforms a string into a pointer, this is typically used to store pointers in temporary agnostic storage such as a database. Beware not to use that to exchange data with other computers and/or use it for persistent data. This is a high-risk function as it lets you do real dirty stuff but it really does save time compared to using a key returned by the database engine and then search this key in a user-space hash table. Direct pointer access is definitely faster.
Return value: the pointer, or NULL is str is invalid.
ptr: pointer to convert into string representation
Transforms a pointer into a string, this is typically used to store pointers in temporary agnostic storage such as a database. Beware not to use that to exchange data with other computers and/or use it for persistent data. This is a high-risk function as it lets you do real dirty stuff but it really does save time compared to using a key returned by the database engine and then search this key in a user-space hash table. Direct pointer access is definitely faster.
Return value: the string, can be NULL on errror, must be freed.
Initializes the history system. Not initializing won't cause any segfault, but data will be inconsistent.
Return value: none.
msg: the message to register.
Registers a message in the history log, that is, adds it.
Return value: none.
timeout: the message age limit.
Get all the messages that are younger than timeout (in seconds).
Return value: a pointer on string pointers. May be NULL. Last pointer is NULL too, that's how you know the array is over.
history: the data to free
Frees a pointer returned by
lw6sys_history_get.Return value: none.
string: the string to convert
Used to force strings into UTF-8 mode, this is basically to match the TTF font settings used when displaying stuff on OpenGL. Indeed, in this case, the standard _ gettext function won't work, we need to force UTF-8 mode. If the locale is UTF-8, then function does nothing, but at least it's transparent usage won't hurt.
Returned value: a newly allocated string, always in UTF-8 no matter what the locale is.
Long 16-bit ID generator, calls the random function internally. As usual, those are not perfect random numbers, however the function implementation emphasizes more on 'real randomness' rather than relying on performance. Generating twice the same number should be fairly rare.
Long 32-bit ID generator, calls the random function internally. As usual, those are not perfect random numbers, however the function implementation emphasizes more on 'real randomness' rather than relying on performance. Generating twice the same number should be fairly rare.
Long 64-bit ID generator, calls the random function internally. As usual, those are not perfect random numbers, however the function implementation emphasizes more on 'real randomness' rather than relying on performance. Generating twice the same number should be fairly rare.
id_16: the id to check
Checks wether the given id is a valid 16-bit id.
Return value: 1 if OK, 0 if not a valid id.
id_32: the id to check
Checks wether the given id is a valid 32-bit id.
Return value: 1 if OK, 0 if not a valid id.
id_64: the id to check
Checks wether the given id is a valid 64-bit id.
Return value: 1 if OK, 0 if not a valid id.
id: the id to check
Checks wether the given id is a valid id (16, 32 or 64-bit).
Return value: 1 if OK, 0 if not a valid id.
id: the id to convert
Transform an id into its string representation. Error checking is done, if the id is invalid, returned value is NULL. All ids (16, 32 and 64-bit) are handled.
Return value: a newly allocated string, might be NULL.
id: the id to convert
Transform an id into a long integer. Error checking is done, if the id is invalid, returned value is 0. All ids (16, 32 and 64-bit) are handled.
Return value: the id as a long integer, 0 if incorrect source id.
keyword: the keyword to transform
Transforms a keyword into a "key", that is, removes all heading dashes, switches to lowercase, and other stuff. This is used internally to match options and config file parameters, for instance.
Return value: a newly allocated pointer, must be freed.
keyword: the keyword to transform
Transforms a keyword into a command-line parameter to be matched. Does the same as
lw6sys_keyword_as_key, and adds a "–" prefix.Return value: a newly allocated pointer, must be freed.
keyword: the keyword to transform
Transforms a keyword into the corresponding environment variable name. It will uppercase the name, replace "-" by "_", and add a "LW6_" prefix. "my-param" will become "LW6_MY_PARAM".
Return value: a newly allocated pointer, must be freed.
keyword: the keyword to transform
Transforms a keyword into the corresponding config file entry. In practice, just the same as
lw6sys_keyword_as_key.Return value: a newly allocated pointer, must be freed.
free_func: a callback which will be called on data when freeing the list
Creates an empty list. There's a difference between NULL and an empty list. The empty list would (in Scheme) be '() whereas NULL corresponds to undefined "is not a list and will generate errors if you ever call list functions on it".
Return value: a pointer to the created object, may be NULL.
list: the list to delete.
Delete a list, this will cascade delete all the following items in the list.
Return value: none.
list: the current position in the list
It's safer to call this rather than dig right into the internals of the list.
Return value: a new position in the list, may be NULL.
list: the list we want informations about
Checks wether the list is empty or not. Note that being empty and being NULL is not the same. An empty list is a valid pointer on a list where there's no item, a NULL pointer is not a list at all. Do *NOT* call this function on NULL.
Return value: 1 if empty, 0 if there is at list one item.
list: the list we want informations about
Calculates the length of the list. This is a performance killer for lists are inadapted to this. But it can still be usefull.
Return value: the number of elements, 0 is none (empty list).
list: the list where elements will be taken
func: the function which will be executed
func_data: additionnal data to be passed to
funcExecutes a function on all list items. The
func_dataparameter allows you to pass extra values to the function, such as a file handler or any variable which can not be inferred from list item values, and you of course do not want to make global... Not as convenient as a real "for each" construct as can be found in any modern langage, but does the job. No return value, if you really want one, pass a structure infunc_dataand modify something in it on success, failure, whatever.Return value: none.
list: the list where elements will be taken
func: the function which will be executed
func_data: additionnal data to be passed to
funcExecutes a function on all list items and keeps only those for which the function returned non zero (true). The
func_dataparameter allows you to pass extra values to the function, such as a file handler or any variable which can not be inferred from list item values, and you of course do not want to make global...Return value: none.
list: a pointer to the list (pointer on pointer, read/write value)
data: the data to be pushed
Pushes data on the list. The
free_funcfunction is copied from the previous element. The pointer on the list is changed "in place" (in/out). Note that if there's amallocproblem it might end-up being NULL... This should be rare but it *can* happen. You cannot push something else than a pointer, pushing an int is a very bad idea. Push a pointer on the integer, and ensure it's always there, ormallocit and passlw6sys_free_callbackwhen creating the list. If you think you can cast an integer into a pointer, think 64-bit machines...Return value: none.
list: a pointer to the list (pointer on pointer, read/write value)
Pops data from the list, the returned value is what was passed to list_push. The pointer on the list is changed "in place" (in/out). When data is popped, that needs some freeing (i.e. free_func was not NULL when creating the list) then it's the responsibility of the caller to free it when popping it. One popped it's not freed, but it's out of the list scope. Of course the lw6sys_list_t is freed, but not the data. If you happen to store non-NULL data in your list, you can call this function without bothering calling
lw6sys_list_is_emptyand assume that when you get NULL, there's no data left. At this stage, the list won't exist anymore BTW, you won't even need to free it. The idea is: popping a list which has no elements left (empty list) destroys the list and returns NULL.Return value: a pointer on the popped data, whatever you pushed.
list: a pointer to the list (pointer on pointer, read/write value)
data: the data to be pushed
Pushes data on the list. The
free_funcfunction is copied from the previous element. The pointer on the list is changed "in place" (in/out). Note that if there's amallocproblem it might end-up being NULL... This should be rare but it *can* happen. You cannot push something else than a pointer, pushing an int is a very bad idea. Push a pointer on the integer, and ensure it's always there, ormallocit and passlw6sys_free_callbackwhen creating the list. If you think you can cast an integer into a pointer, think 64-bit machines...Return value: none.
list: a pointer to the list (pointer on pointer, read/write value)
Pops data from the list, the returned value is what was passed to list_push. The pointer on the list is changed "in place" (in/out). When data is popped, that needs some freeing (i.e. free_func was not NULL when creating the list) then it's the responsibility of the caller to free it when popping it. One popped it's not freed, but it's out of the list scope. Of course the lw6sys_list_t is freed, but not the data. If you happen to store non-NULL data in your list, you can call this function without bothering calling
lw6sys_list_is_emptyand assume that when you get NULL, there's no data left. At this stage, the list won't exist anymore BTW, you won't even need to free it. The idea is: popping a list which has no elements left (empty list) destroys the list and returns NULL.Return value: a pointer on the popped data, whatever you pushed.
list: the list to duplicate, can be NULL
dup_func: the function which will be called to duplicate data
Duplicates a list. All data will be copied so that if the first list is deleted, the duplicated one is fine. Addtionnally, dup_func will be called to filter all data, and possibly allocated new pointers if needed, for instance. If dup_func is NULL, then data values will simply be copied. This is likely to be usefull when data is not dynamically allocated.
Returned value: a newly allocated list.
filename: the name of the log file.
Sets up the log file. Until you call this function, messages all logged to the default log file, as returned by the
lw6sys_get_default_log_filefunction.Return value: void
filename: the name of the log file.
Clears the log file, this function would typically be called at the beginning of the program. If filename is NULL, then the default log file is cleared.
Return value: void
level_id: the log level to use. Possible values are, by order, LW6SYS_LOG_ERROR_ID (0), LW6SYS_LOG_WARNING_ID (1), LW6SYS_LOG_NOTICE_ID (2), LW6SYS_LOG_INFO_ID (3), LW6SYS_LOG_DEBUG_ID (4) and LW6SYS_LOG_TMP_ID (5).
file: the name of the source file where the function is called, one can use __FILE__
line: the line in the source file where the function is called, one can use __LINE__
fmt: a printf-like format string ...: printf-like arguments, corresponding to
fmt.This function is usually called with the first three arguments packed into a single macro. For instance the
LW6SYS_LOG_WARNINGmacro expands and fills the first 3 args, so there's no need to type __FILE__ and __LINE__ again and again. Note that this function will reset errno. The idea is to call it whenever there's something to do with errno (if you deal with errno, it's a good habit to log it) then errno is cleared so that it won't interfere with next log messages.
fmt: a printf-like format string ...: printf-like arguments, corresponding to
fmt.This function is a special log function which will dump informations on the console only, without opening any log file whatsoever. The idea is that it's a "never fail" function. Additionnally, it will never return but quit the program. This can be used as an ultimate emergency function, use it when the program won't run for sure, and displaying an immediate error message is the only issue.
level: the log level, integer between 0 & 4. 4 is very verbose (debug), 0 displays errors only.
y: the return value (position, may be NULL)
s: the return value (speed, may be NULL)
x: the x parameter, the value to iterate on
w: the width, that is, the x value after which output is constant
y1: the initial value, when v is s1 and x=0
y2: the target value, when v=0 and x>=w
s1: the initial speed, that is dy/dx at x=0
A function which can be used to implement smooth moving. It will extrapolate, for values of x>=0, an y position with a continuous derivate (dy/dx is continuous, function is 2nd order polynom) and which ends up at x=w with a constant value, that is dy/dx=v=0. Typically an item set with an initial speed of v with this function
x: x coordinate
y: y coordinate
This is a wrapper over the standard
atanfunction which will handle internally the special x == 0 case and the various positive/negative values ofxandy.Return value: the angle, in degrees
x: the parameter (typically a timestamp)
period: the period (typically something like 1000 milliseconds)
y1: the low value (heart at rest)
y2: the high value (when bumping)
A heartbeat function, typically usefull to power up eye-candy, but it could do something else.
x: the parameter (typically a timestamp)
period: the period (typically something like 1000 milliseconds)
This function will alternatively return 1 or 0, usefull to handle blinking for instance.
Return value: 0 or 1
size: number of bytes to allocate.
file: name of the file calling the function, use
__FILE__x_line: line in the file calling the function, use
__LINE__x_This is a wrapper over the standard
mallocfunction. Additionnally it will keep track of the call with an internal program-wide counter, thus enabling memory leak checks. You should not use this function directly but use the macroLW6SYS_MALLOCwhich has the same syntax, without the last two parameters, which are automatically provided by macro expansion.Return value: the newly allocated pointer. Data is not initialized.
size: number of bytes to allocate.
file: name of the file calling the function, use
__FILE__x_line: line in the file calling the function, use
__LINE__x_This is a wrapper over the standard
callocfunction. Additionnally it will keep track of the call with an internal program-wide counter, thus enabling memory leak checks. You should not use this function directly but use the macroLW6SYS_CALLOCwhich has the same syntax, without the last two parameters, which are automatically provided by macro expansion.Return value: the newly allocated pointer. Data is filled with zeros.
ptr: the pointer to reallocate.
size: number of bytes to allocate.
file: name of the file calling the function, use
__FILE__x_line: line in the file calling the function, use
__LINE__x_This is a wrapper over the standard
reallocfunction. You should not use this function directly but use the macroLW6SYS_REALLOCwhich has the same syntax, without the last two parameters, which are automatically provided by macro expansion.Return value: the newly allocated pointer.
ptr: the pointer to free.
file: name of the file calling the function, use
__FILE__x_line: line in the file calling the function, use
__LINE__x_This is a wrapper over the standard
freefunction. Additionnally it will keep track of the call with an internal program-wide counter, thus enabling memory leak checks. You should not use this function directly but use the macroLW6SYS_FREEwhich has the same syntax, without the last two parameters, which are automatically provided by macro expansion.Return value: none.
ptr: the pointer to free.
This is a callback to be used when the
lw6sys_freedoes not fit. A good example is a list, which, to free its elements, requires you to provide a callback that only takes 1 arg, the pointer to free. Problem,lw6sys_freetakes 3 args. And theLW6SYS_FREEmacro is not usable in such a context. And you can't use standardfreeeither for it would mess up themalloc/freeautomatical count which is so convenient to track memory leaks. So this callback is here, it's only drawback is that in case of an error, the error will not be reported with the real file and line parameters. It's still better than nothing.Return value: none.
Gives a raw approximation of available memory, in megabytes. Value is to be taken with distance, but it can give good hints when system is running short of ressources.
Return value: number of megabytes (physical memory) available.
Checks the endianess of the machine. PPC is big endian, for instance.
Return value: 1 if system is big endian, 0 if little endian.
Checks the endianess of the machine. x86 is little endian, for instance.
Return value: 1 if system is little endian, 0 if big endian.
Checks of common types and usefull structures, this is a debugging function which helps finding compiler strange behaviors and programmer's bad intuitions.
Return value: 1 if everything is OK, 0 if error.
Creates a mutex object.
Return value: newly allocated pointer.
mutex: the mutex to destroy.
Destroys a mutex object.
Return value: none.
mutex: the mutex to use
Locks the mutex. Note that this should never fail unless there's a serious initialization problem, instead, function will wait forever until mutex is released.
Return value: 1 if success, 0 if failure.
mutex: the mutex to use
Tries to locks the mutex. That is, tells wether mutex can be locked immediately or not. Note that this does not mean there's 100% chance next call to lock will terminated immediately, since lock can still be acquired by another thread.
Return value: 1 if mutex unlocked, 0 if locked or error.
mutex: the mutex to use
Unlocks a mutex.
Return value: 1 if sucess, 0 if error.
Returns how many mutexes have been locked since program start. Usefull for sanity checking when debugging.
Return value: number of calls to lock
Returns how many mutexes have been unlocked since program start. Usefull for sanity checking when debugging.
Return value: number of calls to unlock
Checks wether unlock has been called as many times as lock. Usefull for sanity checking when debugging.
Return value: 1 if OK, 0 if inconsistency.
Function which returns always true, that is, something different than 0.
Function which returns always false, that is, 0. This can seem totally useless but it does have some utility. It's used for instance to "fool" the compiler and force it to compile and link functions in binaries, so that, afterwards, dynamically loaded .so files can find in the main binary some functions which would otherwise be stripped during the final link.
Wrapper on
omp_get_num_procsthe advantage of this is that it's always defined, wether OpenMP supported is compiled in or not, will returned 1 if no OpenMP support.Return value: number of procs
Returns the default user directory. Note that this value is not static, it can depend, for instance, of the environment variable
HOME.Return value: a newly allocated string.
Returns the default config file. Note that this value is not static, it can depend, for instance, of the environment variable
HOME.Return value: a newly allocated string.
Returns the default log file. Note that this value is not static, it can depend, for instance, of the environment variable
HOME.Return value: a newly allocated string.
Returns the default prefix, could be /usr/local for instance.
Return value: a newly allocated string.
Returns the default module directory (dynamically loaded libraries).
Return value: a newly allocated string.
Returns the default data directory.
Return value: a newly allocated string.
Returns the default music directory.
Return value: a newly allocated string.
Returns the default music path, which can be composed of several directories.
Return value: a newly allocated string.
Returns the default map directory.
Return value: a newly allocated string.
Returns the default map path, which can be composed of several directories.
Return value: a newly allocated string.
Returns the default script file.
Return value: a newly allocated string.
Logs all default values to log file. Usefull for debugging, to know where the program is searching for its informations.
Returns the current working directory (absolute path).
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the binary directory, that is, the directory the binary is stored in. This is calculated dynamically, by interpreting command-line arguments.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the user dir, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the config file, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the log file, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the prefix, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the mod dir (modules, shared .so), taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the data dir, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the music dir, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the music path, taking in account command-line and environment variables. However config file content has no impact on the result. Music path can contain several directories.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the map dir, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the map path, taking in account command-line and environment variables. However config file content has no impact on the result. Map path can contain several directories.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainReturns the script file, taking in account command-line and environment variables. However config file content has no impact on the result.
Return value: a newly allocated string.
argc: argc, number of arguments, as given to
mainargv: argv, pointer to arguments, as given to
mainLogs all the main options values which are not config-file dependant but depend on built-in defaults, command-line arguments and environment variables. Usefull to debug and know where the program is searching for things.
filename: the file to test
Tests the existence of a file on the filesystem. File is considered to exists if it's at least readable.
Return value: 1 if OK, 0 if file doesn't exist or can't be read.
dirname: the directory to test
Tests the existence of a directory on the filesystem.
Return value: 1 if OK, 0 if directory doesn't exist.
dirname: the directory to create
Creates a directory, performing sanity checks such as verifying the directory really exists after being created.
Return value: 1 if OK, 0 if error.
dirname: the directory to create
Creates a directory like
lw6sys_create_dirbut this function is silent in the sense that it won't log any error. Usefull to create the log directory itself, for instance, and avoid infinite loops on error.Return value: 1 if OK, 0 if error.
path: a path
Adds a slash, or in a general manner, a directory separator, at the end of a path, if needed. So /foo/bar will become /foo/bar/ but /bar/foo/ will remain /bar/foo/.
Return value: a newly allocated string, must be freed.
path: a path
Strips the slash, or in a general manner, the directory separator, at the end of a path, if needed. So /foo/bar/ will become /foo/bar but /bar/foo will remain /bar/foo.
Return value: a newly allocated string, must be freed.
path1: left part of the path
path2: right part of the path
Concatenates 2 parts of a path. Function will try to avoid stupid "double-slash" when concatenating /foo/ with /bar/ and conversely insert a directory separator when concatenating /foo with bar/.
Return value: a newly allocated string, must be freed.
path: a path
Splits a path into all its parts. For instance /boo/bar/foo2/bar2 returns a 4 elements list. This is more than a plain split, for heading and tailing slashes will be ignored, and various path separators will be interpreted (depends on platform).
Return value: a list containing 0-terminated strings.
path: a path
Returns the file name only, without heading directories.
Return value: file name, must be freed
path: a path
Checks wether a path is relative or absolute.
Return value: 1 if relative, 0 if absolute.
path: a path
Checks wether a path is "." or not. Will also trap "" and "./".
Return value: 1 if relative, 0 if absolute.
path: a path
Returns the parent path. That will return /foo when given /foo/bar in input.
Return value: a newly allocated string, must be freed.
path: a path
Given the ../foo/bar path, will return foo/bar. Usefull to get rid of heading ../ when a path is known to start with it.
Return value: a newly allocated string, must be freed.
path: a path
Given the ../foo/bar path, will return foo/bar. Usefull to get rid of heading ../ when a path is known to start with it. This is different from
lw6sys_path_unparentjust because the result is not dynamically allocated and copied from source.Return value: a pointer which points somewhere within the string passed as an argument.
dir: the path of the directory to list
filter_func: a function which will filter entries, can be NULL
func_data: additionnal data passed to filter_func
n: will contain the number of items found
This list a directory. The filter will be passed the file path as an argument. If it returns 1, the file is kept, if it returns 0 it's suppressed from the list.
Return value: a list containing strings (file paths).
path: the path of the path to list
filter_func: a function which will filter entries, can be NULL
func_data: additionnal data passed to filter_func
n: will contain the number of items found
This list a directory. By path we mean here a list of separated directories, separated by : for instance. The filter will be passed the file path as an argument. If it returns 1, the file is kept, if it returns 0 it's suppressed from the list. It's like performing a call to
lw6sys_dir_liston each of the path members.Return value: a list containing strings (file paths).
dir: a directory, when to search the file first
path: the path to search too, a separated list of dirs
file: the filename to search for
Tries to find a file in the given paths. The function is typically used to find music files. First it tries to find the file in dir, then it tries to find it in each dir of path.
filemust be only a file name and not contain any directory. The function will use the filename only anyway.Return value: the full path of the found file.
f: file to output content to
Prints a standard Liquid War compliant XML header in the given file.
Return value: none.
f: file to output content to
Prints a standard Liquid War 6 compliant XML footer in the given file.
Return value: none.
verbose: wether to display informations on the console
Checks wether Google Profiler support has been built, and if it's set, outputs the log file. If CPUPROFILE is defined but binary has no support for it, will display a warning message.
Return value: 1 if google profile enabled and activated, 0 if not
progress: the progress struct to initialize
value: the value to point to
Sets a progress struct to default values, that is, ranging from 0.0f to 1.0f.
Return value: none.
progress: the progress struct to update
min: the min value
max: the max value
value: the current value
Updates a progress struct. This is typically the function used by a callback to show the progress of a process. Note that this is note an initializer. Rather, the progress struct was initialized before, and this call is done in a loop with min being 0, max being the last value in the loop, and value the current index in the loop. NULL pointers correctly handled internally, so call this with any parameters, it's safe.
Return value: none.
progress1: the first part of the splitted progress progress2: the second part of the splitted progress progress_src: the progress to split
Utility function to split a progress struct, that is, if a progress was ranging from a to b, make 2 progress structs, ranging from a to c and from c to b, c being between a and b.
Return value: none
progress1: the first part of the splitted progress progress2: the second part of the splitted progress progress_src: the progress to split here: where to split
Utility function to split a progress struct, that is, if a progress was ranging from a to b, make 2 progress structs, ranging from a to c and from c to b, c being between a and b. The here value controls what c is. If here=0, then c=a. If here=1, then c=b.
Return value: none
progress1: the first part of the splitted progress progress2: the second part of the splitted progress progress3: the third part of the splitted progress progress_src: the progress to split
Utility function to split a progress struct, this one will split it into 3 equal parts.
Return value: none
progress1: the first part of the splitted progress progress2: the second part of the splitted progress progress3: the third part of the splitted progress progress4: the fourth part of the splitted progress progress_src: the progress to split
Utility function to split a progress struct, this one will split it into 4 equal parts.
Return value: none
progress1: the first part of the splitted progress progress2: the second part of the splitted progress progress3: the third part of the splitted progress progress4: the fourth part of the splitted progress progress5: the fourth part of the splitted progress progress_src: the progress to split
Utility function to split a progress struct, this one will split it into 5 equal parts.
Return value: none
progress: the progress to update
Sets the progress to its min value, NULL values correctly handled.
Return value: none
progress: the progress to update
Sets the progress to the average between min and max, NULL values correctly handled.
Return value: none
progress: the progress to update
Sets the progress to its max value, NULL values correctly handled.
Return value: none
range: the high limit for random generated numbers. If you want random numbers between 0 and 5, set this to 6.
Wrapper over standard random function. This one is thread safe. This idea is not to provide cryptographic-proof random numbers, rather generate sequences which are random enough to generate unique server ids and such things. The function is initialized on its first call, and results depend on timestamp, host name, user name, and memory available.
min: the min value, as a float
max: the max value, as a float
Returns a random float number between min & max. Can be equal to min or max.
Function used to avoid initializing SDL several times in a program. AFAIK Allegro has a
was_initfunction, but SDL doesn't. With this function - which every LW6 sub-module should use - one can know globally, for the whole program, wether SDL has been initialized or not.
Call this whenever you are done with SDL and exit it, so that the
lw6sys_sdl_registerfunction works correctly.Return value: 1 if SDL needs to be unregistered, that is, if it has already been initialized, else 0.
data: pointer to the data, must contain at least 8 bytes of writable space
value: the integer to serialize
Serializes a 64-bit integer in a byte buffer. Result is not dependant on machine endianess. Typically used for checksums or high-level serializations.
data: pointer to the data, must contain at least 8 bytes
Recovers a 64-bit integer from a byte buffer created, for instance, with
lw6sys_serialize_int64.
data: pointer to the data, must contain at least 4 bytes of writable space
value: the integer to serialize
Serializes a 32-bit integer in a byte buffer. Result is not dependant on machine endianess. Typically used for checksums or high-level serializations.
data: pointer to the data, must contain at least 4 bytes
Recovers a 32-bit integer from a byte buffer created, for instance, with
lw6sys_serialize_int32.
data: pointer to the data, must contain at least 2 bytes of writable space
value: the integer to serialize
Serializes a 16-bit integer in a byte buffer. Result is not dependant on machine endianess. Typically used for checksums or high-level serializations.
data: pointer to the data, must contain at least 2 bytes
Recovers a 16-bit integer from a byte buffer created, for instance, with
lw6sys_serialize_int16.
shape: the dimensions to control
min: the minimum shape allowed
max: the maximum shape allowed
Will check wether the given shape respects some basic constraints, being not to small and not too big.
Return value: 1 if OK, 0 if not.
shape: the boundary box
pos: the position
Checks wether position is within the given boundary box.
Return value: 1 if OK, 0 if not.
shape_a: the first shape to compare
shape_b: the other shape to compare
Compares two shapes.
Return value: 1 if same, 0 if not.
shape_a: the first shape to compare
shape_b: the other shape to compare
Compares two shapes, but ignores the z (d) parameter.
Return value: 1 if same_xy, 0 if not.
trap_errors: set to 1 if you want to trap SIGSEGV and SIGFPE
Set up our signal handlers. This will probably be overrided later by other libs such as libSDL, but at least in pure server mode it gives a way to treat SIGTERM the right way.
Return value: none.
Restore default signal handlers for those modified by
lw6sys_signal_custom.Return value: none.
signum: SIGTERM
The own TERM signal handler, will basically call the
lw6sys_signal_send_quitfunction, which will set a flag used later bylw6sys_signal_poll_quit.Return value: none.
signum: SIGINT
The own INT signal handler, will basically call the
lw6sys_signal_send_quitfunction, which will set a flag used later bylw6sys_signal_poll_quit.Return value: none.
signum: SIGTERM
The own HUP signal handler, will basically do something that shows the program is alive, typically display a NOTICE message.
Return value: none.
signum: SIGTERM
The own SEGV signal handler, will display a backtrace and exit.
Return value: none.
signum: SIGTERM
The own FPE signal handler, will display a backtrace and exit.
Return value: none.
Sets the quit flag to 1, so that
lw6sys_signal_poll_quitreturns true, that is, tells the polling loop to stop.Return value: none.
Tests wether we need to stop right now.
Return value: 1 if we need to stop now, 0 if program can continue.
list_a: pointer to a list of int item
list_b: pointer to a list of int item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of integers.Return value: -1 if
list_a<list_b, 0 iflist_a==list_b, 1 iflist_a>list_b
list_a: pointer to a list of int item
list_b: pointer to a list of int item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of integers. This one will sort in reverse mode.Return value: 1 if
list_a<list_b, 0 iflist_a==list_b, -1 iflist_a>list_b
list_a: pointer to a list of float item
list_b: pointer to a list of float item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of floating point numbers.Return value: -1 if
list_a<list_b, 0 iflist_a==list_b, 1 iflist_a>list_b
list_a: pointer to a list of float item
list_b: pointer to a list of float item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of floating point numbers. This one will sort in reverse mode.Return value: 1 if
list_a<list_b, 0 iflist_a==list_b, -1 iflist_a>list_b
list_a: pointer to a list of string item
list_b: pointer to a list of string item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of 0-terminated strings.Return value: -1 if
list_a<list_b, 0 iflist_a==list_b, 1 iflist_a>list_b
list_a: pointer to a list of string item
list_b: pointer to a list of string item
A typicall sort callback function, can be passed to
lw6sys_sortto sort a list of 0-terminated strings. This one will sort in reverse mode.Return value: 1 if
list_a<list_b, 0 iflist_a==list_b, -1 iflist_a>list_b
list: the list to sort, might be modified by the function
sort_func: the callback function used to sort
A general sorting function. Internally, will use the glibc
qsortfunction, but this one is adapted to the LW6 specific data structures, more exactly, thelw6sys_liststructure. Several default sort callbacks are defined, but one is free to use any callback, provided it has the right prototype.
Creates a spinlock object.
Return value: newly allocated pointer.
spinlock: the spinlock to destroy.
Destroys a spinlock object.
Return value: none.
spinlock: the spinlock to use
Locks the spinlock. Note that this should never fail unless there's a serious initialization problem, instead, function will wait forever until spinlock is released.
Return value: 1 if success, 0 if failure.
spinlock: the spinlock to use
Tries to locks the spinlock. That is, tells wether spinlock can be locked immediately or not. Note that this does not mean there's 100% chance next call to lock will terminated immediately, since lock can still be acquired by another thread.
Return value: 1 if spinlock unlocked, 0 if locked or error.
spinlock: the spinlock to use
Unlocks a spinlock.
Return value: 1 if sucess, 0 if error.
src: the string to copy
Duplicate a string, creating a new pointer on it, which must be freed afterwards. The main difference with
strdupis that here we use the LW6SYS_MALLOC macro to track down possible memory leaks.Return value: a newly allocated pointer, must be freed.
str1: the left part to be concatenated
str2: the right part to be concatenated
Concatenate 2 strings, and put the result in a newly allocated string. Unlike
strcatwhich uses the same pointer.Return value: a newly allocated pointer, must be freed.
fmt: a format string, like the one you would pass to
printf...: optional arguments, like the ones you would pass toprintfAn sprintf like function, except it allocates a new string automatically, with "enough space". This is not a highly optimized function, it will allocate plenty of memory, possibly several times, and thus consume time and resources. But it has the great advantage of freeing the programmer of the dirty work of guessing "how log will the sprintf'ed string be?" before even generating it. So it's a time saver for the programmer. Additionnally, helps avoiding memory leaks and buffer overflows.
Return value: a new allocated string, must be freed.
buf: a buffer of len+1 chars
len: the max length of string
fmt: a format string, like the one you would pass to
printf...: optional arguments, like the ones you would pass toprintfAlmost like snprintf except that it will *always* append a char 0 ('\0') at the end of the string. Therefore buf must be of size len+1.
Return value: 1 if success, 0 if failed.
str: the string to test
Tests wether a string is blank, that is, if it's composed of space, tabs, or carriage returns only.
Return value: 1 if blank, 0 if not.
str: the string to test
Tests wether a string is NULL or empty (string with 0 chars "").
Return value: 1 if NULL or empty, 0 if contains something.
str: the string to test
Returns always a non-NULL string, if string is NULL, returns "" The argument
stris not passed as const else this function would equate to a disguised cast from const to non-const.Return value: source string or "" if it was NULL
str_a: 1st string to compare, can be NULL
str_b: 2nd string to compare, can be NULL
Compares two strings for equality. Difference with strcmp is that this one won't check for alphabetical order and return -1 or +1, but will check for NULL args. of space, tabs, or carriage returns only.
Return value: 1 if same, 0 if not.
str_a: 1st string to compare, can be NULL
str_b: 2nd string to compare, can be NULL
Compares two strings for equality. Difference with strcmp is that this one won't check for alphabetical order and return -1 or +1, but will check for NULL args. of space, tabs, or carriage returns only. This function is not case sensitive.
Return value: 1 if same, 0 if not.
str: the string to analyse
beginning: the pattern to search
Tells wether string starts with a given beginning.
Return value: 1 if
strstarts withbeginning, 0 if not
str: the string to analyse
beginning: the pattern to search
Tells wether string starts with a given beginning. This function is not case sensitive.
Return value: 1 if
strstarts withbeginning, 0 if not
str_ptr: a pointer to a string pointer (read/write parameter).
Skips blanks at the beginning of a string. The passed parameter is modifed in place. Usefull for parsing.
Return value: 1 if blanks were found, else 0.
str: a pointer to the string, which will be modified in-place.
Used to clean up some strings, for instance if they come from the network, we don't necessarly want system chars to be displayed on the console. Basically it removes all characters with an ASCII code inferior to 32, that is, all system characters. This way, there won't be any tab, linefeed, or any of such characters left.
Return value: none.
str: a pointer to the string, which will be modified in-place.
Used to clean up some strings, for instance if they come from the network, we don't necessarly want system chars to be displayed on the console. Basically it removes all characters with an ASCII code inferior to 32, that is, all system characters. This way, there won't be any tab, linefeed, or any of such characters left. This function will even remove any character above ASCII 127.
Return value: none.
str: a pointer to the string we want to modify
prefix: a prefix to put before each line
Reformats a string, that is, insert newline characters in the right places to that it fits in a given number of columns. A prefix is appended at the beginning of each line. Will not handle strings which already contain newline characters perfectly.
Return value: a newly allocated string, must be freed.
str: a pointer to the string we want to modify
Reformats a string, that is, insert newline characters in the right places to that it fits in a given number of columns. This function will modify the buffer so
strmust be writeable. Will not handle strings which already contain newline characters perfectly.Return value: none
Returns the value of EOL, that is, the "end of line" sequence. Will simply return "\n" on UNIX and "\r\n" on Microsoft platforms. Note that while this is convenient to write config and example files, for instance, it's a bad idea to use this to generate network messages, because this kind of message needs to be platform independant. Thus any network protocol oriented string would use chr(10) and char(13) directly.
Return value: the EOL string, must not be freed.
str: a string
c: the delimiter to split with
Splits a string, for instance 'foo,bar' splited with 'o' will return 'f', ” and ',bar'.
Return value: a list containing 0-terminated strings.
str: a string
c: the delimiter to split with
Splits a string, ignoring empty '0-length' members. For instance 'foo,bar' splited with 'o' will return 'f' and ',bar'.
Return value: a list containing 0-terminated strings.
str: a string
Splits a string, ignoring empty '0-length' members, and using the comma ',' as a separator. This is typically usefull for config elements such as backend lists. Only paths need another separator (platform-dependant).
Return value: a list containing 0-terminated strings.
list: list of strings to join
glue: string to add in-between
Companion function of
lw6sys_str_splitwhich will do the contrary and join the string. Here we use a string as the glue/separator, more flexible than a simple char in this case.Return value: dynamically allocated string
str: the string to modify
Transforms a string to upper case, the pointer must point to modifiable data.
Return value: none,
strpointed data modified in-place
str: the string to modify
Transforms a string to lower case, the pointer must point to modifiable data.
Return value: none,
strpointed data modified in-place
str: the string to truncate
len: the new length
Truncates a string to the max given length. If truncated to 3, "abcdef" becomes "abc".
Return value: none,
strpointed data modified in-place
len: the length of the random string to generate.
Generates a random string, this is usefull for testing.
Return value: newly allocated string
len: the length of the random string to generate.
Generates a random string, this is usefull for testing. This version only generates words with alpha-numerical content (letters and digits plus spaces).
Return value: newly allocated string
buf: the buffer to test
len: the length of the buffer
Tests wether a buffer is likely to contain a string. This is not a bulletproof function, just a simple heuristic based estimator.
Return value: 1 if probably binary, 0 if probably text
f: file to get input from, typically stdin
Will read file/stream and return it as a string. This is not for serious stream operation since it will return only when stream is closed, and read all file into memory before doing anything. It's also limited in size since it uses a fixed length buffer, so this is just for quick testing, typically used by command line switches which are used to test encoding/decoding functions. Do not use it to read a filesystem file,
lw6sys_read_file_contentis much better.Return value: newly allocated string.
f: file to receive the string
str: the string to output
Here only for API consistency, will just put string to file (just a simple fprint).
Return value: none.
argc: number of args as passed to main
argv: array of args as passed to main
mode: 0 for check only, 1 for full test
Runs the
sysmodule test suite which is specific to exec functions, these ones requireargcandargvto be correctly set so the extra argument justifies putting it outsidelw6sys_test. Additionnally, it's not fool proof...Return value: 1 if test is successfull, 0 on error.
mode: 0 for check only, 1 for full test
Runs the
sysmodule test suite, testing most (if not all...) functions. Note that some tests perform file system operations and might therefore fail on a read-only filesystem, or if user permissions are not sufficient.Return value: 1 if test is successfull, 0 on error.
callback_func: the main callback, the function that will run the thread
callback_join: function which will be called when joining, at the end
callback_data: data which will be passed to the callback
Creates a thread. All threads must be joined. This is because we really do not want the game to leak, and detached threads are typically the kind of thing that leaves stuff in the heap. Note that callback_func is just something which will be called when joining it can be NULL. The idea is to put in it free & delete functions, which you can't call before joining when you want the main thread to get the results of the callback_func.
Return value: an opaque pointer on the thread. Can be NULL if failed.
thread_handler: thread to work on
Tells wether the callback is done, that is to say, wether the results are available, and we can join.
Return value: 1 if done, else 0.
thread_handler: thread to query
Returns the id of the thread, this is an internal value, unique for each process, which can help identifying the thread.
Return value: the id, should be >0.
thread_handler: thread to query
Returns the data associated to the thread, that is, the pointer which was passed to the callback function.
Return value: a pointer.
thread_handler: thread to end
Joins the thread, that's to say wait until the thread is over, and destroys the ressources associated to it. Note that if the thread is looping forever, this function will just wait forever. This is the only way to end a thread.
Return value: none.
Utility function used to check how many threads where created and joined.
Return value: how many threads were created.
Utility function used to check how many threads where created and joined.
Return value: how many threads were joined.
Utility function used to check how many threads where created and joined. This one will compare the results of
lw6sys_get_thread_create_countandlw6sys_get_thread_join_count.Return value: 1 if both are equals, 0 if not (error...).
Returns a 64-bit timestamp, for general purpose. The unit is milliseconds, should return the number of milliseconds since EPOCH. Don't use this for accurate date handling, but rather to technical stamp events.
Return value: the timestamp.
Returns the number of milliseconds since program was started. Milliseconds are often referred to as 'ticks'.
Return value: the number of milliseconds (64-bit)
Returns a 32-bit timestamp, which is likely to "loop" and have twice the same value during a single program execution. The idea here is just to provide a 32-bit value, not too big, for animation purposes. The idea is that with 64-bit values, numbers are too big and if the goal is just to animate a cursor or spin a sphere, one does not care if every ten hours there's a display glitch because value became zero again. Besides, those values are often used for their "rest" in a module operation, to translate textures for instance, and having too big numbers causes floating point imprecisions. In fact those values or even only 20-bit. The function is based on
lw6sys_get_uptime() so it will return 0 at game startup.Return value: the cycle value, a 20-bit integer.
timestamp: the timestamp in msec since EPOCH (output), can be NULL
uptime: the uptime in msec since startup (output), can be NULL
cycle: a 20-bit value for animation purpose.
Returns timestamp & uptime with only one system call.
Return value: none (parameters modified).
seconds: the number of seconds to wait, fractions allowed
Will sleep for the given amount of seconds. Same as
lw6sys_delayonly input is provided as a floating number of seconds instead of ticks.
msec: the number of milliseconds (ticks) to wait
Will sleep for the given amount of seconds. Provides accurate timing and has "about-millisecond" precision, since it uses
selectinternally. Might however be interrupted in some cases, so consider function can always return quicker than specified. A common usage of this function is polling loops, where you don't care if 2 polls are very close, but simply want to avoid polling continuously, therefore consumming 100% of the CPU for nothing.
Will sleep for a minimal amount of time, just giving the OS a chance to let other threads/processes execute themselves. This can make a big difference in polling loops between a process that eats 100% CPU and a process that has a very moderate load. of ticks.
Will sleep for some time, like
lw6sys_idle, except it's a "longer" time, use this when you don't really care about reactivity but are more concerned about saving CPU, not running uselessly the same polling code.
seconds_from_now: an offset to add to current time
Gives the date according to RFC1123, this is typically usefull for HTTP protocol.
Return value: newly allocated string.
Gives the date in a format which is compatible with Apache CLF Common Log Format.
Return value: newly allocated string.
timestamp_delta: the duration to show, in msec
Returns a readable form of an uptime, typically 1d 12:34:06 for one day, 12 hours, 34 min, 6 sec or 7:03:45 for 7 hours, 3 minutes 45 sec.
Return value: newly allocated string
ip: IP address
port: IP port
Returns an http URL pointing to ip: port that is, adds a heading http:// and a trailing /, and treats port 80 as default. This is used to create public_url in net modules.
Return value: a newly allocated string, NULL on error.
url: the URL to parse
Parses a URL, this is not a complete RFC compliant parser, it's only used to transform URLs into their 'canonical' form as well as getting basic info such as on which port one should connect.
Return value: a newly allocated struct, NULL on error
url: the url struct to free
Frees a URL struct and all its members.
Return value: none.
url: the url to check & transform
Checks if a given URL is correct and, if it is, transforms it into its canonical form. This is mostly to get rid of typesettings error, add a tailing /, transform all domain into lowercase, among other things. A canonized url passed into this function should come out exactly the same.
Return value: a newly allocated string.
url: the URL to check
Checks wether an URL is in its canonized form.
Return value: 1 if OK (canonized form), 0 if not
callback_func: the main callback, the function that will run the thread
callback_join: function which will be called when joining, at the end
callback_data: data which will be passed to the callback
This function is similar to
lw6sys_thread_create, but it's dedicated to creating a unique (one per process only) thread, which, in turn, will be able to run commands in the main thread itself. This is a hack to allow apparently spawned child threads to be actually handled by main. This is because some libraries, which LW6 uses in threads, need to be actually called in the main thread. SDL, for instance. Note that after running this you loose control on the main thread, this one will only wait for possible commands from the spawned thread, typically sent with thelw6sys_vthread_createfunction.Return value: 1 on success, 0 on failure.
Returns true if
lw6sys_vthread_runhas been called. Note that this is not bullet proof, it will return true in a correct manner only if you call it from the vthread itself. In practise this shouldn't be a problem, the idea is just to write portable code for the main control thread and be able to decide on the fly wether to create a thread we should prefer thelw6sys_thread_createor its equivalent thelw6sys_vthread_createfunction.Return value: 1 on success, 0 on failure.
callback_func: the main callback, the function that will run the thread
callback_join: function which will be called when joining, at the end
callback_data: data which will be passed to the callback
The equivalent of
lw6sys_thread_createbut for the vthread infrastructure. The idea is to pretend firing a spawned thread, but in fact it's the main thread that runs the code. This function must imperatively be called within thelw6sys_vthread_runfunction, else it will fail or be buggy.Return value: 1 on success, 0 on failure.
The equivalent of
lw6sys_thread_joinbut for the vthread infrastructure. The idea is to pretend firing a spawned thread, but in fact it's the main thread that runs the code. This function must imperatively be called within thelw6sys_vthread_runfunction, else it will fail or be buggy.Return value: none.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/tsk/index.html.
loader: loader object
map_path: map-path config entry
relative_path: relative map path
default_param: default parameters to use for load
forced_param: parameters to be forced and their values
display_w: display width
display_h: display height
magic_number: used to calibrate speed
Pushes a load request to the loader. Will stop the current load and push a new one.
Return value: none.
level: loaded level (out param)
game_struct: loaded struct (out param)
game_state: loaded state (out param)
loader: loader object
Pops data from the loader, will allocate everything dynamically. Function can either return just level or level and game struct and game state (3 of them together). It's safe to use the received level, display it right away, then wait for the rest. If things are loaded fast enough, you just receive everything at once.
Return value: 1 if some data, 0 if none.
sleep: how many seconds to wait between every poll
user_dir: user directory
progress: progress indicator to use
Creates a new loader. This object is used to do some reputed slow calculus in the background, in a separated thread. Typical example is map loading. This is a high-level objects which encapsulates threads and other wizardry.
Return value: a pointer to the loader, NULL if failed.
loader: the loader to free.
Deletes a loader. Will automatically stop the child thread, free data, and so on.
Return value: none.
loader: the loader to represent.
Creates a string which briefly describes the loader.
Return value: a dynamically allocated pointer, must be freed.
loader: the loader to query.
Returns the current stage of the loader.
Return value: 0 if idle, 1 if loading the map from disk, 2 if build dynamic stuff such as game_state.
mode: 0 for check only, 1 for full test
Runs the
tskmodule test suite.Return value: 1 if test is successfull, 0 on error.
View lcov test coverage results on http://www.gnu.org/software/liquidwar6/coverage/src/lib/vox/index.html.
game_state: the game state to use
Creates a voxel rendering object (todo, not implemented yet).
Return value: renderer object
renderer: the renderer object
Frees a voxel rendering object (todo, not implemented yet).
Return value: none
mode: 0 for check only, 1 for full test
Runs the
voxmodule test suite.Return value: 1 if test is successfull, 0 on error.
Here's my .plan file, which describes what I (Christian Mauduit) have planned for Liquid War 6. There's no garantee that what's written here is a precise description of the real future, however it should give a good idea of what I have in mind.
Note that the information here was written in summer 2005, it might or not be accurate now, as the main reason for plans to exist is that people never follow them. I'm no exception.
Liquid War 6 will be an almost complete rewrite. I mean that common code between branches 5 and 6 might end up in representing 0% of the total code. I think this is a wise decision, for the current code is really hard to maintain, and would not survive any serious cleanup. LW5 was first written in 1998, for DOS, when I had much less experience in programming. In 7 years I - and other people as well - hacked major enhancements in it such as cross-platform support, network games, and if you compare release 5.0 with the latest 5.x.x release, you'll see that a bunch of things have changed. I had never expected I would patch and fix this game for so long, and it's no surprise that it's bloated today.
FYI, here's a list of what makes LW5 unsuitable for major improvements without a complete rewrite:
Liquid War 6 will use a different technical framework than Liquid War 5.
It happens that coding a large project in pure C is a waist of time, if possible at all.
If one applies the standard 80/20 rule to a computer game, one might state that 80% of the code eat up 20% of the CPU and the other 20% of the code eat up 80% of the CPU, the former being high-level glue code and the latter being low-level algorithmic code.
With Liquid War, one could speak of the 99/01 rule. I mean that 99% of the CPU time concerns only 1% of the code, and vice-versa. Basically, Liquid War has a very CPU-greedy core algorithm, still spends a fair amount of CPU displaying stuff (but this is delegated to the low-level game programming library) and the rest is totally unsignificant, in terms of CPU. Point is this "rest" represents the vast majority of the code, and also represents the very same buggy code I spend nights to patch on Liquid War 5. I'm talking about network code, GUI, and other high-level glue-code which are currently being written in C.
This idea is to write all this in a convenient scripting language. There won't be any impact on performances. I can't garantee Liquid War 6 will be blazingly fast, but for sure it won't be the scripting language fault. And of course if, as in Liquid War 3 and 5, I feel the need to implement some stuff in assembly for performances issues, I will do it.
We end up with a multi-language architecture: script + C + assembly.
My guess is that I'll use Scheme as an extension language. Python would be a good choice too. Let's say I'll give Scheme a chance, and if it's really not adapted, I'll switch back to Python. The point is that today I know Python and don't really know Scheme, but, well, it's always a pleasure for me to learn new things. It's fun.
So what is planned today is that Liquid War 6 will be a Scheme program, which will call callbacks functions written in C and/or assembly. These functions will do all the low-level time consuming algorithmic and graphical stuff. The rest of the code being entirely scripted.
Liquid War is not a 3D game, so why use OpenGL?
This choice implies that I won't use Allegro anymore. Allegro stays a very convenient library and I would recommend it for it's excellent, easy to learn, powerfull, and stable. But for the needs of Liquid War 6 I'll use something else (because of OpenGL). I first thought of using GLUT but I might end up simply using SDL. The idea is just fo have an OpenGL wrapper which sets up OpenGL in a similar manner on all platforms, and handles basic things such as mouse or keyboard.
I've got two excellent books on Csound, and the will to learn how to use this tool.
I'll probably use Csound for a number of things, ranging from "bubbling sounds" to full blown music. Stay tuned 8-)
Of course Liquid War 6 will look nicer than Liquid War 5, blah blah blah. What do you think?
Maybe I'll try to use some OpenGL features to make it possible to play on a ball, on a Moebius ring, or other fancy things. I have zillion of ideas, future will decide which ones will be implemented first.
To make it clear, visual enhancements aren't my top-level priority. However I'll try and make room for these enhancements, and prepare the terrain correctly. So it's possible that the first releases of Liquid War 6 won't be that much better than Liquid War 5, but at least Liquid War 6 will have the possibility to evolve. Something Liquid War 5 doesn't have.
There are many things that could be done easily:
As for graphical improvements, this is not my top-level priority. Simply, I'll make the game ready-to-improve. Again, all these enhancements are very hard to code in Liquid War 5, else I would already have coded them. Network enhancements
That's my top-level prioriry.
Why is that? Well, think of Liquid War in terms of "what makes it a good game?" and "what makes it a poor game?".
It's a good game because:
It's a poor game because:
For the ugliness, well, OpenGL and some artwork should make it. But for the network, what's the real problem?
The real problem is that in the current situation, the server needs to have all "keystrokes" before doing anything, and all players must be connected before a game starts. Here's what I plan to do to fix this:
This third point will be the real enhancement of Liquid War with version 6. It's one of the very points which drives me to rewrite it completely. First because it's impossible to implement it without some heavy work. Then because I find it very motivating.
Many gamers submitted suggestions, either by mail or by posting messages on the mailing list.
Don't worry, I keep them. Not reading them here does not mean I won't implement them. It simply means I won't implement them first. I first need the game basically function before enhancing it with fancy stuff.
As I stated on the mailing list, when thinking about Liquid War 6, think of years rather than months (unless I get fired, jobless, or spend several months in a hospital with a laptop).
Note that this road map takes it for granted that I'll be the lone coder on the project. It's unlikely that someone is going to help me for the first stages, until there's at least something real, something playable. Something that proves that the concept is valid. Besides, (real) team work implies a significant overhead, especially at project start. It's hard to figure out how to distribute tasks when the tasks themselves are not clearly identified. But for the rest (starting in 2007 or 2008), it's possible that external help might greatly... ...help!
Quoting Gavin: “I wrote a liquid war fanfic some time ago [...] I wrote it after a friend claimed that there wasn't any liquid war fanfic because it wasn't possible.”
So here it is, a Liquid War fanfic. It was initially written for Liquid War 5, but applies to Liquid War 6 as well. Enjoy!
...
The General presided over his massing army in his seat, or rather hovering ring, of power. It dipped slightly as he flew low over his troops marching through the viscous marsh-like terrain. They were like children: obedient, loyal, and they ate a lot.
Glancing at the status panel mounted in front of him he grimaced; the other five armies: Yellow, Green, Orange, Turquoise, and, of course, Red, were also readying armies of a similar size to his own. His violet clones would have to fight hard and eat well to win this day.
Today would not be a battle of luck, the General mused, it would be a battle of tactics, of alliances, and of betrayal. Every clone was identical - that was the general idea behind clones - and the terrain seemed strangely symmetrical; it would not give advantage to any of the six armies amassed today. Glancing at the hologram of the battlefield projected in front of him the General noted that he would have to move quickly, Orange and Yellow were too close for comfort, though fortunately Baron Red's army of eponymous coloured clones was the furthest.
General Violet's fingertips were sweaty even before they touched the four main control keys in front of him. They were labeled 'W', 'A', 'D', and, of course, the full retreat button - very useful for misleading foes and ambushing them as they pursued - 'S'. The keys were arrange in a roughly equilateral triangular pattern; with 'S' forming the base and being adjacent to both 'A' and 'D', 'W' formed the tip of the triangle.
A long breath left his parched lips as at last he made his move.
...
“Dammit!” he screamed moments later. He had misjudged Captain Yellow and Commander Orange; he had expected one at least to attack immediately, one he could have handled. They were working together - foiling his attempt to shoot between them to near the center of the battlefield to gain a better vantage point. Yellow had shot down towards him, cutting off his advance, and now Orange had sealed his escape route. “It's not over yet” muttered the General. He opened a voice channel with Commander Orange:
“Very clever. Flawed, but still clever.”
“Flawed?” came the reply.
“Yes flawed, when the good Captain is finished devouring my army who do you think he will turn to next?”, bluffed the General - his hands worked quickly as he manoeuvred his hovering control ring, all that his troops ever saw of him, carefully towards the weakest section of his attackers. If he could just break out a few units he could soon turn the tide against both Yellow and Orange.
“We have an alliance...” Orange's voice was unsure now.
Time for some sarcasm to through her even more off balance, thought the General,
“I gathered”, he spoke softly, slowly, and with too much meaning. Then closing the channel he turned his attention back to his escape.
...
“Yes!” wooped the ecstatic figure of the General. Fifty or so of his troops had broken free undetected and were even now working their way cautiously towards the camps of the Yellow army, only the front lines were still actively fighting; this opening gambit of Yellow and Orange had turned into a stale siege and Yellow's army had pitched tent.
General Violet steered his hovering guidance ring to the center of the Yellow camp. His troops struck, both those who had got behind the lines and those who were still besieged. Yellow reacted too slowly and suddenly found that her army, was shrinking back from the onslaught. There was nowhere to run to, and bye now her only ally - Commander Orange - had abandoned her to her fate; he was too busy engaging Sir. Turquoise, who had managed to escape from the slaughter that the Baron had caused to the Turquoise ranks and was even now valiantly attacking the flanks of the Orange troops.
A glance at the status panel showed that Yellow's life force was fading quickly: 8%, 3%, 1%, Gone.
The General smiled, he always enjoyed getting the first kill, and by now his armies life force had grown and his clones had replicated. With his, now, formidable fighting force it was no problem to engulf both Sir. Turquoise and Commander Orange's brawling armies and annihilate them. Once again his army grew in size and power. Now if only the Baron didn't notice that..., thought the General.
...
“Too late!” yelped the General, now thrown into panic, as he saw the approaching Baron. His army had also grown in size and power - having fatally injured the Turquoise army within the opening moments of the battle, and having finally managed to catch the elusive fleeing form of, or what remained of, Emperor Green.
Gripping the controls harder the General thought quickly, his army doesn't so completely outnumber me that this is already over, however unless I can cause him to make a mistake that allows me to take the upper hand then I will inevitably lose. Maybe I can...
This thought was terminated and replaced by another as the Baron's angry red troops broke through the undergrowth that had covered their movements and started to surround the General's army. The thought that now throbbed through the panic-stricken mind of General Violet was simply 'Run!'.
Even as he signaled the retreat and made for what seemed to be the only possible means of escape the Baron's blood red control ring appeared at the opening. The General knew it was over, even before the host of red beings appeared at the opening.
There was no escape. His life force was almost depleted and he was surrounded. Then it was that the Baron decided to communicate:
“Too bad. It was a good game”
The General blinked, gaped, and was generally gobsmacked. Just before his life force completely failed and his own weary eyes closed in defeat he snarled,
“What!? This is not a game!” were the General's dying words.
This section lists various Internet Liquid War related links.
These are the “official” links, hopefully you'll find everything you need here:
Note that some of these links might link to and/or promote proprietary software. It's important to emphasize Liquid War 6 is free software, free as in speech, and you are encouraged to use software that protects your freedom. However, for your convenience, those links are provided, they might give you a hopefully neutral idea of what the game is all about.
This list is also by no way extensive, it's provided “as is”.
Various links that are deprecated, but still might contain interesting informations for those who enjoy digging into the past.
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does.
Copyright (C) year name of author
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
program Copyright (C) year name of author
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
http://fsf.org/
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
--about=<value>: Basic options--ambiance-exclude=<value>: Sound options--ambiance-file=<value>: Sound options--ambiance-filter=<value>: Sound options--animation-density=<value>: Map style.xml--animation-speed=<value>: Map style.xml--audit: Basic options--background-color-auto=<value>: Map hints.xml--background-color-root-bg=<value>: Map style.xml--background-color-root-fg=<value>: Map style.xml--background-color-stuff-bg=<value>: Map style.xml--background-color-stuff-fg=<value>: Map style.xml--background-style=<value>: Map style.xml--base64-decode: Advanced settings--base64-encode: Advanced settings--bench: Advanced settings--bench-value=<value>: Advanced settings--bin-id=<value>: Advanced settings--bind-ip=<value>: Network options--bind-port=<value>: Network options--blink-cursor=<value>: Map style.xml--boost-power=<value>: Map rules.xml--bot-iq=<value>: Map teams.xml--bot-speed=<value>: Map teams.xml--bot1-ai=<value>: Map teams.xml--bot1-color=<value>: Map teams.xml--bot2-ai=<value>: Map teams.xml--bot2-color=<value>: Map teams.xml--bot3-ai=<value>: Map teams.xml--bot3-color=<value>: Map teams.xml--bot4-ai=<value>: Map teams.xml--bot4-color=<value>: Map teams.xml--bot5-ai=<value>: Map teams.xml--bot5-color=<value>: Map teams.xml--bot6-ai=<value>: Map teams.xml--bot6-color=<value>: Map teams.xml--bot7-ai=<value>: Map teams.xml--bot7-color=<value>: Map teams.xml--bot8-ai=<value>: Map teams.xml--bot8-color=<value>: Map teams.xml--bot9-ai=<value>: Map teams.xml--bot9-color=<value>: Map teams.xml--broadcast=<value>: Network options--capture=<value>: Graphics options--check: Advanced settings--chosen-map=<value>: Map parameters--cli-backends=<value>: Network options--click-to-focus=<value>: Input options--color-alternate-bg=<value>: Map style.xml--color-alternate-fg=<value>: Map style.xml--color-base-bg=<value>: Map style.xml--color-base-fg=<value>: Map style.xml--color-conflict-mode=<value>: Map rules.xml--colorize-cursor=<value>: Map style.xml--colorize=<value>: Map style.xml--commands-per-sec=<value>: Advanced settings--config-file: Path options--copyright: Basic options--cursor-pot-init=<value>: Map rules.xml--cursor-sensitivity=<value>: Input options--cursor-size=<value>: Map style.xml--custom-alt=<value>: Input options--custom-ctrl=<value>: Input options--custom-down=<value>: Input options--custom-enter=<value>: Input options--custom-esc=<value>: Input options--custom-left=<value>: Input options--custom-pgdown=<value>: Input options--custom-pgup=<value>: Input options--custom-right=<value>: Input options--custom-up=<value>: Input options--daemon: Advanced settings--danger-power=<value>: Map rules.xml--data-dir: Path options--debug: Basic options--debug-layer-id=<value>: Advanced settings--debug-team-id=<value>: Advanced settings--defaults: Basic options--demo: Advanced settings--dirty-read=<value>: Advanced settings--display-background=<value>: Advanced settings--display-console=<value>: Advanced settings--display-cursors=<value>: Advanced settings--display-debug-gradient=<value>: Advanced settings--display-debug-zones=<value>: Advanced settings--display-fighters=<value>: Advanced settings--display-fps=<value>: Advanced settings--display-hud=<value>: Advanced settings--display-log=<value>: Advanced settings--display-map=<value>: Advanced settings--display-menu=<value>: Advanced settings--display-meta=<value>: Advanced settings--display-mouse=<value>: Advanced settings--display-mps=<value>: Advanced settings--display-preview=<value>: Advanced settings--display-progress=<value>: Advanced settings--display-score=<value>: Advanced settings--display-splash=<value>: Advanced settings--display-url=<value>: Advanced settings--double-click-delay=<value>: Input options--downsize-using-bench-value=<value>: Map hints.xml--downsize-using-fighter-scale=<value>: Map hints.xml--example-hints-xml: Doc options--example-rules-xml: Doc options--example-style-xml: Doc options--example-teams-xml: Doc options--executed-again=<value>: Advanced settings--exp=<value>: Map rules.xml--fighter-attack=<value>: Map rules.xml--fighter-defense=<value>: Map rules.xml--fighter-new-health=<value>: Map rules.xml--fighter-regenerate=<value>: Map rules.xml--fighter-scale=<value>: Map hints.xml--force=<value>: Map parameters--frags-fade-out=<value>: Map rules.xml--frags-mode=<value>: Map rules.xml--frags-to-distribute=<value>: Map rules.xml--fullscreen=<value>: Graphics options--fx-volume=<value>: Sound options--gfx-backend=<value>: Graphics options--gfx-cpu-usage=<value>: Advanced settings--gfx-debug=<value>: Advanced settings--gfx-quality=<value>: Graphics options--glue-power=<value>: Map rules.xml--guess-colors=<value>: Map hints.xml--guess-moves-per-sec=<value>: Map hints.xml--height=<value>: Graphics options--help: Basic options--hidden-layer-alpha=<value>: Map style.xml--highest-team-color-allowed=<value>: Map rules.xml--highest-weapon-allowed=<value>: Map rules.xml--host: Basic options--hud-color-auto=<value>: Map hints.xml--hud-color-frame-bg=<value>: Map style.xml--hud-color-frame-fg=<value>: Map style.xml--hud-color-text-bg=<value>: Map style.xml--hud-color-text-fg=<value>: Map style.xml--hud-style=<value>: Map style.xml--io-per-sec=<value>: Advanced settings--keep-ratio=<value>: Map style.xml--known-nodes=<value>: Network options--list: Basic options--list-advanced: Doc options--list-aliases: Doc options--list-doc: Doc options--list-funcs: Doc options--list-graphics: Doc options--list-hooks: Doc options--list-input: Doc options--list-map: Doc options--list-map-hints: Doc options--list-map-rules: Doc options--list-map-style: Doc options--list-map-teams: Doc options--list-network: Doc options--list-path: Doc options--list-players: Doc options--list-quick: Doc options--list-show: Doc options--list-sound: Doc options--list-team-colors: Doc options--list-weapons: Doc options--loader-sleep=<value>: Advanced settings--log-file=<value>: Path options--log-level=<value>: Advanced settings--log-timeout=<value>: Advanced settings--magic-number=<value>: Advanced settings--map-dir: Path options--map-path=<value>: Path options--max-cursor-pot-offset=<value>: Map rules.xml--max-cursor-pot=<value>: Map rules.xml--max-cursor-speed=<value>: Input options--max-local-bench-value=<value>: Advanced settings--max-map-height=<value>: Map hints.xml--max-map-surface=<value>: Map hints.xml--max-map-width=<value>: Map hints.xml--max-nb-cursors=<value>: Map rules.xml--max-nb-nodes=<value>: Map rules.xml--max-nb-teams=<value>: Map rules.xml--max-network-bench-value=<value>: Advanced settings--max-round-delta=<value>: Map rules.xml--max-zone-size=<value>: Map rules.xml--medicine-power=<value>: Map rules.xml--memory-bazooka-eraser=<value>: Advanced settings--memory-bazooka-size=<value>: Advanced settings--menu-color-auto=<value>: Map hints.xml--menu-color-default-bg=<value>: Map style.xml--menu-color-default-fg=<value>: Map style.xml--menu-color-disabled-bg=<value>: Map style.xml--menu-color-disabled-fg=<value>: Map style.xml--menu-color-selected-bg=<value>: Map style.xml--menu-color-selected-fg=<value>: Map style.xml--menu-style=<value>: Map style.xml--min-map-height=<value>: Map hints.xml--min-map-surface=<value>: Map hints.xml--min-map-width=<value>: Map hints.xml--mod-dir: Path options--modules: Basic options--mouse-sensitivity=<value>: Input options--moves-per-round=<value>: Map rules.xml--music-dir=<value>: Path options--music-exclude=<value>: Map style.xml--music-file=<value>: Map style.xml--music-filter=<value>: Map style.xml--music-path=<value>: Path options--music-volume=<value>: Sound options--nb-attack-tries=<value>: Map rules.xml--nb-bots=<value>: Map teams.xml--nb-defense-tries=<value>: Map rules.xml--nb-move-tries=<value>: Map rules.xml--net-log=<value>: Advanced settings--network-reliability=<value>: Advanced settings--node-description=<value>: Network options--node-title=<value>: Network options--open-relay=<value>: Advanced settings--password=<value>: Network options--pedigree: Basic options--pilot-lag=<value>: Advanced settings--pixelize=<value>: Map style.xml--player1-color=<value>: Map teams.xml--player1-control=<value>: Players options--player1-name=<value>: Players options--player1-status=<value>: Players options--player2-color=<value>: Map teams.xml--player2-control=<value>: Players options--player2-name=<value>: Players options--player2-status=<value>: Players options--player3-color=<value>: Map teams.xml--player3-control=<value>: Players options--player3-name=<value>: Players options--player3-status=<value>: Players options--player4-color=<value>: Map teams.xml--player4-control=<value>: Players options--player4-name=<value>: Players options--player4-status=<value>: Players options--prefix: Path options--public-url=<value>: Network options--quick-start: Advanced settings--repeat-delay=<value>: Input options--repeat-interval=<value>: Input options--resample=<value>: Map hints.xml--reset: Advanced settings--reset-config-on-upgrade=<value>: Advanced settings--respawn-delay=<value>: Map rules.xml--respawn-position-mode=<value>: Map rules.xml--respawn-team=<value>: Map rules.xml--round-delta=<value>: Map rules.xml--rounds-per-sec=<value>: Map rules.xml--script-file: Path options--server: Advanced settings--show-build-bin-id: Show options--show-build-bugs-url: Show options--show-build-cflags: Show options--show-build-codename: Show options--show-build-configure-args: Show options--show-build-copyright: Show options--show-build-datadir: Show options--show-build-date: Show options--show-build-docdir: Show options--show-build-enable-allinone: Show options--show-build-enable-console: Show options--show-build-enable-fullstatic: Show options--show-build-enable-gcov: Show options--show-build-enable-gprof: Show options--show-build-enable-gtk: Show options--show-build-enable-instrument: Show options--show-build-enable-mod-csound: Show options--show-build-enable-mod-gl: Show options--show-build-enable-mod-http: Show options--show-build-enable-mod-ogg: Show options--show-build-enable-openmp: Show options--show-build-enable-optimize: Show options--show-build-enable-paranoid: Show options--show-build-enable-profiler: Show options--show-build-enable-valgrind: Show options--show-build-endianness: Show options--show-build-gcc-version: Show options--show-build-gnu: Show options--show-build-gp2x: Show options--show-build-home-url: Show options--show-build-host-cpu: Show options--show-build-host-os: Show options--show-build-hostname: Show options--show-build-includedir: Show options--show-build-ldflags: Show options--show-build-libdir: Show options--show-build-license: Show options--show-build-localedir: Show options--show-build-mac-os-x: Show options--show-build-md5sum: Show options--show-build-ms-windows: Show options--show-build-package-name: Show options--show-build-package-string: Show options--show-build-package-tarname: Show options--show-build-pointer-size: Show options--show-build-prefix: Show options--show-build-stamp: Show options--show-build-time: Show options--show-build-top-srcdir: Show options--show-build-unix: Show options--show-build-version: Show options--show-build-x86: Show options--show-config-file: Show options--show-cwd: Show options--show-data-dir: Show options--show-default-config-file: Show options--show-default-data-dir: Show options--show-default-log-file: Show options--show-default-map-dir: Show options--show-default-map-path: Show options--show-default-mod-dir: Show options--show-default-music-dir: Show options--show-default-music-path: Show options--show-default-prefix: Show options--show-default-script-file: Show options--show-default-user-dir: Show options--show-log-file: Show options--show-map-dir: Show options--show-map-path: Show options--show-mod-dir: Show options--show-music-dir: Show options--show-music-path: Show options--show-prefix: Show options--show-run-dir: Show options--show-script-file: Show options--show-user-dir: Show options--side-attack-factor=<value>: Map rules.xml--side-defense-factor=<value>: Map rules.xml--simulate-basic: Advanced settings--simulate-full: Advanced settings--single-army-size=<value>: Map rules.xml--skip-network=<value>: Network options--snd-backend=<value>: Sound options--speed=<value>: Map hints.xml--spread-mode=<value>: Map rules.xml--spread-thread=<value>: Map rules.xml--spreads-per-round=<value>: Map rules.xml--srv-backends=<value>: Network options--start-blue-x=<value>: Map rules.xml--start-blue-y=<value>: Map rules.xml--start-cyan-x=<value>: Map rules.xml--start-cyan-y=<value>: Map rules.xml--start-green-x=<value>: Map rules.xml--start-green-y=<value>: Map rules.xml--start-lightblue-x=<value>: Map rules.xml--start-lightblue-y=<value>: Map rules.xml--start-magenta-x=<value>: Map rules.xml--start-magenta-y=<value>: Map rules.xml--start-orange-x=<value>: Map rules.xml--start-orange-y=<value>: Map rules.xml--start-pink-x=<value>: Map rules.xml--start-pink-y=<value>: Map rules.xml--start-position-mode=<value>: Map rules.xml--start-purple-x=<value>: Map rules.xml--start-purple-y=<value>: Map rules.xml--start-red-x=<value>: Map rules.xml--start-red-y=<value>: Map rules.xml--start-yellow-x=<value>: Map rules.xml--start-yellow-y=<value>: Map rules.xml--system-color-auto=<value>: Map hints.xml--system-color-bg=<value>: Map style.xml--system-color-fg=<value>: Map style.xml--target-fps=<value>: Advanced settings--team-color-blue=<value>: Map style.xml--team-color-cyan=<value>: Map style.xml--team-color-dead=<value>: Map style.xml--team-color-green=<value>: Map style.xml--team-color-lightblue=<value>: Map style.xml--team-color-magenta=<value>: Map style.xml--team-color-orange=<value>: Map style.xml--team-color-pink=<value>: Map style.xml--team-color-purple=<value>: Map style.xml--team-color-red=<value>: Map style.xml--team-color-yellow=<value>: Map style.xml--team-profile-blue-aggressive=<value>: Map rules.xml--team-profile-blue-fast=<value>: Map rules.xml--team-profile-blue-mobile=<value>: Map rules.xml--team-profile-blue-vulnerable=<value>: Map rules.xml--team-profile-blue-weapon-alternate-id=<value>: Map rules.xml--team-profile-blue-weapon-id=<value>: Map rules.xml--team-profile-blue-weapon-mode=<value>: Map rules.xml--team-profile-cyan-aggressive=<value>: Map rules.xml--team-profile-cyan-fast=<value>: Map rules.xml--team-profile-cyan-mobile=<value>: Map rules.xml--team-profile-cyan-vulnerable=<value>: Map rules.xml--team-profile-cyan-weapon-alternate-id=<value>: Map rules.xml--team-profile-cyan-weapon-id=<value>: Map rules.xml--team-profile-cyan-weapon-mode=<value>: Map rules.xml--team-profile-green-aggressive=<value>: Map rules.xml--team-profile-green-fast=<value>: Map rules.xml--team-profile-green-mobile=<value>: Map rules.xml--team-profile-green-vulnerable=<value>: Map rules.xml--team-profile-green-weapon-alternate-id=<value>: Map rules.xml--team-profile-green-weapon-id=<value>: Map rules.xml--team-profile-green-weapon-mode=<value>: Map rules.xml--team-profile-lightblue-aggressive=<value>: Map rules.xml--team-profile-lightblue-fast=<value>: Map rules.xml--team-profile-lightblue-mobile=<value>: Map rules.xml--team-profile-lightblue-vulnerable=<value>: Map rules.xml--team-profile-lightblue-weapon-alternate-id=<value>: Map rules.xml--team-profile-lightblue-weapon-id=<value>: Map rules.xml--team-profile-lightblue-weapon-mode=<value>: Map rules.xml--team-profile-magenta-aggressive=<value>: Map rules.xml--team-profile-magenta-fast=<value>: Map rules.xml--team-profile-magenta-mobile=<value>: Map rules.xml--team-profile-magenta-vulnerable=<value>: Map rules.xml--team-profile-magenta-weapon-alternate-id=<value>: Map rules.xml--team-profile-magenta-weapon-id=<value>: Map rules.xml--team-profile-magenta-weapon-mode=<value>: Map rules.xml--team-profile-orange-aggressive=<value>: Map rules.xml--team-profile-orange-fast=<value>: Map rules.xml--team-profile-orange-mobile=<value>: Map rules.xml--team-profile-orange-vulnerable=<value>: Map rules.xml--team-profile-orange-weapon-alternate-id=<value>: Map rules.xml--team-profile-orange-weapon-id=<value>: Map rules.xml--team-profile-orange-weapon-mode=<value>: Map rules.xml--team-profile-pink-aggressive=<value>: Map rules.xml--team-profile-pink-fast=<value>: Map rules.xml--team-profile-pink-mobile=<value>: Map rules.xml--team-profile-pink-vulnerable=<value>: Map rules.xml--team-profile-pink-weapon-alternate-id=<value>: Map rules.xml--team-profile-pink-weapon-id=<value>: Map rules.xml--team-profile-pink-weapon-mode=<value>: Map rules.xml--team-profile-purple-aggressive=<value>: Map rules.xml--team-profile-purple-fast=<value>: Map rules.xml--team-profile-purple-mobile=<value>: Map rules.xml--team-profile-purple-vulnerable=<value>: Map rules.xml--team-profile-purple-weapon-alternate-id=<value>: Map rules.xml--team-profile-purple-weapon-id=<value>: Map rules.xml--team-profile-purple-weapon-mode=<value>: Map rules.xml--team-profile-red-aggressive=<value>: Map rules.xml--team-profile-red-fast=<value>: Map rules.xml--team-profile-red-mobile=<value>: Map rules.xml--team-profile-red-vulnerable=<value>: Map rules.xml--team-profile-red-weapon-alternate-id=<value>: Map rules.xml--team-profile-red-weapon-id=<value>: Map rules.xml--team-profile-red-weapon-mode=<value>: Map rules.xml--team-profile-yellow-aggressive=<value>: Map rules.xml--team-profile-yellow-fast=<value>: Map rules.xml--team-profile-yellow-mobile=<value>: Map rules.xml--team-profile-yellow-vulnerable=<value>: Map rules.xml--team-profile-yellow-weapon-alternate-id=<value>: Map rules.xml--team-profile-yellow-weapon-id=<value>: Map rules.xml--team-profile-yellow-weapon-mode=<value>: Map rules.xml--test: Basic options--total-armies-size=<value>: Map rules.xml--total-time=<value>: Map rules.xml--trap-errors=<value>: Advanced settings--trojan=<value>: Advanced settings--upsize-using-bench-value=<value>: Map hints.xml--upsize-using-fighter-scale=<value>: Map hints.xml--use-cursor-texture=<value>: Map parameters--use-double-click=<value>: Input options--use-esc-button=<value>: Input options--use-hints-xml=<value>: Map parameters--use-music-file=<value>: Map parameters--use-rules-xml=<value>: Map parameters--use-style-xml=<value>: Map parameters--use-team-profiles=<value>: Map rules.xml--use-teams-xml=<value>: Map parameters--use-texture=<value>: Map parameters--user-dir=<value>: Path options--version: Basic options--vertical-move=<value>: Map rules.xml--view-color-auto=<value>: Map hints.xml--view-color-cursor-bg=<value>: Map style.xml--view-color-cursor-fg=<value>: Map style.xml--view-color-map-bg=<value>: Map style.xml--view-color-map-fg=<value>: Map style.xml--view-style=<value>: Map style.xml--wall-grease=<value>: Map hints.xml--water-volume=<value>: Sound options--waves=<value>: Map style.xml--weapon-charge-delay=<value>: Map rules.xml--weapon-charge-max=<value>: Map rules.xml--weapon-duration=<value>: Map rules.xml--weapon-tune-berzerk-power=<value>: Map rules.xml--weapon-tune-turbo-power=<value>: Map rules.xml--width=<value>: Graphics options--windowed-mode-limit=<value>: Graphics options--x-polarity=<value>: Map rules.xml--x-wrap=<value>: Map style.xml--y-polarity=<value>: Map rules.xml--y-wrap=<value>: Map style.xml--z-decode: Advanced settings--z-encode: Advanced settings--z-polarity=<value>: Map rules.xml--zoom-max=<value>: Map style.xml--zoom-min=<value>: Map style.xml--zoom-step=<value>: Input options--zoom-stick-delay=<value>: Input options--zoom=<value>: Map style.xml_lw6p2p_db_now: libp2pambiance-exclude: Sound optionsambiance-file: Sound optionsambiance-filter: Sound optionsanimation-density: Map style.xmlanimation-speed: Map style.xmlbackground-color-auto: Map hints.xmlbackground-color-root-bg: Map style.xmlbackground-color-root-fg: Map style.xmlbackground-color-stuff-bg: Map style.xmlbackground-color-stuff-fg: Map style.xmlbackground-style: Map style.xmlbench-value: Advanced settingsbin-id: Advanced settingsbind-ip: Network optionsbind-port: Network optionsblink-cursor: Map style.xmlboost-power: Map rules.xmlbot-iq: Map teams.xmlbot-speed: Map teams.xmlbot1-ai: Map teams.xmlbot1-color: Map teams.xmlbot2-ai: Map teams.xmlbot2-color: Map teams.xmlbot3-ai: Map teams.xmlbot3-color: Map teams.xmlbot4-ai: Map teams.xmlbot4-color: Map teams.xmlbot5-ai: Map teams.xmlbot5-color: Map teams.xmlbot6-ai: Map teams.xmlbot6-color: Map teams.xmlbot7-ai: Map teams.xmlbot7-color: Map teams.xmlbot8-ai: Map teams.xmlbot8-color: Map teams.xmlbot9-ai: Map teams.xmlbot9-color: Map teams.xmlbroadcast: Network optionsc-gettext: C to Guilec-lw6-exit: C to Guilec-lw6-release: C to Guilec-lw6bot-get-backends: C to Guilec-lw6bot-new: C to Guilec-lw6bot-next-move: C to Guilec-lw6cfg-defaults: C to Guilec-lw6cfg-get-option: C to Guilec-lw6cfg-init: C to Guilec-lw6cfg-load: C to Guilec-lw6cfg-option-exists: C to Guilec-lw6cfg-quit: C to Guilec-lw6cfg-save: C to Guilec-lw6cfg-set-option: C to Guilec-lw6cfg-unified-get-log-file: C to Guilec-lw6cfg-unified-get-map-path: C to Guilec-lw6cfg-unified-get-music-path: C to Guilec-lw6cfg-unified-get-user-dir: C to Guilec-lw6cli-get-backends: C to Guilec-lw6cns-init: C to Guilec-lw6cns-poll: C to Guilec-lw6cns-quit: C to Guilec-lw6cns-support: C to Guilec-lw6dsp-get-average-fps: C to Guilec-lw6dsp-get-fullscreen-modes: C to Guilec-lw6dsp-get-instant-fps: C to Guilec-lw6dsp-get-last-frame-rendering-time: C to Guilec-lw6dsp-get-nb-frames: C to Guilec-lw6dsp-get-video-mode: C to Guilec-lw6dsp-new: C to Guilec-lw6dsp-release: C to Guilec-lw6dsp-update: C to Guilec-lw6gfx-get-backends: C to Guilec-lw6gui-default-look: C to Guilec-lw6gui-input-reset: C to Guilec-lw6gui-joystick1-get-move-pad: C to Guilec-lw6gui-joystick1-pop-button-a: C to Guilec-lw6gui-joystick1-pop-button-b: C to Guilec-lw6gui-joystick1-pop-button-c: C to Guilec-lw6gui-joystick1-pop-button-d: C to Guilec-lw6gui-joystick1-pop-button-e: C to Guilec-lw6gui-joystick1-pop-button-f: C to Guilec-lw6gui-joystick1-pop-pad-down: C to Guilec-lw6gui-joystick1-pop-pad-left: C to Guilec-lw6gui-joystick1-pop-pad-right: C to Guilec-lw6gui-joystick1-pop-pad-up: C to Guilec-lw6gui-joystick2-get-move-pad: C to Guilec-lw6gui-joystick2-pop-button-a: C to Guilec-lw6gui-joystick2-pop-button-b: C to Guilec-lw6gui-joystick2-pop-button-c: C to Guilec-lw6gui-joystick2-pop-button-d: C to Guilec-lw6gui-joystick2-pop-button-e: C to Guilec-lw6gui-joystick2-pop-button-f: C to Guilec-lw6gui-joystick2-pop-pad-down: C to Guilec-lw6gui-joystick2-pop-pad-left: C to Guilec-lw6gui-joystick2-pop-pad-right: C to Guilec-lw6gui-joystick2-pop-pad-up: C to Guilec-lw6gui-keyboard-get-move-pad: C to Guilec-lw6gui-keyboard-is-pressed: C to Guilec-lw6gui-keyboard-pop-arrow-down: C to Guilec-lw6gui-keyboard-pop-arrow-left: C to Guilec-lw6gui-keyboard-pop-arrow-right: C to Guilec-lw6gui-keyboard-pop-arrow-up: C to Guilec-lw6gui-keyboard-pop-key-alt: C to Guilec-lw6gui-keyboard-pop-key-ctrl: C to Guilec-lw6gui-keyboard-pop-key-enter: C to Guilec-lw6gui-keyboard-pop-key-esc: C to Guilec-lw6gui-keyboard-pop-key-pgdown: C to Guilec-lw6gui-keyboard-pop-key-pgup: C to Guilec-lw6gui-look-get: C to Guilec-lw6gui-look-set: C to Guilec-lw6gui-look-zoom-in: C to Guilec-lw6gui-look-zoom-out: C to Guilec-lw6gui-menu-append: C to Guilec-lw6gui-menu-close-popup: C to Guilec-lw6gui-menu-enable-esc: C to Guilec-lw6gui-menu-has-popup: C to Guilec-lw6gui-menu-new: C to Guilec-lw6gui-menu-scroll-down: C to Guilec-lw6gui-menu-scroll-up: C to Guilec-lw6gui-menu-select: C to Guilec-lw6gui-menu-select-esc: C to Guilec-lw6gui-menu-set-breadcrumbs: C to Guilec-lw6gui-menu-sync: C to Guilec-lw6gui-mouse-get-state: C to Guilec-lw6gui-mouse-poll-move: C to Guilec-lw6gui-mouse-pop-button-left: C to Guilec-lw6gui-mouse-pop-button-middle: C to Guilec-lw6gui-mouse-pop-button-right: C to Guilec-lw6gui-mouse-pop-double-click: C to Guilec-lw6gui-mouse-pop-simple-click: C to Guilec-lw6gui-mouse-pop-triple-click: C to Guilec-lw6gui-mouse-pop-wheel-down: C to Guilec-lw6gui-mouse-pop-wheel-up: C to Guilec-lw6hlp-about: C to Guilec-lw6hlp-get-default-value: C to Guilec-lw6hlp-list: C to Guilec-lw6hlp-list-advanced: C to Guilec-lw6hlp-list-aliases: C to Guilec-lw6hlp-list-doc: C to Guilec-lw6hlp-list-funcs: C to Guilec-lw6hlp-list-graphics: C to Guilec-lw6hlp-list-hooks: C to Guilec-lw6hlp-list-input: C to Guilec-lw6hlp-list-map: C to Guilec-lw6hlp-list-map-hints: C to Guilec-lw6hlp-list-map-rules: C to Guilec-lw6hlp-list-map-style: C to Guilec-lw6hlp-list-map-teams: C to Guilec-lw6hlp-list-network: C to Guilec-lw6hlp-list-path: C to Guilec-lw6hlp-list-players: C to Guilec-lw6hlp-list-quick: C to Guilec-lw6hlp-list-show: C to Guilec-lw6hlp-list-sound: C to Guilec-lw6hlp-list-team-colors: C to Guilec-lw6hlp-list-weapons: C to Guilec-lw6ker-add-cursor: C to Guilec-lw6ker-build-game-state: C to Guilec-lw6ker-build-game-struct: C to Guilec-lw6ker-cursor-exists: C to Guilec-lw6ker-did-cursor-win: C to Guilec-lw6ker-do-round: C to Guilec-lw6ker-dup-game-state: C to Guilec-lw6ker-game-state-checksum: C to Guilec-lw6ker-game-struct-checksum: C to Guilec-lw6ker-get-cursor: C to Guilec-lw6ker-get-moves: C to Guilec-lw6ker-get-rounds: C to Guilec-lw6ker-get-spreads: C to Guilec-lw6ker-is-over: C to Guilec-lw6ker-node-exists: C to Guilec-lw6ker-register-node: C to Guilec-lw6ker-remove-cursor: C to Guilec-lw6ker-set-cursor: C to Guilec-lw6ker-sync-game-state: C to Guilec-lw6ker-unregister-node: C to Guilec-lw6ldr-chain-entry: C to Guilec-lw6ldr-exp-validate: C to Guilec-lw6ldr-get-entries: C to Guilec-lw6ldr-hints-get-default: C to Guilec-lw6ldr-print-examples: C to Guilec-lw6ldr-read: C to Guilec-lw6ldr-read-relative: C to Guilec-lw6map-exp-get-unlocked-team-color: C to Guilec-lw6map-exp-get-unlocked-weapon: C to Guilec-lw6map-exp-is-team-color-allowed: C to Guilec-lw6map-exp-is-weapon-allowed: C to Guilec-lw6map-get-look: C to Guilec-lw6map-get-music-dir: C to Guilec-lw6map-param-get: C to Guilec-lw6map-rules-get-default: C to Guilec-lw6map-rules-get-int: C to Guilec-lw6map-rules-get-max: C to Guilec-lw6map-rules-get-min: C to Guilec-lw6map-style-get-default: C to Guilec-lw6map-team-color-index-to-key: C to Guilec-lw6map-team-color-index-to-label: C to Guilec-lw6map-team-color-key-to-index: C to Guilec-lw6map-team-color-list: C to Guilec-lw6map-teams-get-default: C to Guilec-lw6map-weapon-index-to-key: C to Guilec-lw6map-weapon-index-to-label: C to Guilec-lw6map-weapon-key-to-index: C to Guilec-lw6map-weapon-list: C to Guilec-lw6net-init: C to Guilec-lw6net-quit: C to Guilec-lw6p2p-db-default-name: C to Guilec-lw6p2p-db-new: C to Guilec-lw6p2p-db-reset: C to Guilec-lw6p2p-node-close: C to Guilec-lw6p2p-node-get-entries: C to Guilec-lw6p2p-node-get-id: C to Guilec-lw6p2p-node-new: C to Guilec-lw6p2p-node-poll: C to Guilec-lw6pil-bench: C to Guilec-lw6pil-build-pilot: C to Guilec-lw6pil-calibrate: C to Guilec-lw6pil-commit: C to Guilec-lw6pil-did-cursor-win: C to Guilec-lw6pil-execute-command: C to Guilec-lw6pil-fix-coords: C to Guilec-lw6pil-fix-coords-x10: C to Guilec-lw6pil-get-last-commit-seq: C to Guilec-lw6pil-get-looser: C to Guilec-lw6pil-get-max-seq: C to Guilec-lw6pil-get-next-seq: C to Guilec-lw6pil-get-reference-current-seq: C to Guilec-lw6pil-get-reference-target-seq: C to Guilec-lw6pil-get-winner: C to Guilec-lw6pil-is-over: C to Guilec-lw6pil-local-command: C to Guilec-lw6pil-local-cursors-set-main: C to Guilec-lw6pil-local-cursors-set-mouse-controlled: C to Guilec-lw6pil-make-backup: C to Guilec-lw6pil-send-command: C to Guilec-lw6pil-seq-random-0: C to Guilec-lw6pil-slow-down: C to Guilec-lw6pil-speed-up: C to Guilec-lw6pil-sync-from-backup: C to Guilec-lw6pil-sync-from-draft: C to Guilec-lw6pil-sync-from-reference: C to Guilec-lw6snd-get-backends: C to Guilec-lw6snd-is-music-file: C to Guilec-lw6snd-new: C to Guilec-lw6snd-play-fx: C to Guilec-lw6snd-play-music-file: C to Guilec-lw6snd-play-music-random: C to Guilec-lw6snd-poll: C to Guilec-lw6snd-release: C to Guilec-lw6snd-set-fx-volume: C to Guilec-lw6snd-set-music-volume: C to Guilec-lw6snd-set-water-volume: C to Guilec-lw6snd-stop-music: C to Guilec-lw6srv-get-backends: C to Guilec-lw6sys-build-get-bin-id: C to Guilec-lw6sys-build-get-bugs-url: C to Guilec-lw6sys-build-get-cflags: C to Guilec-lw6sys-build-get-codename: C to Guilec-lw6sys-build-get-configure-args: C to Guilec-lw6sys-build-get-copyright: C to Guilec-lw6sys-build-get-datadir: C to Guilec-lw6sys-build-get-date: C to Guilec-lw6sys-build-get-enable-allinone: C to Guilec-lw6sys-build-get-enable-console: C to Guilec-lw6sys-build-get-enable-fullstatic: C to Guilec-lw6sys-build-get-enable-gcov: C to Guilec-lw6sys-build-get-enable-gprof: C to Guilec-lw6sys-build-get-enable-gtk: C to Guilec-lw6sys-build-get-enable-instrument: C to Guilec-lw6sys-build-get-enable-mod-csound: C to Guilec-lw6sys-build-get-enable-mod-gl: C to Guilec-lw6sys-build-get-enable-mod-http: C to Guilec-lw6sys-build-get-enable-mod-ogg: C to Guilec-lw6sys-build-get-enable-openmp: C to Guilec-lw6sys-build-get-enable-optimize: C to Guilec-lw6sys-build-get-enable-paranoid: C to Guilec-lw6sys-build-get-enable-profiler: C to Guilec-lw6sys-build-get-enable-valgrind: C to Guilec-lw6sys-build-get-endianness: C to Guilec-lw6sys-build-get-gcc-version: C to Guilec-lw6sys-build-get-home-url: C to Guilec-lw6sys-build-get-host-cpu: C to Guilec-lw6sys-build-get-host-os: C to Guilec-lw6sys-build-get-hostname: C to Guilec-lw6sys-build-get-includedir: C to Guilec-lw6sys-build-get-ldflags: C to Guilec-lw6sys-build-get-libdir: C to Guilec-lw6sys-build-get-license: C to Guilec-lw6sys-build-get-localedir: C to Guilec-lw6sys-build-get-md5sum: C to Guilec-lw6sys-build-get-package-name: C to Guilec-lw6sys-build-get-package-string: C to Guilec-lw6sys-build-get-package-tarname: C to Guilec-lw6sys-build-get-pointer-size: C to Guilec-lw6sys-build-get-prefix: C to Guilec-lw6sys-build-get-stamp: C to Guilec-lw6sys-build-get-time: C to Guilec-lw6sys-build-get-top-srcdir: C to Guilec-lw6sys-build-get-version: C to Guilec-lw6sys-build-is-gnu: C to Guilec-lw6sys-build-is-gp2x: C to Guilec-lw6sys-build-is-mac-os-x: C to Guilec-lw6sys-build-is-ms-windows: C to Guilec-lw6sys-build-is-unix: C to Guilec-lw6sys-build-is-x86: C to Guilec-lw6sys-debug-get: C to Guilec-lw6sys-debug-set: C to Guilec-lw6sys-delay: C to Guilec-lw6sys-dump: C to Guilec-lw6sys-dump-clear: C to Guilec-lw6sys-generate-id-16: C to Guilec-lw6sys-generate-id-32: C to Guilec-lw6sys-generate-id-64: C to Guilec-lw6sys-get-config-file: C to Guilec-lw6sys-get-cwd: C to Guilec-lw6sys-get-cycle: C to Guilec-lw6sys-get-data-dir: C to Guilec-lw6sys-get-default-config-file: C to Guilec-lw6sys-get-default-data-dir: C to Guilec-lw6sys-get-default-log-file: C to Guilec-lw6sys-get-default-map-dir: C to Guilec-lw6sys-get-default-map-path: C to Guilec-lw6sys-get-default-mod-dir: C to Guilec-lw6sys-get-default-music-dir: C to Guilec-lw6sys-get-default-music-path: C to Guilec-lw6sys-get-default-prefix: C to Guilec-lw6sys-get-default-script-file: C to Guilec-lw6sys-get-default-user-dir: C to Guilec-lw6sys-get-hostname: C to Guilec-lw6sys-get-log-file: C to Guilec-lw6sys-get-map-dir: C to Guilec-lw6sys-get-map-path: C to Guilec-lw6sys-get-mod-dir: C to Guilec-lw6sys-get-music-dir: C to Guilec-lw6sys-get-music-path: C to Guilec-lw6sys-get-prefix: C to Guilec-lw6sys-get-run-dir: C to Guilec-lw6sys-get-script-file: C to Guilec-lw6sys-get-timestamp: C to Guilec-lw6sys-get-uptime: C to Guilec-lw6sys-get-user-dir: C to Guilec-lw6sys-get-username: C to Guilec-lw6sys-getenv: C to Guilec-lw6sys-getenv-prefixed: C to Guilec-lw6sys-idle: C to Guilec-lw6sys-log: C to Guilec-lw6sys-log-get-level: C to Guilec-lw6sys-log-set-level: C to Guilec-lw6sys-megabytes-available: C to Guilec-lw6sys-openmp-get-num-procs: C to Guilec-lw6sys-path-concat: C to Guilec-lw6sys-path-file-only: C to Guilec-lw6sys-path-parent: C to Guilec-lw6sys-path-split: C to Guilec-lw6sys-set-memory-bazooka-eraser: C to Guilec-lw6sys-set-memory-bazooka-size: C to Guilec-lw6sys-signal-custom: C to Guilec-lw6sys-signal-default: C to Guilec-lw6sys-signal-poll-quit: C to Guilec-lw6sys-signal-send-quit: C to Guilec-lw6sys-sleep: C to Guilec-lw6sys-snooze: C to Guilec-lw6sys-url-canonize: C to Guilec-lw6tsk-loader-get-stage: C to Guilec-lw6tsk-loader-new: C to Guilec-lw6tsk-loader-pop: C to Guilec-lw6tsk-loader-push: C to Guilecapture: Graphics optionschosen-map: Map parameterscli-backends: Network optionsclick-to-focus: Input optionscolor-alternate-bg: Map style.xmlcolor-alternate-fg: Map style.xmlcolor-base-bg: Map style.xmlcolor-base-fg: Map style.xmlcolor-conflict-mode: Map rules.xmlcolorize: Map style.xmlcolorize-cursor: Map style.xmlcommands-per-sec: Advanced settingscursor-pot-init: Map rules.xmlcursor-sensitivity: Input optionscursor-size: Map style.xmlcustom-alt: Input optionscustom-ctrl: Input optionscustom-down: Input optionscustom-enter: Input optionscustom-esc: Input optionscustom-left: Input optionscustom-pgdown: Input optionscustom-pgup: Input optionscustom-right: Input optionscustom-up: Input optionsdanger-power: Map rules.xmldebug-layer-id: Advanced settingsdebug-team-id: Advanced settingsdirty-read: Advanced settingsdisplay-background: Advanced settingsdisplay-console: Advanced settingsdisplay-cursors: Advanced settingsdisplay-debug-gradient: Advanced settingsdisplay-debug-zones: Advanced settingsdisplay-fighters: Advanced settingsdisplay-fps: Advanced settingsdisplay-hud: Advanced settingsdisplay-log: Advanced settingsdisplay-map: Advanced settingsdisplay-menu: Advanced settingsdisplay-meta: Advanced settingsdisplay-mouse: Advanced settingsdisplay-mps: Advanced settingsdisplay-preview: Advanced settingsdisplay-progress: Advanced settingsdisplay-score: Advanced settingsdisplay-splash: Advanced settingsdisplay-url: Advanced settingsdouble-click-delay: Input optionsdownsize-using-bench-value: Map hints.xmldownsize-using-fighter-scale: Map hints.xmlexecuted-again: Advanced settingsexp: Map rules.xmlfighter-attack: Map rules.xmlfighter-defense: Map rules.xmlfighter-new-health: Map rules.xmlfighter-regenerate: Map rules.xmlfighter-scale: Map hints.xmlforce: Map parametersfrags-fade-out: Map rules.xmlfrags-mode: Map rules.xmlfrags-to-distribute: Map rules.xmlfullscreen: Graphics optionsfx-volume: Sound optionsgfx-backend: Graphics optionsgfx-cpu-usage: Advanced settingsgfx-debug: Advanced settingsgfx-quality: Graphics optionsglue-power: Map rules.xmlguess-colors: Map hints.xmlguess-moves-per-sec: Map hints.xmlheight: Graphics optionshidden-layer-alpha: Map style.xmlhighest-team-color-allowed: Map rules.xmlhighest-weapon-allowed: Map rules.xmlhud-color-auto: Map hints.xmlhud-color-frame-bg: Map style.xmlhud-color-frame-fg: Map style.xmlhud-color-text-bg: Map style.xmlhud-color-text-fg: Map style.xmlhud-style: Map style.xmlio-per-sec: Advanced settingskeep-ratio: Map style.xmlknown-nodes: Network optionsloader-sleep: Advanced settingslog-file: Path optionslog-level: Advanced settingslog-timeout: Advanced settingsLW6_AMBIANCE_EXCLUDE: Sound optionsLW6_AMBIANCE_FILE: Sound optionsLW6_AMBIANCE_FILTER: Sound optionsLW6_ANIMATION_DENSITY: Map style.xmlLW6_ANIMATION_SPEED: Map style.xmlLW6_BACKGROUND_COLOR_AUTO: Map hints.xmlLW6_BACKGROUND_COLOR_ROOT_BG: Map style.xmlLW6_BACKGROUND_COLOR_ROOT_FG: Map style.xmlLW6_BACKGROUND_COLOR_STUFF_BG: Map style.xmlLW6_BACKGROUND_COLOR_STUFF_FG: Map style.xmlLW6_BACKGROUND_STYLE: Map style.xmlLW6_BENCH_VALUE: Advanced settingsLW6_BIN_ID: Advanced settingsLW6_BIND_IP: Network optionsLW6_BIND_PORT: Network optionsLW6_BLINK_CURSOR: Map style.xmlLW6_BOOST_POWER: Map rules.xmlLW6_BOT1_AI: Map teams.xmlLW6_BOT1_COLOR: Map teams.xmlLW6_BOT2_AI: Map teams.xmlLW6_BOT2_COLOR: Map teams.xmlLW6_BOT3_AI: Map teams.xmlLW6_BOT3_COLOR: Map teams.xmlLW6_BOT4_AI: Map teams.xmlLW6_BOT4_COLOR: Map teams.xmlLW6_BOT5_AI: Map teams.xmlLW6_BOT5_COLOR: Map teams.xmlLW6_BOT6_AI: Map teams.xmlLW6_BOT6_COLOR: Map teams.xmlLW6_BOT7_AI: Map teams.xmlLW6_BOT7_COLOR: Map teams.xmlLW6_BOT8_AI: Map teams.xmlLW6_BOT8_COLOR: Map teams.xmlLW6_BOT9_AI: Map teams.xmlLW6_BOT9_COLOR: Map teams.xmlLW6_BOT_IQ: Map teams.xmlLW6_BOT_SPEED: Map teams.xmlLW6_BROADCAST: Network optionsLW6_CAPTURE: Graphics optionsLW6_CHOSEN_MAP: Map parametersLW6_CLI_BACKENDS: Network optionsLW6_CLICK_TO_FOCUS: Input optionslw6_cns_handler: libliquidwar6LW6_COLOR_ALTERNATE_BG: Map style.xmlLW6_COLOR_ALTERNATE_FG: Map style.xmlLW6_COLOR_BASE_BG: Map style.xmlLW6_COLOR_BASE_FG: Map style.xmlLW6_COLOR_CONFLICT_MODE: Map rules.xmlLW6_COLORIZE: Map style.xmlLW6_COLORIZE_CURSOR: Map style.xmlLW6_COMMANDS_PER_SEC: Advanced settingsLW6_CURSOR_POT_INIT: Map rules.xmlLW6_CURSOR_SENSITIVITY: Input optionsLW6_CURSOR_SIZE: Map style.xmlLW6_CUSTOM_ALT: Input optionsLW6_CUSTOM_CTRL: Input optionsLW6_CUSTOM_DOWN: Input optionsLW6_CUSTOM_ENTER: Input optionsLW6_CUSTOM_ESC: Input optionsLW6_CUSTOM_LEFT: Input optionsLW6_CUSTOM_PGDOWN: Input optionsLW6_CUSTOM_PGUP: Input optionsLW6_CUSTOM_RIGHT: Input optionsLW6_CUSTOM_UP: Input optionsLW6_DANGER_POWER: Map rules.xmlLW6_DEBUG_LAYER_ID: Advanced settingsLW6_DEBUG_TEAM_ID: Advanced settingsLW6_DIRTY_READ: Advanced settingsLW6_DISPLAY_BACKGROUND: Advanced settingsLW6_DISPLAY_CONSOLE: Advanced settingsLW6_DISPLAY_CURSORS: Advanced settingsLW6_DISPLAY_DEBUG_GRADIENT: Advanced settingsLW6_DISPLAY_DEBUG_ZONES: Advanced settingsLW6_DISPLAY_FIGHTERS: Advanced settingsLW6_DISPLAY_FPS: Advanced settingsLW6_DISPLAY_HUD: Advanced settingsLW6_DISPLAY_LOG: Advanced settingsLW6_DISPLAY_MAP: Advanced settingsLW6_DISPLAY_MENU: Advanced settingsLW6_DISPLAY_META: Advanced settingsLW6_DISPLAY_MOUSE: Advanced settingsLW6_DISPLAY_MPS: Advanced settingsLW6_DISPLAY_PREVIEW: Advanced settingsLW6_DISPLAY_PROGRESS: Advanced settingsLW6_DISPLAY_SCORE: Advanced settingsLW6_DISPLAY_SPLASH: Advanced settingsLW6_DISPLAY_URL: Advanced settingsLW6_DOUBLE_CLICK_DELAY: Input optionsLW6_DOWNSIZE_USING_BENCH_VALUE: Map hints.xmlLW6_DOWNSIZE_USING_FIGHTER_SCALE: Map hints.xmlLW6_EXECUTED_AGAIN: Advanced settingslw6_exit: libliquidwar6LW6_EXP: Map rules.xmlLW6_FIGHTER_ATTACK: Map rules.xmlLW6_FIGHTER_DEFENSE: Map rules.xmlLW6_FIGHTER_NEW_HEALTH: Map rules.xmlLW6_FIGHTER_REGENERATE: Map rules.xmlLW6_FIGHTER_SCALE: Map hints.xmllw6_fix_env: libliquidwar6LW6_FORCE: Map parametersLW6_FRAGS_FADE_OUT: Map rules.xmlLW6_FRAGS_MODE: Map rules.xmlLW6_FRAGS_TO_DISTRIBUTE: Map rules.xmllw6_free_bot_smob: libliquidwar6lw6_free_db_smob: libliquidwar6lw6_free_dsp_smob: libliquidwar6lw6_free_game_state_smob: libliquidwar6lw6_free_game_struct_smob: libliquidwar6lw6_free_loader_smob: libliquidwar6lw6_free_look_smob: libliquidwar6lw6_free_map_smob: libliquidwar6lw6_free_menu_smob: libliquidwar6lw6_free_node_smob: libliquidwar6lw6_free_pilot_smob: libliquidwar6lw6_free_snd_smob: libliquidwar6LW6_FULLSCREEN: Graphics optionsLW6_FX_VOLUME: Sound optionsLW6_GFX_BACKEND: Graphics optionsLW6_GFX_CPU_USAGE: Advanced settingsLW6_GFX_DEBUG: Advanced settingsLW6_GFX_QUALITY: Graphics optionsLW6_GLUE_POWER: Map rules.xmlLW6_GUESS_COLORS: Map hints.xmlLW6_GUESS_MOVES_PER_SEC: Map hints.xmlLW6_HEIGHT: Graphics optionsLW6_HIDDEN_LAYER_ALPHA: Map style.xmlLW6_HIGHEST_TEAM_COLOR_ALLOWED: Map rules.xmlLW6_HIGHEST_WEAPON_ALLOWED: Map rules.xmlLW6_HUD_COLOR_AUTO: Map hints.xmlLW6_HUD_COLOR_FRAME_BG: Map style.xmlLW6_HUD_COLOR_FRAME_FG: Map style.xmlLW6_HUD_COLOR_TEXT_BG: Map style.xmlLW6_HUD_COLOR_TEXT_FG: Map style.xmlLW6_HUD_STYLE: Map style.xmllw6_init_global: libliquidwar6LW6_IO_PER_SEC: Advanced settingsLW6_KEEP_RATIO: Map style.xmlLW6_KNOWN_NODES: Network optionsLW6_LOADER_SLEEP: Advanced settingsLW6_LOG_FILE: Path optionsLW6_LOG_LEVEL: Advanced settingsLW6_LOG_TIMEOUT: Advanced settingsLW6_MAGIC_NUMBER: Advanced settingslw6_main: libliquidwar6lw6_make_scm_bot: libliquidwar6lw6_make_scm_db: libliquidwar6lw6_make_scm_dsp: libliquidwar6lw6_make_scm_game_state: libliquidwar6lw6_make_scm_game_struct: libliquidwar6lw6_make_scm_loader: libliquidwar6lw6_make_scm_look: libliquidwar6lw6_make_scm_map: libliquidwar6lw6_make_scm_menu: libliquidwar6lw6_make_scm_node: libliquidwar6lw6_make_scm_pilot: libliquidwar6lw6_make_scm_snd: libliquidwar6LW6_MAP_PATH: Path optionsLW6_MAX_CURSOR_POT: Map rules.xmlLW6_MAX_CURSOR_POT_OFFSET: Map rules.xmlLW6_MAX_CURSOR_SPEED: Input optionsLW6_MAX_LOCAL_BENCH_VALUE: Advanced settingsLW6_MAX_MAP_HEIGHT: Map hints.xmlLW6_MAX_MAP_SURFACE: Map hints.xmlLW6_MAX_MAP_WIDTH: Map hints.xmlLW6_MAX_NB_CURSORS: Map rules.xmlLW6_MAX_NB_NODES: Map rules.xmlLW6_MAX_NB_TEAMS: Map rules.xmlLW6_MAX_NETWORK_BENCH_VALUE: Advanced settingsLW6_MAX_ROUND_DELTA: Map rules.xmlLW6_MAX_ZONE_SIZE: Map rules.xmlLW6_MEDICINE_POWER: Map rules.xmlLW6_MEMORY_BAZOOKA_ERASER: Advanced settingsLW6_MEMORY_BAZOOKA_SIZE: Advanced settingsLW6_MENU_COLOR_AUTO: Map hints.xmlLW6_MENU_COLOR_DEFAULT_BG: Map style.xmlLW6_MENU_COLOR_DEFAULT_FG: Map style.xmlLW6_MENU_COLOR_DISABLED_BG: Map style.xmlLW6_MENU_COLOR_DISABLED_FG: Map style.xmlLW6_MENU_COLOR_SELECTED_BG: Map style.xmlLW6_MENU_COLOR_SELECTED_FG: Map style.xmlLW6_MENU_STYLE: Map style.xmlLW6_MIN_MAP_HEIGHT: Map hints.xmlLW6_MIN_MAP_SURFACE: Map hints.xmlLW6_MIN_MAP_WIDTH: Map hints.xmlLW6_MOUSE_SENSITIVITY: Input optionsLW6_MOVES_PER_ROUND: Map rules.xmlLW6_MUSIC_DIR: Path optionsLW6_MUSIC_EXCLUDE: Map style.xmlLW6_MUSIC_FILE: Map style.xmlLW6_MUSIC_FILTER: Map style.xmlLW6_MUSIC_PATH: Path optionsLW6_MUSIC_VOLUME: Sound optionsLW6_NB_ATTACK_TRIES: Map rules.xmlLW6_NB_BOTS: Map teams.xmlLW6_NB_DEFENSE_TRIES: Map rules.xmlLW6_NB_MOVE_TRIES: Map rules.xmlLW6_NET_LOG: Advanced settingsLW6_NETWORK_RELIABILITY: Advanced settingsLW6_NODE_DESCRIPTION: Network optionsLW6_NODE_TITLE: Network optionsLW6_OPEN_RELAY: Advanced settingsLW6_PASSWORD: Network optionsLW6_PILOT_LAG: Advanced settingsLW6_PIXELIZE: Map style.xmlLW6_PLAYER1_COLOR: Map teams.xmlLW6_PLAYER1_CONTROL: Players optionsLW6_PLAYER1_NAME: Players optionsLW6_PLAYER1_STATUS: Players optionsLW6_PLAYER2_COLOR: Map teams.xmlLW6_PLAYER2_CONTROL: Players optionsLW6_PLAYER2_NAME: Players optionsLW6_PLAYER2_STATUS: Players optionsLW6_PLAYER3_COLOR: Map teams.xmlLW6_PLAYER3_CONTROL: Players optionsLW6_PLAYER3_NAME: Players optionsLW6_PLAYER3_STATUS: Players optionsLW6_PLAYER4_COLOR: Map teams.xmlLW6_PLAYER4_CONTROL: Players optionsLW6_PLAYER4_NAME: Players optionsLW6_PLAYER4_STATUS: Players optionslw6_print_about: libliquidwar6lw6_print_audit: libliquidwar6lw6_print_bench: libliquidwar6lw6_print_goodbye: libliquidwar6lw6_print_hello: libliquidwar6lw6_print_help: libliquidwar6lw6_print_host: libliquidwar6lw6_print_list: libliquidwar6lw6_print_list_advanced: libliquidwar6lw6_print_list_aliases: libliquidwar6lw6_print_list_doc: libliquidwar6lw6_print_list_funcs: libliquidwar6lw6_print_list_graphics: libliquidwar6lw6_print_list_hooks: libliquidwar6lw6_print_list_input: libliquidwar6lw6_print_list_map: libliquidwar6lw6_print_list_map_hints: libliquidwar6lw6_print_list_map_rules: libliquidwar6lw6_print_list_map_style: libliquidwar6lw6_print_list_map_teams: libliquidwar6lw6_print_list_network: libliquidwar6lw6_print_list_path: libliquidwar6lw6_print_list_players: libliquidwar6lw6_print_list_quick: libliquidwar6lw6_print_list_show: libliquidwar6lw6_print_list_sound: libliquidwar6lw6_print_list_team_colors: libliquidwar6lw6_print_list_weapons: libliquidwar6lw6_print_long_copyright: libliquidwar6lw6_print_modules: libliquidwar6lw6_print_pedigree: libliquidwar6lw6_print_short_copyright: libliquidwar6lw6_print_version: libliquidwar6lw6_process_non_run_options: libliquidwar6LW6_PUBLIC_URL: Network optionslw6_quit_global: libliquidwar6lw6_register_funcs: libliquidwar6lw6_register_smobs: libliquidwar6lw6_release: libliquidwar6LW6_REPEAT_DELAY: Input optionsLW6_REPEAT_INTERVAL: Input optionsLW6_RESAMPLE: Map hints.xmlLW6_RESET_CONFIG_ON_UPGRADE: Advanced settingslw6_resize_callback: libliquidwar6LW6_RESPAWN_DELAY: Map rules.xmlLW6_RESPAWN_POSITION_MODE: Map rules.xmlLW6_RESPAWN_TEAM: Map rules.xmlLW6_ROUND_DELTA: Map rules.xmlLW6_ROUNDS_PER_SEC: Map rules.xmllw6_scm_to_bot: libliquidwar6lw6_scm_to_db: libliquidwar6lw6_scm_to_dsp: libliquidwar6lw6_scm_to_game_state: libliquidwar6lw6_scm_to_game_struct: libliquidwar6lw6_scm_to_loader: libliquidwar6lw6_scm_to_look: libliquidwar6lw6_scm_to_map: libliquidwar6lw6_scm_to_menu: libliquidwar6lw6_scm_to_node: libliquidwar6lw6_scm_to_pilot: libliquidwar6lw6_scm_to_snd: libliquidwar6LW6_SIDE_ATTACK_FACTOR: Map rules.xmlLW6_SIDE_DEFENSE_FACTOR: Map rules.xmlLW6_SINGLE_ARMY_SIZE: Map rules.xmlLW6_SKIP_NETWORK: Network optionsLW6_SND_BACKEND: Sound optionsLW6_SPEED: Map hints.xmlLW6_SPREAD_MODE: Map rules.xmlLW6_SPREAD_THREAD: Map rules.xmlLW6_SPREADS_PER_ROUND: Map rules.xmlLW6_SRV_BACKENDS: Network optionsLW6_START_BLUE_X: Map rules.xmlLW6_START_BLUE_Y: Map rules.xmlLW6_START_CYAN_X: Map rules.xmlLW6_START_CYAN_Y: Map rules.xmlLW6_START_GREEN_X: Map rules.xmlLW6_START_GREEN_Y: Map rules.xmlLW6_START_LIGHTBLUE_X: Map rules.xmlLW6_START_LIGHTBLUE_Y: Map rules.xmlLW6_START_MAGENTA_X: Map rules.xmlLW6_START_MAGENTA_Y: Map rules.xmlLW6_START_ORANGE_X: Map rules.xmlLW6_START_ORANGE_Y: Map rules.xmlLW6_START_PINK_X: Map rules.xmlLW6_START_PINK_Y: Map rules.xmlLW6_START_POSITION_MODE: Map rules.xmlLW6_START_PURPLE_X: Map rules.xmlLW6_START_PURPLE_Y: Map rules.xmlLW6_START_RED_X: Map rules.xmlLW6_START_RED_Y: Map rules.xmlLW6_START_YELLOW_X: Map rules.xmlLW6_START_YELLOW_Y: Map rules.xmlLW6_SYSTEM_COLOR_AUTO: Map hints.xmlLW6_SYSTEM_COLOR_BG: Map style.xmlLW6_SYSTEM_COLOR_FG: Map style.xmlLW6_TARGET_FPS: Advanced settingsLW6_TEAM_COLOR_BLUE: Map style.xmlLW6_TEAM_COLOR_CYAN: Map style.xmlLW6_TEAM_COLOR_DEAD: Map style.xmlLW6_TEAM_COLOR_GREEN: Map style.xmlLW6_TEAM_COLOR_LIGHTBLUE: Map style.xmlLW6_TEAM_COLOR_MAGENTA: Map style.xmlLW6_TEAM_COLOR_ORANGE: Map style.xmlLW6_TEAM_COLOR_PINK: Map style.xmlLW6_TEAM_COLOR_PURPLE: Map style.xmlLW6_TEAM_COLOR_RED: Map style.xmlLW6_TEAM_COLOR_YELLOW: Map style.xmlLW6_TEAM_PROFILE_BLUE_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_BLUE_FAST: Map rules.xmlLW6_TEAM_PROFILE_BLUE_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_BLUE_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_BLUE_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_BLUE_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_BLUE_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_CYAN_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_CYAN_FAST: Map rules.xmlLW6_TEAM_PROFILE_CYAN_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_CYAN_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_CYAN_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_CYAN_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_CYAN_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_GREEN_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_GREEN_FAST: Map rules.xmlLW6_TEAM_PROFILE_GREEN_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_GREEN_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_GREEN_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_GREEN_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_GREEN_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_FAST: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_LIGHTBLUE_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_FAST: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_MAGENTA_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_FAST: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_ORANGE_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_PINK_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_PINK_FAST: Map rules.xmlLW6_TEAM_PROFILE_PINK_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_PINK_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_PINK_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_PINK_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_PINK_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_FAST: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_PURPLE_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_RED_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_RED_FAST: Map rules.xmlLW6_TEAM_PROFILE_RED_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_RED_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_RED_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_RED_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_RED_WEAPON_MODE: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_AGGRESSIVE: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_FAST: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_MOBILE: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_VULNERABLE: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_WEAPON_ALTERNATE_ID: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_WEAPON_ID: Map rules.xmlLW6_TEAM_PROFILE_YELLOW_WEAPON_MODE: Map rules.xmllw6_test: libliquidwar6LW6_TOTAL_ARMIES_SIZE: Map rules.xmlLW6_TOTAL_TIME: Map rules.xmlLW6_TRAP_ERRORS: Advanced settingsLW6_TROJAN: Advanced settingsLW6_UPSIZE_USING_BENCH_VALUE: Map hints.xmlLW6_UPSIZE_USING_FIGHTER_SCALE: Map hints.xmlLW6_USE_CURSOR_TEXTURE: Map parametersLW6_USE_DOUBLE_CLICK: Input optionsLW6_USE_ESC_BUTTON: Input optionsLW6_USE_HINTS_XML: Map parametersLW6_USE_MUSIC_FILE: Map parametersLW6_USE_RULES_XML: Map parametersLW6_USE_STYLE_XML: Map parametersLW6_USE_TEAM_PROFILES: Map rules.xmlLW6_USE_TEAMS_XML: Map parametersLW6_USE_TEXTURE: Map parametersLW6_USER_DIR: Path optionsLW6_VERTICAL_MOVE: Map rules.xmlLW6_VIEW_COLOR_AUTO: Map hints.xmlLW6_VIEW_COLOR_CURSOR_BG: Map style.xmlLW6_VIEW_COLOR_CURSOR_FG: Map style.xmlLW6_VIEW_COLOR_MAP_BG: Map style.xmlLW6_VIEW_COLOR_MAP_FG: Map style.xmlLW6_VIEW_STYLE: Map style.xmlLW6_WALL_GREASE: Map hints.xmlLW6_WATER_VOLUME: Sound optionsLW6_WAVES: Map style.xmlLW6_WEAPON_CHARGE_DELAY: Map rules.xmlLW6_WEAPON_CHARGE_MAX: Map rules.xmlLW6_WEAPON_DURATION: Map rules.xmlLW6_WEAPON_TUNE_BERZERK_POWER: Map rules.xmlLW6_WEAPON_TUNE_TURBO_POWER: Map rules.xmlLW6_WIDTH: Graphics optionsLW6_WINDOWED_MODE_LIMIT: Graphics optionsLW6_X_POLARITY: Map rules.xmlLW6_X_WRAP: Map style.xmlLW6_Y_POLARITY: Map rules.xmlLW6_Y_WRAP: Map style.xmlLW6_Z_POLARITY: Map rules.xmlLW6_ZOOM: Map style.xmlLW6_ZOOM_MAX: Map style.xmlLW6_ZOOM_MIN: Map style.xmlLW6_ZOOM_STEP: Input optionsLW6_ZOOM_STICK_DELAY: Input optionslw6bot_create_backend: libbotlw6bot_destroy_backend: libbotlw6bot_get_backends: libbotlw6bot_init: libbotlw6bot_next_move: libbotlw6bot_quit: libbotlw6bot_repr: libbotlw6bot_test: libbotlw6cfg_defaults: libcfglw6cfg_format: libcfglw6cfg_format_guess_type: libcfglw6cfg_get_option: libcfglw6cfg_get_option_bool: libcfglw6cfg_get_option_int: libcfglw6cfg_init: libcfglw6cfg_load: libcfglw6cfg_load_exp: libcfglw6cfg_merge_env: libcfglw6cfg_must_be_saved: libcfglw6cfg_option_exists: libcfglw6cfg_parse_command_line: libcfglw6cfg_quit: libcfglw6cfg_read_key_value_xml_file: libcfglw6cfg_read_xml_bool: libcfglw6cfg_read_xml_color: libcfglw6cfg_read_xml_float: libcfglw6cfg_read_xml_int: libcfglw6cfg_read_xml_string: libcfglw6cfg_reset: libcfglw6cfg_save: libcfglw6cfg_save_exp: libcfglw6cfg_set_option: libcfglw6cfg_set_option_bool: libcfglw6cfg_set_option_int: libcfglw6cfg_test: libcfglw6cfg_unified_get_log_file: libcfglw6cfg_unified_get_map_path: libcfglw6cfg_unified_get_music_path: libcfglw6cfg_unified_get_user_dir: libcfglw6cfg_unified_get_value: libcfglw6cfg_write_xml_bool: libcfglw6cfg_write_xml_color: libcfglw6cfg_write_xml_float: libcfglw6cfg_write_xml_guess_type: libcfglw6cfg_write_xml_int: libcfglw6cfg_write_xml_string: libcfglw6cfg_xml_element: libcfglw6cli_close: libclilw6cli_create_backend: libclilw6cli_default_backends: libclilw6cli_destroy_backend: libclilw6cli_get_backends: libclilw6cli_init: libclilw6cli_oob_free: libclilw6cli_oob_new: libclilw6cli_open: libclilw6cli_poll: libclilw6cli_process_oob: libclilw6cli_quit: libclilw6cli_repr: libclilw6cli_send: libclilw6cli_test: libclilw6cns_handler_install: libcnslw6cns_handler_poll: libcnslw6cns_handler_remove: libcnslw6cns_history_add_if_needed: libcnslw6cns_support: libcnslw6cns_test: libcnslw6cnx_connection_free: libcnxlw6cnx_connection_init_foo_bar_key: libcnxlw6cnx_connection_lock_send: libcnxlw6cnx_connection_new: libcnxlw6cnx_connection_reliability_filter: libcnxlw6cnx_connection_should_send_foo: libcnxlw6cnx_connection_unlock_send: libcnxlw6cnx_password_checksum: libcnxlw6cnx_password_verify: libcnxlw6cnx_test: libcnxlw6cnx_ticket_table_ack_recv: libcnxlw6cnx_ticket_table_clear: libcnxlw6cnx_ticket_table_get_recv: libcnxlw6cnx_ticket_table_get_send: libcnxlw6cnx_ticket_table_init: libcnxlw6cnx_ticket_table_set_send: libcnxlw6cnx_ticket_table_was_recv_exchanged: libcnxlw6cnx_ticket_table_zero: libcnxlw6dat_test: libdatlw6dat_warehouse_calc_serial_draft_and_reference: libdatlw6dat_warehouse_free: libdatlw6dat_warehouse_get_atom_str_list_not_sent: libdatlw6dat_warehouse_get_local_id: libdatlw6dat_warehouse_get_local_serial: libdatlw6dat_warehouse_get_msg_list_by_seq: libdatlw6dat_warehouse_get_nb_nodes: libdatlw6dat_warehouse_get_seq_draft: libdatlw6dat_warehouse_get_seq_max: libdatlw6dat_warehouse_get_seq_min: libdatlw6dat_warehouse_get_seq_reference: libdatlw6dat_warehouse_new: libdatlw6dat_warehouse_purge: libdatlw6dat_warehouse_put_atom_str: libdatlw6dat_warehouse_put_local_msg: libdatlw6dsp_create_backend: libdsplw6dsp_destroy_backend: libdsplw6dsp_get_average_fps: libdsplw6dsp_get_fullscreen_modes: libdsplw6dsp_get_instant_fps: libdsplw6dsp_get_last_frame_rendering_time: libdsplw6dsp_get_nb_frames: libdsplw6dsp_get_video_mode: libdsplw6dsp_init: libdsplw6dsp_param_zero: libdsplw6dsp_quit: libdsplw6dsp_repr: libdsplw6dsp_test: libdsplw6dsp_update: libdsplw6dyn_dlclose_backend: libdynlw6dyn_dlopen_backend: libdynlw6dyn_dlopen_backend_so: libdynlw6dyn_dlsym: libdynlw6dyn_list_backends: libdynlw6dyn_path_find_backend: libdynlw6dyn_test: libdynlw6gfx_create_backend: libgfxlw6gfx_destroy_backend: libgfxlw6gfx_display: libgfxlw6gfx_get_backends: libgfxlw6gfx_get_fullscreen_modes: libgfxlw6gfx_get_video_mode: libgfxlw6gfx_init: libgfxlw6gfx_pump_events: libgfxlw6gfx_quit: libgfxlw6gfx_repr: libgfxlw6gfx_set_video_mode: libgfxlw6gfx_test: libgfxlw6glb_base64_decode_bin: libglblw6glb_base64_decode_bin_prefix: libglblw6glb_base64_decode_str: libglblw6glb_base64_decode_str_prefix: libglblw6glb_base64_encode_bin: libglblw6glb_base64_encode_bin_prefix: libglblw6glb_base64_encode_str: libglblw6glb_base64_encode_str_prefix: libglblw6glb_sha1_hmac_32_bin: libglblw6glb_sha1_hmac_32_str: libglblw6glb_sha1_hmac_80_bin: libglblw6glb_sha1_hmac_80_str: libglblw6glb_test: libglblw6gui_button_is_pressed: libguilw6gui_button_pop_double_click: libguilw6gui_button_pop_press: libguilw6gui_button_pop_simple_click: libguilw6gui_button_pop_triple_click: libguilw6gui_button_register_down: libguilw6gui_button_register_up: libguilw6gui_button_sync: libguilw6gui_button_update_repeat: libguilw6gui_coord_calc_xy: libguilw6gui_coords_fix_xy_float: libguilw6gui_input_free: libguilw6gui_input_init: libguilw6gui_input_need_sync: libguilw6gui_input_new: libguilw6gui_input_quit: libguilw6gui_input_register_change: libguilw6gui_input_reset: libguilw6gui_input_sync: libguilw6gui_input_update_repeat: libguilw6gui_joystick_check_index: libguilw6gui_joystick_get_move_pad: libguilw6gui_joystick_sync: libguilw6gui_joystick_update_axis_x: libguilw6gui_joystick_update_axis_y: libguilw6gui_joystick_update_repeat: libguilw6gui_keyboard_check_keysym: libguilw6gui_keyboard_get_move_pad: libguilw6gui_keyboard_is_pressed: libguilw6gui_keyboard_pop_keypress: libguilw6gui_keyboard_register_key_down: libguilw6gui_keyboard_register_key_up: libguilw6gui_keyboard_sync: libguilw6gui_keyboard_update_repeat: libguilw6gui_keypress_free: libguilw6gui_keypress_new: libguilw6gui_keypress_repr: libguilw6gui_menu_append: libguilw6gui_menu_append_for_id_use: libguilw6gui_menu_center: libguilw6gui_menu_close_popup: libguilw6gui_menu_dup: libguilw6gui_menu_enable_esc: libguilw6gui_menu_free: libguilw6gui_menu_get_item: libguilw6gui_menu_has_popup: libguilw6gui_menu_insert: libguilw6gui_menu_insert_for_id_use: libguilw6gui_menu_is_same: libguilw6gui_menu_memory_footprint: libguilw6gui_menu_new: libguilw6gui_menu_remove: libguilw6gui_menu_remove_using_id: libguilw6gui_menu_repr: libguilw6gui_menu_scroll_down: libguilw6gui_menu_scroll_up: libguilw6gui_menu_select: libguilw6gui_menu_select_esc: libguilw6gui_menu_set_breadcrumbs: libguilw6gui_menu_set_help: libguilw6gui_menu_set_popup: libguilw6gui_menu_set_title: libguilw6gui_menu_sync: libguilw6gui_menu_sync_using_id: libguilw6gui_menu_update_display_range: libguilw6gui_menuitem_checksum: libguilw6gui_menuitem_dup: libguilw6gui_menuitem_enable: libguilw6gui_menuitem_free: libguilw6gui_menuitem_is_same: libguilw6gui_menuitem_memory_footprint: libguilw6gui_menuitem_new: libguilw6gui_menuitem_repr: libguilw6gui_menuitem_select: libguilw6gui_menuitem_set_label: libguilw6gui_menuitem_set_tooltip: libguilw6gui_menuitem_set_value: libguilw6gui_menuitem_sync: libguilw6gui_mouse_drag_begin: libguilw6gui_mouse_drag_end: libguilw6gui_mouse_drag_pop: libguilw6gui_mouse_poll_move: libguilw6gui_mouse_register_move: libguilw6gui_mouse_sync: libguilw6gui_mouse_update_repeat: libguilw6gui_point_is_inside_rect: libguilw6gui_quad_is_inside_rect: libguilw6gui_rect_clip: libguilw6gui_rect_init_x1y1x2y2: libguilw6gui_rect_init_xywh: libguilw6gui_segment_is_inside_rect: libguilw6gui_smoother_fix_overflow: libguilw6gui_smoother_get_value: libguilw6gui_smoother_immediate_force: libguilw6gui_smoother_init: libguilw6gui_smoother_set_target: libguilw6gui_test: libguilw6gui_triangle_is_inside_rect: libguilw6gui_video_mode_find_closest: libguilw6gui_video_mode_is_same: libguilw6gui_video_mode_sync_ratio: libguilw6gui_viewport_calc_drag: libguilw6gui_viewport_init: libguilw6gui_viewport_map_to_screen: libguilw6gui_viewport_screen_to_map: libguilw6gui_zone_clip: libguilw6gui_zone_init_x1y1x2y2: libguilw6gui_zone_init_xywh: libguilw6hlp_about: libhlplw6hlp_get_credits: libhlplw6hlp_get_default_value: libhlplw6hlp_get_max_value: libhlplw6hlp_get_min_value: libhlplw6hlp_get_type: libhlplw6hlp_is_documented: libhlplw6hlp_list: libhlplw6hlp_list_advanced: libhlplw6hlp_list_aliases: libhlplw6hlp_list_doc: libhlplw6hlp_list_funcs: libhlplw6hlp_list_graphics: libhlplw6hlp_list_hooks: libhlplw6hlp_list_input: libhlplw6hlp_list_map: libhlplw6hlp_list_map_hints: libhlplw6hlp_list_map_rules: libhlplw6hlp_list_map_style: libhlplw6hlp_list_map_teams: libhlplw6hlp_list_network: libhlplw6hlp_list_path: libhlplw6hlp_list_players: libhlplw6hlp_list_quick: libhlplw6hlp_list_show: libhlplw6hlp_list_sound: libhlplw6hlp_list_team_colors: libhlplw6hlp_list_weapons: libhlplw6hlp_match: libhlplw6hlp_print_about: libhlplw6hlp_print_content: libhlplw6hlp_print_keyword: libhlplw6hlp_reference_init: libhlplw6hlp_reference_quit: libhlplw6hlp_test: libhlplw6img_test: libimglw6ker_capture_str: libkerlw6ker_cursor_reset: libkerlw6ker_game_state_add_cursor: libkerlw6ker_game_state_can_sync: libkerlw6ker_game_state_checksum: libkerlw6ker_game_state_cursor_exists: libkerlw6ker_game_state_did_cursor_win: libkerlw6ker_game_state_do_move: libkerlw6ker_game_state_do_round: libkerlw6ker_game_state_do_spread: libkerlw6ker_game_state_dup: libkerlw6ker_game_state_finish_round: libkerlw6ker_game_state_free: libkerlw6ker_game_state_get_charge_per1000: libkerlw6ker_game_state_get_cursor: libkerlw6ker_game_state_get_cursor_by_index: libkerlw6ker_game_state_get_d: libkerlw6ker_game_state_get_fighter_by_id: libkerlw6ker_game_state_get_fighter_id: libkerlw6ker_game_state_get_fighter_safe: libkerlw6ker_game_state_get_fighter_unsafe: libkerlw6ker_game_state_get_global_history: libkerlw6ker_game_state_get_global_history_max: libkerlw6ker_game_state_get_h: libkerlw6ker_game_state_get_latest_history: libkerlw6ker_game_state_get_latest_history_max: libkerlw6ker_game_state_get_latest_weapon: libkerlw6ker_game_state_get_looser: libkerlw6ker_game_state_get_moves: libkerlw6ker_game_state_get_nb_active_fighters: libkerlw6ker_game_state_get_nb_teams: libkerlw6ker_game_state_get_node_info: libkerlw6ker_game_state_get_rounds: libkerlw6ker_game_state_get_shape: libkerlw6ker_game_state_get_spreads: libkerlw6ker_game_state_get_team_info: libkerlw6ker_game_state_get_time_elapsed: libkerlw6ker_game_state_get_time_left: libkerlw6ker_game_state_get_total_rounds: libkerlw6ker_game_state_get_w: libkerlw6ker_game_state_get_weapon_per1000_left: libkerlw6ker_game_state_get_winner: libkerlw6ker_game_state_get_zone_potential: libkerlw6ker_game_state_is_over: libkerlw6ker_game_state_memory_footprint: libkerlw6ker_game_state_new: libkerlw6ker_game_state_node_exists: libkerlw6ker_game_state_point_to: libkerlw6ker_game_state_register_node: libkerlw6ker_game_state_remove_cursor: libkerlw6ker_game_state_repr: libkerlw6ker_game_state_set_cursor: libkerlw6ker_game_state_sync: libkerlw6ker_game_state_team_exists: libkerlw6ker_game_state_unregister_node: libkerlw6ker_game_struct_checksum: libkerlw6ker_game_struct_dup: libkerlw6ker_game_struct_find_free_slot_near: libkerlw6ker_game_struct_free: libkerlw6ker_game_struct_get_d: libkerlw6ker_game_struct_get_h: libkerlw6ker_game_struct_get_shape: libkerlw6ker_game_struct_get_w: libkerlw6ker_game_struct_get_zone_id: libkerlw6ker_game_struct_get_zone_info: libkerlw6ker_game_struct_get_zones_info: libkerlw6ker_game_struct_is_bg: libkerlw6ker_game_struct_is_fg: libkerlw6ker_game_struct_memory_footprint: libkerlw6ker_game_struct_new: libkerlw6ker_game_struct_point_to: libkerlw6ker_game_struct_repr: libkerlw6ker_move_get_best_next_pos: libkerlw6ker_score_array_update: libkerlw6ker_team_mask_best: libkerlw6ker_team_mask_color2mask: libkerlw6ker_team_mask_get: libkerlw6ker_team_mask_is_concerned: libkerlw6ker_test: libkerlw6ldr_auto_colors: libldrlw6ldr_body_read: libldrlw6ldr_chain_entry: libldrlw6ldr_cursor_texture_read: libldrlw6ldr_dup_entry: libldrlw6ldr_exp_validate: libldrlw6ldr_for_all_entries: libldrlw6ldr_free_entry: libldrlw6ldr_get_entries: libldrlw6ldr_grease_apply: libldrlw6ldr_hints_clear: libldrlw6ldr_hints_defaults: libldrlw6ldr_hints_get: libldrlw6ldr_hints_get_default: libldrlw6ldr_hints_read: libldrlw6ldr_hints_set: libldrlw6ldr_hints_update: libldrlw6ldr_hints_zero: libldrlw6ldr_meta_layer_read: libldrlw6ldr_meta_layer_read_if_exists: libldrlw6ldr_metadata_read: libldrlw6ldr_param_read: libldrlw6ldr_param_update: libldrlw6ldr_print_example_hints_xml: libldrlw6ldr_print_example_rules_xml: libldrlw6ldr_print_example_style_xml: libldrlw6ldr_print_example_teams_xml: libldrlw6ldr_print_examples: libldrlw6ldr_read: libldrlw6ldr_read_relative: libldrlw6ldr_resampler_force: libldrlw6ldr_resampler_init: libldrlw6ldr_resampler_source2target: libldrlw6ldr_resampler_target2source: libldrlw6ldr_rules_read: libldrlw6ldr_rules_update: libldrlw6ldr_style_read: libldrlw6ldr_style_set: libldrlw6ldr_style_update: libldrlw6ldr_teams_read: libldrlw6ldr_teams_update: libldrlw6ldr_test: libldrlw6ldr_texture_read: libldrlw6ldr_use_clear: libldrlw6ldr_use_defaults: libldrlw6ldr_use_set: libldrlw6ldr_use_update: libldrlw6map_body_builtin_custom: libmaplw6map_body_check_and_fix_holes: libmaplw6map_body_clear: libmaplw6map_body_coord_from_texture: libmaplw6map_body_fix_checksum: libmaplw6map_body_get_with_texture_coord: libmaplw6map_builtin_custom: libmaplw6map_builtin_defaults: libmaplw6map_color_invert: libmaplw6map_color_is_same: libmaplw6map_color_set_is_same: libmaplw6map_cursor_texture_builtin: libmaplw6map_cursor_texture_clear: libmaplw6map_cursor_texture_layer_get: libmaplw6map_cursor_texture_layer_set: libmaplw6map_dup: libmaplw6map_exp_get_highest_team_color_allowed: libmaplw6map_exp_get_highest_weapon_allowed: libmaplw6map_exp_get_unlocked_team_color: libmaplw6map_exp_get_unlocked_weapon: libmaplw6map_exp_is_team_color_allowed: libmaplw6map_exp_is_weapon_allowed: libmaplw6map_free: libmaplw6map_from_hexa: libmaplw6map_is_same: libmaplw6map_layer_builtin_custom: libmaplw6map_layer_clear: libmaplw6map_local_info_clear: libmaplw6map_local_info_set_music_dir: libmaplw6map_memory_footprint: libmaplw6map_meta_layer_builtin_custom: libmaplw6map_meta_layer_clear: libmaplw6map_meta_layer_get: libmaplw6map_meta_layer_set: libmaplw6map_metadata_clear: libmaplw6map_metadata_defaults: libmaplw6map_metadata_is_same: libmaplw6map_new: libmaplw6map_param_clear: libmaplw6map_param_copy: libmaplw6map_param_defaults: libmaplw6map_param_get: libmaplw6map_param_is_same: libmaplw6map_param_set: libmaplw6map_repr: libmaplw6map_rules_clear: libmaplw6map_rules_copy: libmaplw6map_rules_defaults: libmaplw6map_rules_get_bool: libmaplw6map_rules_get_default: libmaplw6map_rules_get_int: libmaplw6map_rules_get_max: libmaplw6map_rules_get_min: libmaplw6map_rules_is_same: libmaplw6map_rules_set_bool: libmaplw6map_rules_set_int: libmaplw6map_rules_update_checksum: libmaplw6map_style_clear: libmaplw6map_style_copy: libmaplw6map_style_defaults: libmaplw6map_style_get: libmaplw6map_style_get_default: libmaplw6map_style_is_same: libmaplw6map_style_set: libmaplw6map_style_zero: libmaplw6map_team_color_index_to_key: libmaplw6map_team_color_index_to_label: libmaplw6map_team_color_key_to_index: libmaplw6map_teams_clear: libmaplw6map_teams_copy: libmaplw6map_teams_defaults: libmaplw6map_teams_get: libmaplw6map_teams_get_default: libmaplw6map_teams_is_same: libmaplw6map_teams_set: libmaplw6map_teams_zero: libmaplw6map_test: libmaplw6map_texture_clear: libmaplw6map_texture_coord_from_body: libmaplw6map_texture_from_body: libmaplw6map_texture_get_with_body_coord: libmaplw6map_texture_has_alpha: libmaplw6map_to_hexa: libmaplw6map_weapon_index_to_key: libmaplw6map_weapon_index_to_label: libmaplw6map_weapon_key_to_index: libmaplw6msg_cmd_analyse_bar: libmsglw6msg_cmd_analyse_data: libmsglw6msg_cmd_analyse_foo: libmsglw6msg_cmd_analyse_goodbye: libmsglw6msg_cmd_analyse_hello: libmsglw6msg_cmd_analyse_ticket: libmsglw6msg_cmd_generate_bar: libmsglw6msg_cmd_generate_data: libmsglw6msg_cmd_generate_foo: libmsglw6msg_cmd_generate_goodbye: libmsglw6msg_cmd_generate_hello: libmsglw6msg_cmd_generate_ticket: libmsglw6msg_cmd_guess_from_url: libmsglw6msg_envelope_analyse: libmsglw6msg_envelope_generate: libmsglw6msg_oob_analyse_pong: libmsglw6msg_oob_analyse_request: libmsglw6msg_oob_generate_info: libmsglw6msg_oob_generate_list: libmsglw6msg_oob_generate_pong: libmsglw6msg_oob_generate_request: libmsglw6msg_test: libmsglw6msg_ticket_calc_sig: libmsglw6msg_ticket_check_sig: libmsglw6msg_utils_get_assoc_int_with_default: libmsglw6msg_utils_get_assoc_str_with_default: libmsglw6msg_utils_parse_key_value_to_assoc: libmsglw6msg_utils_parse_key_value_to_ptr: libmsglw6msg_word_first: libmsglw6msg_word_first_base64: libmsglw6msg_word_first_id_16: libmsglw6msg_word_first_id_32: libmsglw6msg_word_first_id_64: libmsglw6msg_word_first_int: libmsglw6msg_word_first_int_ge0: libmsglw6msg_word_first_int_gt0: libmsglw6msg_word_first_x: libmsglw6msg_z_decode: libmsglw6msg_z_encode: libmsglw6net_dns_gethostbyname: libnetlw6net_dns_is_ip: libnetlw6net_dns_lock: libnetlw6net_dns_unlock: libnetlw6net_if_guess_local: libnetlw6net_if_guess_public_url: libnetlw6net_init: libnetlw6net_last_error: libnetlw6net_quit: libnetlw6net_recv_line_tcp: libnetlw6net_recv_line_udp: libnetlw6net_recv_lines_udp: libnetlw6net_send_line_tcp: libnetlw6net_send_line_udp: libnetlw6net_socket_close: libnetlw6net_socket_is_valid: libnetlw6net_socket_set_blocking_mode: libnetlw6net_tcp_accept: libnetlw6net_tcp_connect: libnetlw6net_tcp_is_alive: libnetlw6net_tcp_listen: libnetlw6net_tcp_peek: libnetlw6net_tcp_recv: libnetlw6net_tcp_send: libnetlw6net_test: libnetlw6net_udp_client: libnetlw6net_udp_peek: libnetlw6net_udp_recv: libnetlw6net_udp_send: libnetlw6net_udp_server: libnetlw6nod_dyn_info_free: libnodlw6nod_info_add_discovered_node: libnodlw6nod_info_dup_dyn: libnodlw6nod_info_free: libnodlw6nod_info_idle: libnodlw6nod_info_lock: libnodlw6nod_info_map_verified_nodes: libnodlw6nod_info_new: libnodlw6nod_info_new_discovered_nodes: libnodlw6nod_info_new_verified_nodes: libnodlw6nod_info_pop_discovered_nodes: libnodlw6nod_info_set_verified_nodes: libnodlw6nod_info_unlock: libnodlw6nod_info_update: libnodlw6nod_test: libnodlw6p2p_db_close: libp2plw6p2p_db_default_name: libp2plw6p2p_db_open: libp2plw6p2p_db_repr: libp2plw6p2p_db_reset: libp2plw6p2p_entry_free: libp2plw6p2p_entry_new: libp2plw6p2p_entry_repr: libp2plw6p2p_node_close: libp2plw6p2p_node_free: libp2plw6p2p_node_get_entries: libp2plw6p2p_node_get_id: libp2plw6p2p_node_new: libp2plw6p2p_node_poll: libp2plw6p2p_node_repr: libp2plw6p2p_test: libp2plw6pil_bench: libpillw6pil_coords_fix: libpillw6pil_coords_fix_x10: libpillw6pil_local_cursors_get_cursor: libpillw6pil_local_cursors_get_info: libpillw6pil_local_cursors_get_main_info: libpillw6pil_local_cursors_reset: libpillw6pil_local_cursors_set_main: libpillw6pil_local_cursors_set_mouse_controlled: libpillw6pil_local_cursors_set_xy: libpillw6pil_pilot_calibrate: libpillw6pil_pilot_can_sync: libpillw6pil_pilot_commit: libpillw6pil_pilot_did_cursor_win: libpillw6pil_pilot_dirty_read: libpillw6pil_pilot_free: libpillw6pil_pilot_get_last_commit_seq: libpillw6pil_pilot_get_local_cursors: libpillw6pil_pilot_get_looser: libpillw6pil_pilot_get_max_seq: libpillw6pil_pilot_get_next_seq: libpillw6pil_pilot_get_reference_current_seq: libpillw6pil_pilot_get_reference_target_seq: libpillw6pil_pilot_get_seq_0: libpillw6pil_pilot_get_winner: libpillw6pil_pilot_is_over: libpillw6pil_pilot_local_command: libpillw6pil_pilot_make_backup: libpillw6pil_pilot_new: libpillw6pil_pilot_repr: libpillw6pil_pilot_round2seq: libpillw6pil_pilot_send_command: libpillw6pil_pilot_seq2round: libpillw6pil_pilot_slow_down: libpillw6pil_pilot_speed_up: libpillw6pil_pilot_sync_from_backup: libpillw6pil_pilot_sync_from_draft: libpillw6pil_pilot_sync_from_reference: libpillw6pil_seq_random_0: libpillw6pil_test: libpillw6scm_c_define_gsubr: libscmlw6scm_c_primitive_load: libscmlw6scm_test: libscmlw6sim_print: libsimlw6sim_results_update_percents: libsimlw6sim_results_zero: libsimlw6sim_simulate: libsimlw6sim_simulate_basic: libsimlw6sim_simulate_full: libsimlw6sim_test: libsimlw6snd_create_backend: libsndlw6snd_destroy_backend: libsndlw6snd_get_backends: libsndlw6snd_init: libsndlw6snd_is_music_file: libsndlw6snd_play_fx: libsndlw6snd_play_music_file: libsndlw6snd_play_music_random: libsndlw6snd_poll: libsndlw6snd_quit: libsndlw6snd_repr: libsndlw6snd_set_fx_volume: libsndlw6snd_set_music_volume: libsndlw6snd_set_water_volume: libsndlw6snd_stop_music: libsndlw6snd_test: libsndlw6srv_analyse_tcp: libsrvlw6srv_analyse_udp: libsrvlw6srv_close: libsrvlw6srv_create_backend: libsrvlw6srv_default_backends: libsrvlw6srv_destroy_backend: libsrvlw6srv_feed_with_tcp: libsrvlw6srv_feed_with_udp: libsrvlw6srv_get_backends: libsrvlw6srv_init: libsrvlw6srv_oob_free: libsrvlw6srv_oob_new: libsrvlw6srv_open: libsrvlw6srv_poll: libsrvlw6srv_process_oob: libsrvlw6srv_quit: libsrvlw6srv_repr: libsrvlw6srv_send: libsrvlw6srv_start: libsrvlw6srv_stop: libsrvlw6srv_tcp_accepter_free: libsrvlw6srv_tcp_accepter_new: libsrvlw6srv_test: libsrvlw6srv_udp_buffer_free: libsrvlw6srv_udp_buffer_new: libsrvlw6sys_arg_exists: libsyslw6sys_arg_get_value: libsyslw6sys_arg_get_value_with_env: libsyslw6sys_arg_match: libsyslw6sys_arg_test_mode: libsyslw6sys_assoc_dup: libsyslw6sys_assoc_free: libsyslw6sys_assoc_get: libsyslw6sys_assoc_has_key: libsyslw6sys_assoc_keys: libsyslw6sys_assoc_map: libsyslw6sys_assoc_new: libsyslw6sys_assoc_set: libsyslw6sys_assoc_sort_and_map: libsyslw6sys_assoc_unset: libsyslw6sys_atob: libsyslw6sys_atof: libsyslw6sys_atoi: libsyslw6sys_atoll: libsyslw6sys_backtrace: libsyslw6sys_btoa: libsyslw6sys_buf_sprintf: libsyslw6sys_build_get_bin_id: libsyslw6sys_build_get_bugs_url: libsyslw6sys_build_get_cflags: libsyslw6sys_build_get_codename: libsyslw6sys_build_get_configure_args: libsyslw6sys_build_get_copyright: libsyslw6sys_build_get_datadir: libsyslw6sys_build_get_date: libsyslw6sys_build_get_docdir: libsyslw6sys_build_get_enable_allinone: libsyslw6sys_build_get_enable_console: libsyslw6sys_build_get_enable_fullstatic: libsyslw6sys_build_get_enable_gcov: libsyslw6sys_build_get_enable_gprof: libsyslw6sys_build_get_enable_gtk: libsyslw6sys_build_get_enable_instrument: libsyslw6sys_build_get_enable_mod_csound: libsyslw6sys_build_get_enable_mod_gl: libsyslw6sys_build_get_enable_mod_http: libsyslw6sys_build_get_enable_mod_ogg: libsyslw6sys_build_get_enable_openmp: libsyslw6sys_build_get_enable_optimize: libsyslw6sys_build_get_enable_paranoid: libsyslw6sys_build_get_enable_profiler: libsyslw6sys_build_get_enable_valgrind: libsyslw6sys_build_get_endianness: libsyslw6sys_build_get_gcc_version: libsyslw6sys_build_get_home_url: libsyslw6sys_build_get_host_cpu: libsyslw6sys_build_get_host_os: libsyslw6sys_build_get_hostname: libsyslw6sys_build_get_includedir: libsyslw6sys_build_get_ldflags: libsyslw6sys_build_get_libdir: libsyslw6sys_build_get_license: libsyslw6sys_build_get_localedir: libsyslw6sys_build_get_md5sum: libsyslw6sys_build_get_package_name: libsyslw6sys_build_get_package_string: libsyslw6sys_build_get_package_tarname: libsyslw6sys_build_get_pointer_size: libsyslw6sys_build_get_prefix: libsyslw6sys_build_get_stamp: libsyslw6sys_build_get_time: libsyslw6sys_build_get_top_srcdir: libsyslw6sys_build_get_version: libsyslw6sys_build_is_gnu: libsyslw6sys_build_is_gp2x: libsyslw6sys_build_is_mac_os_x: libsyslw6sys_build_is_ms_windows: libsyslw6sys_build_is_unix: libsyslw6sys_build_is_x86: libsyslw6sys_build_log_all: libsyslw6sys_calloc: libsyslw6sys_check_id: libsyslw6sys_check_id_16: libsyslw6sys_check_id_32: libsyslw6sys_check_id_64: libsyslw6sys_check_mutex_count: libsyslw6sys_check_thread_count: libsyslw6sys_check_types_size: libsyslw6sys_checksum: libsyslw6sys_checksum_int32: libsyslw6sys_checksum_int64: libsyslw6sys_checksum_str: libsyslw6sys_checksum_update: libsyslw6sys_checksum_update_int32: libsyslw6sys_checksum_update_int64: libsyslw6sys_checksum_update_str: libsyslw6sys_checksum_update_whd: libsyslw6sys_checksum_update_xyz: libsyslw6sys_checksum_whd: libsyslw6sys_checksum_xyz: libsyslw6sys_clear_file: libsyslw6sys_clear_memory_bazooka: libsyslw6sys_color_8_solid: libsyslw6sys_color_8_to_a: libsyslw6sys_color_8_to_f: libsyslw6sys_color_8_to_i: libsyslw6sys_color_a_to_8: libsyslw6sys_color_a_to_f: libsyslw6sys_color_average: libsyslw6sys_color_char2float: libsyslw6sys_color_distance: libsyslw6sys_color_f_solid: libsyslw6sys_color_f_to_8: libsyslw6sys_color_f_to_i: libsyslw6sys_color_float2char: libsyslw6sys_color_hsv_invert: libsyslw6sys_color_hsv_to_rgb: libsyslw6sys_color_i_to_8: libsyslw6sys_color_i_to_f: libsyslw6sys_color_is_same: libsyslw6sys_color_ponderate: libsyslw6sys_color_rgb_to_hsv: libsyslw6sys_create_dir: libsyslw6sys_create_dir_silent: libsyslw6sys_daemon_pid_file: libsyslw6sys_daemon_start: libsyslw6sys_daemon_stop: libsyslw6sys_date_clf: libsyslw6sys_date_rfc1123: libsyslw6sys_debug_get: libsyslw6sys_debug_set: libsyslw6sys_default_memory_bazooka: libsyslw6sys_delay: libsyslw6sys_dir_exists: libsyslw6sys_dir_list: libsyslw6sys_dump: libsyslw6sys_dump_clear: libsyslw6sys_env_concat: libsyslw6sys_env_exists_prefixed: libsyslw6sys_env_separator_char: libsyslw6sys_env_separator_str: libsyslw6sys_env_split: libsyslw6sys_eol: libsyslw6sys_escape_html_attribute: libsyslw6sys_escape_http_uri: libsyslw6sys_escape_sql_value: libsyslw6sys_exec_again: libsyslw6sys_exec_find_myself: libsyslw6sys_exec_restart: libsyslw6sys_false: libsyslw6sys_file_exists: libsyslw6sys_find_in_dir_and_path: libsyslw6sys_free: libsyslw6sys_free_callback: libsyslw6sys_ftoa: libsyslw6sys_generate_id_16: libsyslw6sys_generate_id_32: libsyslw6sys_generate_id_64: libsyslw6sys_get_config_file: libsyslw6sys_get_cwd: libsyslw6sys_get_cycle: libsyslw6sys_get_data_dir: libsyslw6sys_get_default_config_file: libsyslw6sys_get_default_data_dir: libsyslw6sys_get_default_log_file: libsyslw6sys_get_default_map_dir: libsyslw6sys_get_default_map_path: libsyslw6sys_get_default_mod_dir: libsyslw6sys_get_default_music_dir: libsyslw6sys_get_default_music_path: libsyslw6sys_get_default_prefix: libsyslw6sys_get_default_script_file: libsyslw6sys_get_default_user_dir: libsyslw6sys_get_home: libsyslw6sys_get_hostname: libsyslw6sys_get_log_file: libsyslw6sys_get_map_dir: libsyslw6sys_get_map_path: libsyslw6sys_get_memory_bazooka_free_count: libsyslw6sys_get_memory_bazooka_free_megabytes: libsyslw6sys_get_memory_bazooka_malloc_count: libsyslw6sys_get_memory_bazooka_malloc_current_bytes: libsyslw6sys_get_memory_bazooka_malloc_current_count: libsyslw6sys_get_memory_bazooka_malloc_max_bytes: libsyslw6sys_get_memory_bazooka_malloc_max_count: libsyslw6sys_get_memory_bazooka_malloc_megabytes: libsyslw6sys_get_memory_bazooka_size: libsyslw6sys_get_mod_dir: libsyslw6sys_get_music_dir: libsyslw6sys_get_music_path: libsyslw6sys_get_mutex_lock_count: libsyslw6sys_get_mutex_unlock_count: libsyslw6sys_get_prefix: libsyslw6sys_get_run_dir: libsyslw6sys_get_script_file: libsyslw6sys_get_thread_create_count: libsyslw6sys_get_thread_join_count: libsyslw6sys_get_timestamp: libsyslw6sys_get_uptime: libsyslw6sys_get_user_dir: libsyslw6sys_get_username: libsyslw6sys_getenv: libsyslw6sys_getenv_prefixed: libsyslw6sys_hash_dup: libsyslw6sys_hash_free: libsyslw6sys_hash_get: libsyslw6sys_hash_has_key: libsyslw6sys_hash_keys: libsyslw6sys_hash_map: libsyslw6sys_hash_new: libsyslw6sys_hash_set: libsyslw6sys_hash_sort_and_map: libsyslw6sys_hash_unset: libsyslw6sys_hexa_buf_to_str: libsyslw6sys_hexa_ptr_to_str: libsyslw6sys_hexa_serializer_as_string: libsyslw6sys_hexa_serializer_eof: libsyslw6sys_hexa_serializer_free: libsyslw6sys_hexa_serializer_new: libsyslw6sys_hexa_serializer_pop_color: libsyslw6sys_hexa_serializer_pop_float: libsyslw6sys_hexa_serializer_pop_int16: libsyslw6sys_hexa_serializer_pop_int32: libsyslw6sys_hexa_serializer_pop_int64: libsyslw6sys_hexa_serializer_pop_int8: libsyslw6sys_hexa_serializer_pop_str: libsyslw6sys_hexa_serializer_pop_whd: libsyslw6sys_hexa_serializer_pop_xyz: libsyslw6sys_hexa_serializer_push_color: libsyslw6sys_hexa_serializer_push_float: libsyslw6sys_hexa_serializer_push_int16: libsyslw6sys_hexa_serializer_push_int32: libsyslw6sys_hexa_serializer_push_int64: libsyslw6sys_hexa_serializer_push_int8: libsyslw6sys_hexa_serializer_push_str: libsyslw6sys_hexa_serializer_push_whd: libsyslw6sys_hexa_serializer_push_xyz: libsyslw6sys_hexa_serializer_rewind: libsyslw6sys_hexa_str_to_buf: libsyslw6sys_hexa_str_to_ptr: libsyslw6sys_history_free: libsyslw6sys_history_get: libsyslw6sys_history_init: libsyslw6sys_history_register: libsyslw6sys_id_atol: libsyslw6sys_id_ltoa: libsyslw6sys_idle: libsyslw6sys_is_big_endian: libsyslw6sys_is_executed_again: libsyslw6sys_is_little_endian: libsyslw6sys_is_memory_bazooka_trustable: libsyslw6sys_itoa: libsyslw6sys_keyword_as_arg: libsyslw6sys_keyword_as_env: libsyslw6sys_keyword_as_key: libsyslw6sys_keyword_as_xml: libsyslw6sys_list_dup: libsyslw6sys_list_filter: libsyslw6sys_list_free: libsyslw6sys_list_is_empty: libsyslw6sys_list_length: libsyslw6sys_list_map: libsyslw6sys_list_new: libsyslw6sys_list_next: libsyslw6sys_list_pop_back: libsyslw6sys_list_pop_front: libsyslw6sys_list_push_back: libsyslw6sys_list_push_front: libsyslw6sys_lltoa: libsyslw6sys_locale_to_utf8: libsyslw6sys_log: libsyslw6sys_log_clear: libsyslw6sys_log_critical: libsyslw6sys_log_get_level: libsyslw6sys_log_set_file: libsyslw6sys_log_set_level: libsyslw6sys_malloc: libsyslw6sys_math_angle_360: libsyslw6sys_math_blink: libsyslw6sys_math_heartbeat: libsyslw6sys_math_poly_wy1y2s1: libsyslw6sys_megabytes_available: libsyslw6sys_memory_bazooka_report: libsyslw6sys_mutex_create: libsyslw6sys_mutex_destroy: libsyslw6sys_mutex_lock: libsyslw6sys_mutex_trylock: libsyslw6sys_mutex_unlock: libsyslw6sys_new_sprintf: libsyslw6sys_openmp_get_num_procs: libsyslw6sys_options_log: libsyslw6sys_options_log_defaults: libsyslw6sys_path_add_slash: libsyslw6sys_path_concat: libsyslw6sys_path_file_only: libsyslw6sys_path_is_cwd: libsyslw6sys_path_is_relative: libsyslw6sys_path_list: libsyslw6sys_path_parent: libsyslw6sys_path_split: libsyslw6sys_path_strip_slash: libsyslw6sys_path_unparent: libsyslw6sys_path_unparent_no_malloc: libsyslw6sys_print_xml_footer: libsyslw6sys_print_xml_header: libsyslw6sys_profiler_check: libsyslw6sys_progress_begin: libsyslw6sys_progress_default: libsyslw6sys_progress_end: libsyslw6sys_progress_half: libsyslw6sys_progress_split: libsyslw6sys_progress_split3: libsyslw6sys_progress_split4: libsyslw6sys_progress_split5: libsyslw6sys_progress_split_here: libsyslw6sys_progress_update: libsyslw6sys_random: libsyslw6sys_random_float: libsyslw6sys_read_file_content: libsyslw6sys_read_file_content_bin: libsyslw6sys_readable_uptime: libsyslw6sys_realloc: libsyslw6sys_sdl_register: libsyslw6sys_sdl_unregister: libsyslw6sys_serialize_int16: libsyslw6sys_serialize_int32: libsyslw6sys_serialize_int64: libsyslw6sys_set_memory_bazooka_eraser: libsyslw6sys_set_memory_bazooka_size: libsyslw6sys_setenv: libsyslw6sys_setenv_prefixed: libsyslw6sys_shape_check_min_max_whd: libsyslw6sys_shape_check_pos: libsyslw6sys_shape_is_same: libsyslw6sys_shape_is_same_xy: libsyslw6sys_signal_custom: libsyslw6sys_signal_default: libsyslw6sys_signal_fpe_handler: libsyslw6sys_signal_hup_handler: libsyslw6sys_signal_int_handler: libsyslw6sys_signal_poll_quit: libsyslw6sys_signal_segv_handler: libsyslw6sys_signal_send_quit: libsyslw6sys_signal_term_handler: libsyslw6sys_skip_blanks: libsyslw6sys_sleep: libsyslw6sys_snooze: libsyslw6sys_sort: libsyslw6sys_sort_float_callback: libsyslw6sys_sort_float_desc_callback: libsyslw6sys_sort_int_callback: libsyslw6sys_sort_int_desc_callback: libsyslw6sys_sort_str_callback: libsyslw6sys_sort_str_desc_callback: libsyslw6sys_spinlock_create: libsyslw6sys_spinlock_destroy: libsyslw6sys_spinlock_lock: libsyslw6sys_spinlock_trylock: libsyslw6sys_spinlock_unlock: libsyslw6sys_str_cleanup: libsyslw6sys_str_cleanup_ascii7: libsyslw6sys_str_concat: libsyslw6sys_str_copy: libsyslw6sys_str_empty_if_null: libsyslw6sys_str_is_bin: libsyslw6sys_str_is_blank: libsyslw6sys_str_is_null_or_empty: libsyslw6sys_str_is_same: libsyslw6sys_str_is_same_no_case: libsyslw6sys_str_join: libsyslw6sys_str_random: libsyslw6sys_str_random_words: libsyslw6sys_str_reformat: libsyslw6sys_str_reformat_this: libsyslw6sys_str_split: libsyslw6sys_str_split_config_item: libsyslw6sys_str_split_no_0: libsyslw6sys_str_starts_with: libsyslw6sys_str_starts_with_no_case: libsyslw6sys_str_tolower: libsyslw6sys_str_toupper: libsyslw6sys_str_truncate: libsyslw6sys_stream_file_to_str: libsyslw6sys_stream_str_to_file: libsyslw6sys_test: libsyslw6sys_test_exec: libsyslw6sys_thread_create: libsyslw6sys_thread_get_data: libsyslw6sys_thread_get_id: libsyslw6sys_thread_is_callback_done: libsyslw6sys_thread_join: libsyslw6sys_time_init: libsyslw6sys_timer_update: libsyslw6sys_true: libsyslw6sys_unserialize_int16: libsyslw6sys_unserialize_int32: libsyslw6sys_unserialize_int64: libsyslw6sys_url_canonize: libsyslw6sys_url_free: libsyslw6sys_url_http_from_ip_port: libsyslw6sys_url_is_canonized: libsyslw6sys_url_parse: libsyslw6sys_vthread_create: libsyslw6sys_vthread_is_running: libsyslw6sys_vthread_join: libsyslw6sys_vthread_run: libsyslw6sys_write_file_content: libsyslw6tsk_loader_free: libtsklw6tsk_loader_get_stage: libtsklw6tsk_loader_new: libtsklw6tsk_loader_pop: libtsklw6tsk_loader_push: libtsklw6tsk_loader_repr: libtsklw6tsk_test: libtsklw6vox_renderer_free: libvoxlw6vox_renderer_new: libvoxlw6vox_test: libvoxmagic-number: Advanced settingsmap-path: Path optionsmax-cursor-pot: Map rules.xmlmax-cursor-pot-offset: Map rules.xmlmax-cursor-speed: Input optionsmax-local-bench-value: Advanced settingsmax-map-height: Map hints.xmlmax-map-surface: Map hints.xmlmax-map-width: Map hints.xmlmax-nb-cursors: Map rules.xmlmax-nb-nodes: Map rules.xmlmax-nb-teams: Map rules.xmlmax-network-bench-value: Advanced settingsmax-round-delta: Map rules.xmlmax-zone-size: Map rules.xmlmedicine-power: Map rules.xmlmemory-bazooka-eraser: Advanced settingsmemory-bazooka-size: Advanced settingsmenu-color-auto: Map hints.xmlmenu-color-default-bg: Map style.xmlmenu-color-default-fg: Map style.xmlmenu-color-disabled-bg: Map style.xmlmenu-color-disabled-fg: Map style.xmlmenu-color-selected-bg: Map style.xmlmenu-color-selected-fg: Map style.xmlmenu-style: Map style.xmlmin-map-height: Map hints.xmlmin-map-surface: Map hints.xmlmin-map-width: Map hints.xmlmod_brute_create_backend: mod-brutemod_brute_get_pedigree: mod-brutemod_brute_is_GPL_compatible: mod-brutemod_follow_create_backend: mod-followmod_follow_get_pedigree: mod-followmod_follow_is_GPL_compatible: mod-followmod_http_create_backend: mod-httpmod_http_get_pedigree: mod-httpmod_http_is_GPL_compatible: mod-httpmod_idiot_create_backend: mod-idiotmod_idiot_get_pedigree: mod-idiotmod_idiot_is_GPL_compatible: mod-idiotmod_random_create_backend: mod-randommod_random_get_pedigree: mod-randommod_random_is_GPL_compatible: mod-randommod_tcp_create_backend: mod-tcpmod_tcp_get_pedigree: mod-tcpmod_tcp_is_GPL_compatible: mod-tcpmod_udp_create_backend: mod-udpmod_udp_get_pedigree: mod-udpmod_udp_is_GPL_compatible: mod-udpmouse-sensitivity: Input optionsmoves-per-round: Map rules.xmlmusic-dir: Path optionsmusic-exclude: Map style.xmlmusic-file: Map style.xmlmusic-filter: Map style.xmlmusic-path: Path optionsmusic-volume: Sound optionsnb-attack-tries: Map rules.xmlnb-bots: Map teams.xmlnb-defense-tries: Map rules.xmlnb-move-tries: Map rules.xmlnet-log: Advanced settingsnetwork-reliability: Advanced settingsnode-description: Network optionsnode-title: Network optionsopen-relay: Advanced settingspassword: Network optionspilot-lag: Advanced settingspixelize: Map style.xmlplayer1-color: Map teams.xmlplayer1-control: Players optionsplayer1-name: Players optionsplayer1-status: Players optionsplayer2-color: Map teams.xmlplayer2-control: Players optionsplayer2-name: Players optionsplayer2-status: Players optionsplayer3-color: Map teams.xmlplayer3-control: Players optionsplayer3-name: Players optionsplayer3-status: Players optionsplayer4-color: Map teams.xmlplayer4-control: Players optionsplayer4-name: Players optionsplayer4-status: Players optionspublic-url: Network optionsrepeat-delay: Input optionsrepeat-interval: Input optionsresample: Map hints.xmlreset-config-on-upgrade: Advanced settingsrespawn-delay: Map rules.xmlrespawn-position-mode: Map rules.xmlrespawn-team: Map rules.xmlround-delta: Map rules.xmlrounds-per-sec: Map rules.xmlside-attack-factor: Map rules.xmlside-defense-factor: Map rules.xmlsingle-army-size: Map rules.xmlskip-network: Network optionssnd-backend: Sound optionsspeed: Map hints.xmlspread-mode: Map rules.xmlspread-thread: Map rules.xmlspreads-per-round: Map rules.xmlsrv-backends: Network optionsstart-blue-x: Map rules.xmlstart-blue-y: Map rules.xmlstart-cyan-x: Map rules.xmlstart-cyan-y: Map rules.xmlstart-green-x: Map rules.xmlstart-green-y: Map rules.xmlstart-lightblue-x: Map rules.xmlstart-lightblue-y: Map rules.xmlstart-magenta-x: Map rules.xmlstart-magenta-y: Map rules.xmlstart-orange-x: Map rules.xmlstart-orange-y: Map rules.xmlstart-pink-x: Map rules.xmlstart-pink-y: Map rules.xmlstart-position-mode: Map rules.xmlstart-purple-x: Map rules.xmlstart-purple-y: Map rules.xmlstart-red-x: Map rules.xmlstart-red-y: Map rules.xmlstart-yellow-x: Map rules.xmlstart-yellow-y: Map rules.xmlsystem-color-auto: Map hints.xmlsystem-color-bg: Map style.xmlsystem-color-fg: Map style.xmltarget-fps: Advanced settingsteam-color-blue: Map style.xmlteam-color-cyan: Map style.xmlteam-color-dead: Map style.xmlteam-color-green: Map style.xmlteam-color-lightblue: Map style.xmlteam-color-magenta: Map style.xmlteam-color-orange: Map style.xmlteam-color-pink: Map style.xmlteam-color-purple: Map style.xmlteam-color-red: Map style.xmlteam-color-yellow: Map style.xmlteam-profile-blue-aggressive: Map rules.xmlteam-profile-blue-fast: Map rules.xmlteam-profile-blue-mobile: Map rules.xmlteam-profile-blue-vulnerable: Map rules.xmlteam-profile-blue-weapon-alternate-id: Map rules.xmlteam-profile-blue-weapon-id: Map rules.xmlteam-profile-blue-weapon-mode: Map rules.xmlteam-profile-cyan-aggressive: Map rules.xmlteam-profile-cyan-fast: Map rules.xmlteam-profile-cyan-mobile: Map rules.xmlteam-profile-cyan-vulnerable: Map rules.xmlteam-profile-cyan-weapon-alternate-id: Map rules.xmlteam-profile-cyan-weapon-id: Map rules.xmlteam-profile-cyan-weapon-mode: Map rules.xmlteam-profile-green-aggressive: Map rules.xmlteam-profile-green-fast: Map rules.xmlteam-profile-green-mobile: Map rules.xmlteam-profile-green-vulnerable: Map rules.xmlteam-profile-green-weapon-alternate-id: Map rules.xmlteam-profile-green-weapon-id: Map rules.xmlteam-profile-green-weapon-mode: Map rules.xmlteam-profile-lightblue-aggressive: Map rules.xmlteam-profile-lightblue-fast: Map rules.xmlteam-profile-lightblue-mobile: Map rules.xmlteam-profile-lightblue-vulnerable: Map rules.xmlteam-profile-lightblue-weapon-alternate-id: Map rules.xmlteam-profile-lightblue-weapon-id: Map rules.xmlteam-profile-lightblue-weapon-mode: Map rules.xmlteam-profile-magenta-aggressive: Map rules.xmlteam-profile-magenta-fast: Map rules.xmlteam-profile-magenta-mobile: Map rules.xmlteam-profile-magenta-vulnerable: Map rules.xmlteam-profile-magenta-weapon-alternate-id: Map rules.xmlteam-profile-magenta-weapon-id: Map rules.xmlteam-profile-magenta-weapon-mode: Map rules.xmlteam-profile-orange-aggressive: Map rules.xmlteam-profile-orange-fast: Map rules.xmlteam-profile-orange-mobile: Map rules.xmlteam-profile-orange-vulnerable: Map rules.xmlteam-profile-orange-weapon-alternate-id: Map rules.xmlteam-profile-orange-weapon-id: Map rules.xmlteam-profile-orange-weapon-mode: Map rules.xmlteam-profile-pink-aggressive: Map rules.xmlteam-profile-pink-fast: Map rules.xmlteam-profile-pink-mobile: Map rules.xmlteam-profile-pink-vulnerable: Map rules.xmlteam-profile-pink-weapon-alternate-id: Map rules.xmlteam-profile-pink-weapon-id: Map rules.xmlteam-profile-pink-weapon-mode: Map rules.xmlteam-profile-purple-aggressive: Map rules.xmlteam-profile-purple-fast: Map rules.xmlteam-profile-purple-mobile: Map rules.xmlteam-profile-purple-vulnerable: Map rules.xmlteam-profile-purple-weapon-alternate-id: Map rules.xmlteam-profile-purple-weapon-id: Map rules.xmlteam-profile-purple-weapon-mode: Map rules.xmlteam-profile-red-aggressive: Map rules.xmlteam-profile-red-fast: Map rules.xmlteam-profile-red-mobile: Map rules.xmlteam-profile-red-vulnerable: Map rules.xmlteam-profile-red-weapon-alternate-id: Map rules.xmlteam-profile-red-weapon-id: Map rules.xmlteam-profile-red-weapon-mode: Map rules.xmlteam-profile-yellow-aggressive: Map rules.xmlteam-profile-yellow-fast: Map rules.xmlteam-profile-yellow-mobile: Map rules.xmlteam-profile-yellow-vulnerable: Map rules.xmlteam-profile-yellow-weapon-alternate-id: Map rules.xmlteam-profile-yellow-weapon-id: Map rules.xmlteam-profile-yellow-weapon-mode: Map rules.xmltotal-armies-size: Map rules.xmltotal-time: Map rules.xmltrap-errors: Advanced settingstrojan: Advanced settingsupsize-using-bench-value: Map hints.xmlupsize-using-fighter-scale: Map hints.xmluse-cursor-texture: Map parametersuse-double-click: Input optionsuse-esc-button: Input optionsuse-hints-xml: Map parametersuse-music-file: Map parametersuse-rules-xml: Map parametersuse-style-xml: Map parametersuse-team-profiles: Map rules.xmluse-teams-xml: Map parametersuse-texture: Map parametersuser-dir: Path optionsvertical-move: Map rules.xmlview-color-auto: Map hints.xmlview-color-cursor-bg: Map style.xmlview-color-cursor-fg: Map style.xmlview-color-map-bg: Map style.xmlview-color-map-fg: Map style.xmlview-style: Map style.xmlwall-grease: Map hints.xmlwater-volume: Sound optionswaves: Map style.xmlweapon-charge-delay: Map rules.xmlweapon-charge-max: Map rules.xmlweapon-duration: Map rules.xmlweapon-tune-berzerk-power: Map rules.xmlweapon-tune-turbo-power: Map rules.xmlwidth: Graphics optionswindowed-mode-limit: Graphics optionsx-polarity: Map rules.xmlx-wrap: Map style.xmly-polarity: Map rules.xmly-wrap: Map style.xmlz-polarity: Map rules.xmlzoom: Map style.xmlzoom-max: Map style.xmlzoom-min: Map style.xmlzoom-step: Input optionszoom-stick-delay: Input options