Unvanquished - User contributions [en-gb]

Server/Running

2016-02-15T22:59:56Z

Melanosuchus: /* Cvars */

Servers can be quickly setup over LAN by starting a match in-game, however this is not as powerful or efficient as running a dedicated server separately.

= Starting the Server =
The executable 'daemonded' (daemon dedicated) should be included with your installation. Check your install directories:

{{Game Locations}}

For example:
./daemonded +set fs_libpath /usr/lib/unvanquished +set fs_basepath /var/lib/unvanquished

Quick list of useful options:
* ''+nocurses'' — disabled ncurses console interface, so messages remain on-screen after crashes.
* ''+map mapname'' — without a map the server will kill itself

=Netiquette=
Unvanquished is currently a small community. Please don't aim to create a server in order to only compete for players — division of players will disallow larger matches.

=Specs=
Port 27960 (default quake 3 server port)

= Configuration and Operation =

To discover more commands than are listed here: type a first letter (eg 'g') and press '''Tab''' to list available options starting with that letter. If you are in a terminal: '''Shift+Page Up''' allows you to scroll and the opposite for down.

* [[Server/Map Rotation|Server/Map Rotation]]
* [[Server/Map layouts|Server/Map layouts]] — default building locations

==Server Config File==
{| class="wikitable"
! Platform
! Location
|-
| *nix
| /etc/conf.d/unvanquished.conf /etc/unvanquished/
|-
| Windows
| ???
|-
| Mac
| ???
|-
|}

Ensure your server mode is not set to '2' unless you want your server to be listed for other players.

# Server mode
# 0 - local server
# 1 - LAN server
# 2 - public server

Public servers will want to set sv_hostname to a non-default value

==Commands==
Please add common and useful commands, not every one

{| class="wikitable sortable"
|-
! Command
! Description
|-
| devmap
| Loads a map with sv_cheats enabled. sv_cheats cannot otherwise be changed during play
|-
| listadmins
| List current admins in-game
|-
| listlayouts
| List available layouts (for this map?)
|-
| listplayers
| List current players in-game
|-
| listmaps
| List maps available to the server
|-
|}

==Cvars==
Please add common and useful cvars, not every one

{| class="wikitable"
|-
! Cvar
! Description
|-
| g_dretchPunt
| Allow dretches to be pushes out of the way by bigger aliens?{{Verify}}
|-
| g_friendlyfire
| Allows players to hurt their team
|-
| g_gravity
| Gravity.
|-
| sv_maxclients
| Maximum number of joined players{{Verify}}
|-
| g_maxGameClients
| Maximum number of players in teams (ignoring spectators){{Verify}}
|-
| g_motd
| Message displayed to joining players (Message Of The Day)
|-
| g_needpass
| Whether passwords are enforced on game entry or not
|-
| g_password
| Password to enter game
|-

|}

Server/Map rotation

2016-02-14T18:45:26Z

Melanosuchus:

