Unvanquished - User contributions [en-gb]

Making and modding

2024-06-16T14:40:52Z

PhantomFang: /* Categories */

=Overviews=
* [[Technical Documentation]] for the game and engine
* [[Engine]] feature summary
* [[Filesystem]] and packaging details.

=Categories=
Each category contains links to guides and reference material for both beginners and more experienced artists.

* [[Mapping]]
** [[Map Layouts]]
** [[Map bugs]]
** [[UI Design]]
* [[Modeling]]
* [[Texturing]]
* [[Music and sounds]]

See also [[Tools]] and [[Formats]].

See {{Tools|DaemonMediaAuthoringKit}} for a way to build tools required to build the assets and some important editors.

=Tutorials=

* {{Tutorials|Modifying paks}} for how to test changes to an existing game package
* [[Making an awesome mod]] build and use a custom mod
* [[Hosting one's own awesome mod]] configure server to host and distribute previously done mod

=Publishing or Contributing to Unvanquished=

The {{forums}} are the best place to reveal and show-off your work.

* [[Contributing/Media|Media contribution guidelines]]
* [[Filesystem|Packaging]] assets for distribution
* Translating
* [[Licenses/Media|Media licenses]]

Making and modding

2024-06-16T14:39:57Z

PhantomFang: /* Categories */

=Overviews=
* [[Technical Documentation]] for the game and engine
* [[Engine]] feature summary
* [[Filesystem]] and packaging details.

=Categories=
Each category contains links to guides and reference material for both beginners and more experienced artists.

* [[Mapping]]
** [[Map Layouts]]
** [[Maping bugs]]
** [[UI Design]]
* [[Modeling]]
* [[Texturing]]
* [[Music and sounds]]

See also [[Tools]] and [[Formats]].

See {{Tools|DaemonMediaAuthoringKit}} for a way to build tools required to build the assets and some important editors.

=Tutorials=

* {{Tutorials|Modifying paks}} for how to test changes to an existing game package
* [[Making an awesome mod]] build and use a custom mod
* [[Hosting one's own awesome mod]] configure server to host and distribute previously done mod

=Publishing or Contributing to Unvanquished=

The {{forums}} are the best place to reveal and show-off your work.

* [[Contributing/Media|Media contribution guidelines]]
* [[Filesystem|Packaging]] assets for distribution
* Translating
* [[Licenses/Media|Media licenses]]

Map bugs

2024-06-16T14:39:20Z

PhantomFang: Created page with "== Structures bugs == When you make a map, You should know that there is a bug with the structures. If you place them on the floor like this: File:structure-bug-position.p..."

== Structures bugs ==

When you make a map, You should know that there is a bug with the structures. If you place them on the floor like this:

[[File:structure-bug-position.png]]

The structure will not be displayed, and the structure will be unusable:

[[File:no-egg.png]]

'''But the structure will be present on the map!'''

[[File:structure-bug-position-exist.png]]

For the structure to be displayed, it must be placed ''a little above the ground.'' Like this:

[[File:Structure-bug-position-place.png]]

which will be this:

[[File:structure-bug-position-place-result.png]]

And this is for all the structures.

File:Structure-bug-position-exist.png

2024-06-16T14:34:33Z

PhantomFang:

File:Structure-bug-position-place-result.png

2024-06-16T14:31:05Z

PhantomFang:

File:Structure-bug-position-place.png

2024-06-16T14:29:14Z

PhantomFang:

File:No-egg.png

2024-06-16T14:25:20Z

PhantomFang: PhantomFang uploaded a new version of File:No-egg.png

picture for show how to don't put a structure in a map

File:No-egg.png

2024-06-16T14:23:55Z

PhantomFang: picture for show how to don't put a structure in a map

picture for show how to don't put a structure in a map

File:Structure-bug-position.png

2024-06-16T14:13:22Z

PhantomFang: picture for show how to don't put a structure in a map

picture for show how to don't put a structure in a map

Server/Running

2024-06-15T07:28:48Z

PhantomFang: /* Become admin */

[[Category:Server]]
[[Category:Tutorials]]
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.

=Netiquette=

{{Note|content=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.}}

Servers may be needed in some geographical places to reduce ping delay.

=Getting the server=

Our standard [https://unvanquished.net/download/ download] contains the server. The binary is named {{code|daemonded}}.

To install on an headless server, you may prefer to download the [https://unvanquished.net/download/zip universal zip], example with Linux:

wget --content-disposition https://unvanquished.net/download/zip
unzip unvanquished_{{Current|GameVersion}}.zip
cd unvanquished_{{Current|GameVersion}}
unzip linux-amd64.zip

=Starting the Server=

Just running {{code|./daemonded}} with a map may be enough:

<pre>
./daemonded +map plat23
</pre>

You always need to start a map (here, this is done by passing the {{code|+map plat23}} argument).

==Network configuration==

By default the server listening port is {{code|27960}}, it is an {{code|UDP}} port. You may have to open this port in your firewall or redirect it to the machine running the server.

This is the same port as Quake Ⅲ Arena, so other games derivated from the Quake Ⅲ engine may share the same port and while the engine selects the next port available if the default one is already taken, you may want to enforce a port number if you host multiple games or game servers to avoid the port for each server to change according to the server start order.

=Advanced starting=

You may want to customize the way it runs, for example change the listening port (here for both IPv4 and IPv6, {{code|27960}} is the default port):

<pre>
./daemonded -set net_port 27960 -set net_port6 27960 +map plat23
</pre>

Or store the unvanquished server configuration in a specific folder:

<pre>
./daemonded -homepath home/ +map plat23
</pre>

Or tell the game server to also look for {{code|.dpk}} files you're distributing on your web server:

<pre>
./daemonded -pakpath /var/www/pkg +map plat23
</pre>

==Server configuration==

A ready-to use server configuration template can be found on {{SourceFile|dist/configs}} folder of Unvanquished repository.

You just need to copy the {{code|config}} and {{code|game}} folders into your user game directory.

{{Note|content={{User game locations}}}}

You may want to edit the {{code|config/server.cfg}} file to change some things like the server name or things like that.

After that, you can run the server this way:

<pre>
./daemonded +exec server.cfg
</pre>

You can set arbitrary ports and run the configuration this way:

<pre>
./daemonded -set net_port 27960 -set net_port6 27960 +exec server.cfg
</pre>

==Options ordering==

You can combine those options, but every {{code|-option}} starting with a {{code|-}} must precede every {{code|+command}} starting with a {{code|+}}.

==Quick list of useful options==

* {{code|-curses}} — enabled ncurses console interface (default behavior is to disable it so messages remain on-screen after crashes).
* {{code|-set net_port <port-number>}} and {{code|-set net_port <port-number>}} — customize the default port, by default is is {{code|27960}}.
* {{code|-pakpath <directory>}} — load more {{code|.dpk}} files from another directory.
* {{code|+map <map-name>}} — without a map the server will kill itself.

==Directories==

If installing from the universal zip, the default directory where the {{code|.dpk}} are stored is in {{code|pkg/}} relative to the extraction directory.

An optional package directory is called a ''pakpath''. Additional custom paths can be added using the {{code|-pakpath}} option. You can add as many as you want.

The default user directory is called the ''homepath''. It can be customized with the {{code|-homepath}} option.

The executable {{code|daemonded}} (''daemon dedicated'') should be included with your installation.

So, if you need to be explicit on every path, you can do something like that:

<pre>
./daemonded -homepath ${HOME}/.local/share/unvanquished \
-pakpath /var/www/unvanquished/pkg
</pre>

===Standard game locations===

See [[Game locations]] for details.

==Script tutorial==

Here is a tutorial to make a server script : [[Server/Script tutorial]].

=Configuration and Operation=

To discover more commands than are listed here, you can type the {{code|/listCmds}} command, and to discover configuration variables, you can type the {{code|/listCvars}} command.

There is command and cvar completion, you can 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.

You can also search in what is ''already printed'' using grep, for example:

<pre>
/listCmds
/grep map
</pre>

==Server Config File==
Here is the template for the server config: {{SourceFile|dist/configs/config/server.cfg}}.

The <code>config</code> folder is stored in the <code>homepath</code> folder (see above).

For example on Linux it would be: <code>${HOME}/.local/share/unvanquished/config</code>.

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

==Map rotation and map layouts==

* [[Server/Map rotation|Map rotation]] — to customize the map loading order and on which condition a map is loaded or not.
* [[Server/Map layouts|Map layouts]] — default building locations.

==Commands==

{{NoteWiki|content=Please add common and useful commands, not every one.}}

{| class="wikitable sortable"
|-
! Command
! Description
|-
| devmap
| Loads a map with <code>sv_cheats</code> enabled. <code>sv_cheats</code> 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==

{{NoteWiki|content=Please add common and useful commands, 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 players on the server
|-
| g_maxGameClients
| Maximum number of players in teams (ignoring spectators)
|-
| g_motd
| Message displayed to joining players (Message Of The Day)
|-
| g_password
| Password to enter game
|-
|}

=Game administration=

==Become admin==

To make yourself an in-game admin

# Enter the game make sure you've set your in-game name (otherwise set it in the player settings)
# In the console, (<Shift><Escape> or the key below the escape key) use <code>/register</code>, it should say your account is now registered.
# Using <code>/listplayers</code>, find your player number (if you want to use your player number for use <code>/setlevel</code>)
# Finaly, go into an admin console (you may want to launch the game manually) and <code>/setlevel (your number/your nickname) (your level)</code>

It is also possible to modify the file ./game/admin.dat but the server will require a reboot to take the change into account.

Here are the levels:

[level]
level = 5
name = ^1Server Operator
flags = ALLFLAGS -IMMUTABLE -INCOGNITO

[level]
level = 4
name = ^3Senior Admin
flags = listplayers admintest adminhelp time putteam spec999 warn kick mute showbans ban namelog buildlog ADMINCHAT register unregister l0 l1

[level]
level = 3
name = ^2Junior Admin
flags = listplayers admintest adminhelp time putteam spec999 warn kick mute ADMINCHAT buildlog register unregister l0 l1

[level]
level = 2
name = ^6Team Manager
flags = listplayers admintest adminhelp time putteam spec999 register unregister

[level]
level = 1
name = ^5Server Regular
flags = listplayers admintest adminhelp time register unregister

[level]
level = 0
name = ^4Unknown Player
flags = listplayers admintest adminhelp time register

Server/Running

2024-06-15T07:28:15Z

PhantomFang: /* Become admin */

[[Category:Server]]
[[Category:Tutorials]]
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.

=Netiquette=

{{Note|content=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.}}

Servers may be needed in some geographical places to reduce ping delay.

=Getting the server=

Our standard [https://unvanquished.net/download/ download] contains the server. The binary is named {{code|daemonded}}.

To install on an headless server, you may prefer to download the [https://unvanquished.net/download/zip universal zip], example with Linux:

wget --content-disposition https://unvanquished.net/download/zip
unzip unvanquished_{{Current|GameVersion}}.zip
cd unvanquished_{{Current|GameVersion}}
unzip linux-amd64.zip

=Starting the Server=

Just running {{code|./daemonded}} with a map may be enough:

<pre>
./daemonded +map plat23
</pre>

You always need to start a map (here, this is done by passing the {{code|+map plat23}} argument).

==Network configuration==

By default the server listening port is {{code|27960}}, it is an {{code|UDP}} port. You may have to open this port in your firewall or redirect it to the machine running the server.

This is the same port as Quake Ⅲ Arena, so other games derivated from the Quake Ⅲ engine may share the same port and while the engine selects the next port available if the default one is already taken, you may want to enforce a port number if you host multiple games or game servers to avoid the port for each server to change according to the server start order.

=Advanced starting=

You may want to customize the way it runs, for example change the listening port (here for both IPv4 and IPv6, {{code|27960}} is the default port):

<pre>
./daemonded -set net_port 27960 -set net_port6 27960 +map plat23
</pre>

Or store the unvanquished server configuration in a specific folder:

<pre>
./daemonded -homepath home/ +map plat23
</pre>

Or tell the game server to also look for {{code|.dpk}} files you're distributing on your web server:

<pre>
./daemonded -pakpath /var/www/pkg +map plat23
</pre>

==Server configuration==

A ready-to use server configuration template can be found on {{SourceFile|dist/configs}} folder of Unvanquished repository.

You just need to copy the {{code|config}} and {{code|game}} folders into your user game directory.

{{Note|content={{User game locations}}}}

You may want to edit the {{code|config/server.cfg}} file to change some things like the server name or things like that.

After that, you can run the server this way:

<pre>
./daemonded +exec server.cfg
</pre>

You can set arbitrary ports and run the configuration this way:

<pre>
./daemonded -set net_port 27960 -set net_port6 27960 +exec server.cfg
</pre>

==Options ordering==

You can combine those options, but every {{code|-option}} starting with a {{code|-}} must precede every {{code|+command}} starting with a {{code|+}}.

==Quick list of useful options==

* {{code|-curses}} — enabled ncurses console interface (default behavior is to disable it so messages remain on-screen after crashes).
* {{code|-set net_port <port-number>}} and {{code|-set net_port <port-number>}} — customize the default port, by default is is {{code|27960}}.
* {{code|-pakpath <directory>}} — load more {{code|.dpk}} files from another directory.
* {{code|+map <map-name>}} — without a map the server will kill itself.

==Directories==

If installing from the universal zip, the default directory where the {{code|.dpk}} are stored is in {{code|pkg/}} relative to the extraction directory.

An optional package directory is called a ''pakpath''. Additional custom paths can be added using the {{code|-pakpath}} option. You can add as many as you want.

The default user directory is called the ''homepath''. It can be customized with the {{code|-homepath}} option.

The executable {{code|daemonded}} (''daemon dedicated'') should be included with your installation.

So, if you need to be explicit on every path, you can do something like that:

<pre>
./daemonded -homepath ${HOME}/.local/share/unvanquished \
-pakpath /var/www/unvanquished/pkg
</pre>

===Standard game locations===

See [[Game locations]] for details.

==Script tutorial==

Here is a tutorial to make a server script : [[Server/Script tutorial]].

=Configuration and Operation=

To discover more commands than are listed here, you can type the {{code|/listCmds}} command, and to discover configuration variables, you can type the {{code|/listCvars}} command.

There is command and cvar completion, you can 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.

You can also search in what is ''already printed'' using grep, for example:

<pre>
/listCmds
/grep map
</pre>

==Server Config File==
Here is the template for the server config: {{SourceFile|dist/configs/config/server.cfg}}.

The <code>config</code> folder is stored in the <code>homepath</code> folder (see above).

For example on Linux it would be: <code>${HOME}/.local/share/unvanquished/config</code>.

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

==Map rotation and map layouts==

* [[Server/Map rotation|Map rotation]] — to customize the map loading order and on which condition a map is loaded or not.
* [[Server/Map layouts|Map layouts]] — default building locations.

==Commands==

{{NoteWiki|content=Please add common and useful commands, not every one.}}

{| class="wikitable sortable"
|-
! Command
! Description
|-
| devmap
| Loads a map with <code>sv_cheats</code> enabled. <code>sv_cheats</code> 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==

{{NoteWiki|content=Please add common and useful commands, 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 players on the server
|-
| g_maxGameClients
| Maximum number of players in teams (ignoring spectators)
|-
| g_motd
| Message displayed to joining players (Message Of The Day)
|-
| g_password
| Password to enter game
|-
|}

=Game administration=

==Become admin==

To make yourself an in-game admin

# Enter the game make sure you've set your in-game name (otherwise set it in the player settings)
# In the console, (<Shift><Escape> or the key below the escape key) use <code>/register</code>, it should say your account is now registered.
# Using <code>/listplayers</code>, find your player number (if you want to use your player number for use <code>/setlevel</code>
# Finaly, go into an admin console (you may want to launch the game manually) and <code>/setlevel (your number/your nickname) (your level)</code>

It is also possible to modify the file ./game/admin.dat but the server will require a reboot to take the change into account.

Here are the levels:

[level]
level = 5
name = ^1Server Operator
flags = ALLFLAGS -IMMUTABLE -INCOGNITO

[level]
level = 4
name = ^3Senior Admin
flags = listplayers admintest adminhelp time putteam spec999 warn kick mute showbans ban namelog buildlog ADMINCHAT register unregister l0 l1

[level]
level = 3
name = ^2Junior Admin
flags = listplayers admintest adminhelp time putteam spec999 warn kick mute ADMINCHAT buildlog register unregister l0 l1

[level]
level = 2
name = ^6Team Manager
flags = listplayers admintest adminhelp time putteam spec999 register unregister

[level]
level = 1
name = ^5Server Regular
flags = listplayers admintest adminhelp time register unregister

[level]
level = 0
name = ^4Unknown Player
flags = listplayers admintest adminhelp time register