Difference between revisions of "BZFS 2.4 Upgrade"

From BZFlagWiki
Jump to: navigation, search
(Fix the link)
Line 1: Line 1:
 
Stub for BZFS 2.0.x to 2.4 server upgrade path
 
Stub for BZFS 2.0.x to 2.4 server upgrade path
 +
 +
== Overview ==
 +
 +
For version 2.4 there are new requirements for your server to be listed on the
 +
BZFlag hosted server list.
 +
 +
This page documents user visible changes to the BZFlag server for the 2.4 release of [[BZFlag]].
 +
 +
== Getting your server listed on the server list ==
 +
 +
=== Generating and managing server keys ===
 +
You need to generate a public server key for your BZFlag server which matches your
 +
server host.  If you have multiple server hosts you need a separate key per host.
 +
You can generate and manage your server keys at http://my.bzflag.org/listkeys/
 +
 +
=== Starting your BZFlag server using your server key ===
 +
After generating a server key you need to provide the key to your bzfs server so it can
 +
authenticate with the list server.  Only servers with valid public keys will be shown
 +
on the BZFlag list server.
 +
 +
Keys are shown at http://my.bzflag.org/listkeys like this:
 +
 +
{|
 +
|+ KEYS listed from http://my.bzflag.org/listkeys
 +
|-
 +
!Host
 +
!Key
 +
!
 +
|-
 +
| my.bzflag.server.host
 +
| 1234567890123456789
 +
| [Delete]
 +
|-
 +
|}
 +
 +
You need to provide the key value to the bzfs server option '''''-publickey''''' like this
 +
 +
$ bzfs -public "Map name goes here" -publickey 1234567890123456789
 +
 +
The '''''-publicaddr''''' and '''''-p''''' parameters have not changed from 2.0.x and are used to
 +
provide the hosting server address and port respectively.
 +
 +
 +
== Upgrading third party plugins ==
 +
 +
The API for plugins has changed in the 2.4 release.  See
 +
[[BZFS_API_2.4_Upgrade]] for details on upgrading your server plugins.
 +
 +
== BZFlag server commandline option changes ==
 +
 +
{|
 +
! bzfs Commandline Switch
 +
! Notes                   
 +
|-
 +
| -offa
 +
| New, teamless free-for-all game mode                 
 +
|-
 +
| -passdb
 +
| Removed                                             
 +
|-
 +
| -requireudp
 +
| Removed                                             
 +
|-
 +
| -time                 
 +
| Modified, Specify end time in seconds or ending time (hh:mm:ss)
 +
|-
 +
| -utc                   
 +
| New, Make server time stamps in UTC instead of local time
 +
|-
 +
| -publickey <key>       
 +
| New, Required for including your server on the server list
 +
|}
  
 
== TODO ==
 
== TODO ==
  
* document -publickey and how to generate them
 
* document changes in command line options
 
* reference plugin upgrade for 2.0.x to 2.4 [[BZFS_API_2.4_Upgrade]]
 
* put document on the wiki
 
 
* document r21903
 
* document r21903
 
** should not change for well defined groups
 
** should not change for well defined groups
 
** may change behaviour if the group definitions were wrong
 
** may change behaviour if the group definitions were wrong

Revision as of 00:17, 15 June 2011

Stub for BZFS 2.0.x to 2.4 server upgrade path

Overview

For version 2.4 there are new requirements for your server to be listed on the BZFlag hosted server list.

This page documents user visible changes to the BZFlag server for the 2.4 release of BZFlag.

Getting your server listed on the server list

Generating and managing server keys

You need to generate a public server key for your BZFlag server which matches your server host. If you have multiple server hosts you need a separate key per host. You can generate and manage your server keys at http://my.bzflag.org/listkeys/

Starting your BZFlag server using your server key

After generating a server key you need to provide the key to your bzfs server so it can authenticate with the list server. Only servers with valid public keys will be shown on the BZFlag list server.

Keys are shown at http://my.bzflag.org/listkeys like this:

KEYS listed from http://my.bzflag.org/listkeys
Host Key
my.bzflag.server.host 1234567890123456789 [Delete]

You need to provide the key value to the bzfs server option -publickey like this

$ bzfs -public "Map name goes here" -publickey 1234567890123456789 

The -publicaddr and -p parameters have not changed from 2.0.x and are used to provide the hosting server address and port respectively.


Upgrading third party plugins

The API for plugins has changed in the 2.4 release. See BZFS_API_2.4_Upgrade for details on upgrading your server plugins.

BZFlag server commandline option changes

bzfs Commandline Switch Notes
-offa New, teamless free-for-all game mode
-passdb Removed
-requireudp Removed
-time Modified, Specify end time in seconds or ending time (hh:mm:ss)
-utc New, Make server time stamps in UTC instead of local time
-publickey <key> New, Required for including your server on the server list

TODO

  • document r21903
    • should not change for well defined groups
    • may change behaviour if the group definitions were wrong