maprotation.cfg holds a [[Server/Running|server's]] default map rotation.

= Basic Format =

This list will indefinitely loop

maprotation1 {
atcs
tremor
niveus
karith
}

= Advanced Logic =

#label

Labels are used as location markers. They can bee 'seeked' to using a goto statement:

goto #label

For more advanced logic IF statements can be used.
if STATEMENT then ACTION

Where STATEMENT is one of:
* numClients ( > or < or = ) (number)
* lastwin (aliens or humans)
* random

...and ACTION is either a map or label to goto.

Example:

tremor

#mainloop
if numClients > 8 lightning
if numClients < 4 nano
psuedopolis
ankh-morpork

if lastwin humans #mainloop
humanmurder

= Misc Notes =
* If you want to reverse a 'goto', use 'return'
* 'goto' can go to a label in another rotation, and 'resume' will return to the last rotation.

Coding

2015-11-14T11:08:13Z

Melanosuchus:

== Game ==
* [[Getting the source]]
* [[Compiling the source]]
* [[Using Unvanquished from git]]
* [[Development environments]]

== Source code ==

Game:
* [https://github.com/Unvanquished/Unvanquished Game/engine source] ([https://github.com/Unvanquished/Unvanquished/issues bug tracker])

Sub-projects:
* [https://github.com/Unvanquished/Osavul Osavul server browser source] ([https://github.com/Unvanquished/Osavul/issues bug tracker])
* [https://github.com/Unvanquished/unvanquished-master Master server source] ([https://github.com/Unvanquished/unvanquished-master/issues bug tracker])
* [[Tools/Chameleon|Chameleon]] [https://github.com/Unvanquished/Chameleon source]
* [[Tools/Archipelago|Archipelago]] [https://github.com/velociostrich/remapper source] ([https://github.com/velociostrich/remapper/issues bug tracker])

Related/used projects:
* [https://github.com/harmonise/BitRock Installer source] ([https://github.com/harmonise/BitRock/issues bug tracker])

== New Documentation ==
* [[Coding/Cvars|Creating Cvars]]

==Documentation (Possibly outdated)==
* [[Technical Documentation]] has overviews, links and tips for getting started with the source
* [[Engine]]
* [[UI Implementation]]
* [[GSoC idea list]]
* [[List future ideas etherpad]]

==Contributing==

* [[Coding convention]]
* [[Contributing/Code|Contributing code]]

Coding/Cvars

2015-11-14T11:05:49Z

Melanosuchus: Basic information on Cvar classes and some examples

Classes that handle Cvars are defined in {{SourceFile|daemon/src/common/Cvar.h}}.

= Registering Cvars from the sources =
Instantiate an object of the correct class with static storage.

=== Example ===
<pre>
static Cvar::Cvar<std::string> some_cvar(
"cvar_name",
"Cvar description",
Cvar::NONE,
"default value"
);

Log::Debug("The value of the cvar is %s", *some_cvar);
</pre>

= Cvar types =

== Cvar::Cvar ==
Allows to define cvars that can hold simple values, while it is a template it requires a parser and serializer for the type it should contain.

By default, these types are supported out of the box:

* <code>Cvar::Cvar<bool></code>
* <code>Cvar::Cvar<int></code>
* <code>Cvar::Cvar<float></code>
* <code>Cvar::Cvar<std::string></code>

== Cvar::Callback ==
This is a curiously recurring wrapper that allows execution of arbitrary code on cvar changes.

=== Example ===
<pre>
static Cvar::Callback<Cvar::Cvar<std::string>> best(
"best",
"Who is the best?",
Cvar::NONE,
"",
[](const std::string& name){
Log::Notice("%s is the best", name);
}
);
</pre>

== Cvar::Callback ==
This is a curiously recurring wrapper that allows execution of arbitrary code on cvar changes.

=== Example ===
<pre>
static Cvar::Callback<Cvar::Cvar<std::string>> best(
"best",
"Who is the best?",
Cvar::NONE,
"",
[](const std::string& name){
Log::Notice("%s is the best", name);
}
);
</pre>

== Cvar::Modified ==
This is a curiously recurring wrapper that allows querying whether the value has changed.

== Cvar::Range ==
This is a curiously recurring wrapper that limits cvars whose value_type has a meaningful ordering relation
to be within the given range.

=== Example ===
<pre>
static Cvar::Range<Cvar::Cvar<int>> percent(
"percent",
"%",
Cvar::NONE,
100,
0,
100
);
</pre>

== Customizing ==
Creating customized cvar types with special restrictions is pretty straightforward.

=== Example (Combining existing classes) ===
<pre>
static Cvar::Range<Cvar::Callback<Cvar::Cvar<int>>> bottles_of_beer(
"bottles_of_beer",
"Number of bottles of beer on the wall",
Cvar::NONE,
99,
0,
99,
[](int n) {
Log::Notice("%-2d bottles of beer on the wall, %2d bottles of beer.", n, n);
if ( n > 0 )
{
Log::Notice("Take one down, pass it around, %3d bottles of beer on the wall...", n-1);
bottles_of_beer.Set(n-1);
}
}
);
</pre>

=== Example (Custom class) ===
<pre>
class HexCvar : public Cvar::Cvar<std::string>
{
public:
using Cvar::Cvar;

private:
::Cvar::OnValueChangedResult Validate(const value_type& value) override
{
if ( std::all_of( value.begin(), value.end(), Str::cisxdigit ) )
{
return { true, "" };
}
return { false, "Must be hex!" };
}
};

static HexCvar cvar_hex(
"hex",
"Must be hex",
Cvar::NONE,
""
);
</pre>

Colours

2015-10-24T18:04:55Z

Melanosuchus: Update the new color notation

Font colors are used by prefixing text with <code>^<var>char</var></code> as shown in the following table:


{| class="wikitable"
|-
! Value
! Color
! Hex
! Floating-point
|-
| <code>0</code>
| Dark Grey
| <code>#333333</code>
| (<code>0.2</code>, <code>0.2</code>, <code>0.2</code>)
|-
| <code>1</code>
| Red
| <code>#FF0000</code>
| (<code>1</code>, <code>0</code>, <code>0</code>)
|-
| <code>2</code>
| Green
| <code>#00FF00</code>
| (<code>0</code>, <code>1</code>, <code>0</code>)
|-
| <code>3</code>
| Yellow
| <code>#FFFF00</code>
| (<code>1</code>, <code>1</code>, <code>0</code>)
|-
| <code>4</code>
| Blue
| <code>#0000FF</code>
| (<code>0</code>, <code>0</code>, <code>1</code>)
|-
| <code>5</code>
| Cyan
| <code>#00FFFF</code>
| (<code>0</code>, <code>1</code>, <code>1</code>)
|-
| <code>6</code>
| Magenta
| <code>#FF00FF</code>
| (<code>1</code>, <code>0</code>, <code>1</code>)
|-
| <code>7</code> || style="background-color:#888;" | White
| <code>#FFFFFF</code>
| (<code>1</code>, <code>1</code>, <code>1</code>)
|-
| <code>8</code>
| Orange
| <code>#FF7F00</code>
| (<code>1</code>, <code>0.5</code>, <code>0</code>)
|-
| <code>9</code>
| Light Grey
| <code>#7F7F7F</code>
| (<code>0.5</code>, <code>0.5</code>, <code>0.5</code>)
|-
| <code>:</code>
| Lighter Grey
| <code>#BFBFBF</code>
| (<code>0.75</code>, <code>0.75</code>, <code>0.75</code>)
|-
| <code>;</code>
| Lighter Grey<ref><code>^;</code> is reserved for use by the game code. The colour may vary.</ref>
| <code>#BFBFBF</code>
| (<code>0.75</code>, <code>0.75</code>, <code>0.75</code>)
|-
| <code><</code>
| Forest Green
| <code>#007F00</code>
| (<code>0</code>, <code>0.5</code>, <code>0</code>)
|-
| <code>=</code>
| Olive Drab
| <code>#7F7F00</code>
| (<code>0.5</code>, <code>0.5</code>, <code>0</code>)
|-
| <code>></code>
| Navy Blue
| <code>#00007F</code>
| (<code>0</code>, <code>0</code>, <code>0.5</code>)
|-
| <code>?</code>
| Maroon
| <code>#7F0000</code>
| (<code>0.5</code>, <code>0</code>, <code>0</code>)
|-
| <code>@</code>
| Brown
| <code>#7F3F00</code>
| (<code>0.5</code>, <code>0.25</code>, <code>0</code>)
|-
| <code>A</code>
| Light Orange
| <code>#FF9919</code>
| (<code>1</code>, <code>0.6</code>, <code>0.1</code>)
|-
| <code>B</code>
| Teal
| <code>#007F7F</code>
| (<code>0</code>, <code>0.5</code>, <code>0.5</code>)
|-
| <code>C</code>
| Purple
| <code>#7F007F</code>
| (<code>0.5</code>, <code>0</code>, <code>0.5</code>)
|-
| <code>D</code>
| Baby Blue
| <code>#007FFF</code>
| (<code>0</code>, <code>0.5</code>, <code>1</code>)
|-
| <code>E</code>
| Periwinkle
| <code>#7F00FF</code>
| (<code>0.5</code>, <code>0</code>, <code>1</code>)
|-
| <code>F</code>
| Turqouise
| <code>#3399CC</code>
| (<code>0.2</code>, <code>0.6</code>, <code>0.8</code>)
|-
| <code>G</code>
| Pastel Green
| <code>#CCFFCC</code>
| (<code>0.8</code>, <code>1</code>, <code>0.8</code>)
|-
| <code>H</code>
| Dark Green
| <code>#006633</code>
| (<code>0</code>, <code>0.4</code>, <code>0.2</code>)
|-
| <code>I</code>
| Firetruck Red
| <code>#FF0033</code>
| (<code>1</code>, <code>0</code>, <code>0.2</code>)
|-
| <code>J</code>
| Running out of Names Red
| <code>#B21919</code>
| (<code>0.7</code>, <code>0.1</code>, <code>0.1</code>)
|-
| <code>K</code>
| Dark Red
| <code>#993300</code>
| (<code>0.6</code>, <code>0.2</code>, <code>0</code>)
|-
| <code>L</code>
| Dark Orange
| <code>#CC9933</code>
| (<code>0.8</code>, <code>0.6</code>, <code>0.2</code>)
|-
| <code>M</code>
| Beige, Kinda
| <code>#999933</code>
| (<code>0.6</code>, <code>0.6</code>, <code>0.2</code>)
|-
| <code>N</code>
| Peach
| <code>#FFFFBF</code>
| (<code>1</code>, <code>1</code>, <code>0.75</code>)
|-
| <code>O</code>
| Light Yellow
| <code>#FFFF7F</code>
| (<code>1</code>, <code>1</code>, <code>0.5</code>)
|-
| <code>^</code>
| Literal <code>^</code>
|
|
|-
| <code>*</code>
| Reset colour
|
|
|-
| <code>x</code>''rgb''
| 12 bit hexadecimal RGB notation
| <code>#</code>''rrggbb''
| (''r''/15, ''g''/15, ''b''/15)
|-
| <code>#</code>''rrggbb''
| 24 bit hexadecimal RGB notation
| <code>#</code>''rrggbb''
| (''rr''/255, ''gg''/255, ''bb''/255)
|}

Anything else, e.g. <code>^!</code>, results in both characters being displayed with no colour change.

For example, entering <code>^1h^8h^3h^2h^4h^6h</code> would result in hhhhhh being displayed.

{{Note|header=Developer Note|content=Console font colors are controlled by the <code>g_color_table</code> array.}}

<references/>