RacerRoomSetup.wiki
author Wuzzy
Fri, 31 May 2019 19:12:26 +0100
changeset 1912 94899e4fabe6
parent 1744 039b534ff9d6
child 2051 3a9136f56fe5
permissions -rw-r--r--
GearTypes: Warnings about gtATStartGame and gtATFinishGame
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     1
#summary How to setup the official racer room
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     2
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     3
= Racer Room Setup =
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     4
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     5
== Overview ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     6
Some time ago unc0rr added support for "fixed" server rooms in order to have a permanent room for hosting race maps.  A little manual setup is required, and at present must be recreated on every new release and server restart.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     7
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     8
== Removing the Room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     9
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    10
In order to add a room for a new release, the old room must be removed first.  Join the game using the old release, join the Official Racer Room then run:
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    11
{{{
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    12
/unfix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    13
/delegate YourNick
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    14
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    15
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    16
Then exit.  The room will be removed.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    17
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    18
== Updating the room config for a new release ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    19
1742
b597100d6111 RacerRoomSetup: Update file name
Wuzzy
parents: 1509
diff changeset
    20
The racer room configuration is currently here: [https://hg.hedgewars.org/hedgewars/raw-file/tip/misc/racer.yaml]
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    21
It is stored relative to the game server.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    22
According to unc0rr, any errors in syntax will kill the server, so be careful!
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    23
To update for a new release you usually just need to add new characters to the AMMO for any newly added weapon entries.
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    24
{{{:s/\([0-9]\{58\}\)/\10/g}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    25
will do this in vim, where 58 is the number of weapons in the current racer room and the 0 is for the addition.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    26
New maps can be added too, using existing entries as a reference.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    27
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    28
== Setting up the room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    29
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    30
After having removed the old room, create a new room named "Official Racer Room".  Restrict join to registered players only (unregistered don't get recorded in the stats) then run:
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    31
{{{
1743
39ca8f9807e3 RacerRoomSetup: Update file name
Wuzzy
parents: 1742
diff changeset
    32
/loadroom racer.yaml
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    33
/fix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    34
/callvote map #01
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    35
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    36
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    37
And leave.  The callvote will cause errors as long as you are still the room admin, but they don't matter.  You can quit/rejoin before that step if you wish.
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    38
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    39
== Running checker ==
1509
9c51e2c8572c RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1508
diff changeset
    40
Make sure you have hedgewars working, your login/password pair (admin rights on the server required!) is stored in frontend's config.
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    41
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    42
To build checker:
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    43
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    44
$ cabal build checker
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    45
}}}
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    46
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    47
Put checker.ini into ~/.hedgewars with such content:
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    48
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    49
[engine]
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    50
exe=/usr/home/hedgewars/0.9.24/bin/hwengine
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    51
prefix=/usr/home/hedgewars/0.9.24/share/hedgewars/Data
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    52
}}}
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    53
1744
039b534ff9d6 RacerRoomSetup: link to ProtocolNumbers
Wuzzy
parents: 1743
diff changeset
    54
When updating between versions, update version in checker's source, run this on the server's database to have new stats appear on the records page (see also [ProtocolNumbers]):
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    55
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    56
INSERT INTO gameversions (protocol, version) VALUES (55, '0.9.24'), (56, '0.9.25-dev');
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    57
}}}
1508
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    58
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    59
If you see too many "Check failed" messages in your checker's log, check your setup. If you fixed a problem with engine, you might want to recheck previously failed replays by moving them from "failed" to "replays" folder on the game server. You may do it on live system, that's np.
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    60
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    61
It is also not a problem to stop checker at any point. If you have engine hanging for too long (shouldn't happen since .24) and game0.log suggests that there's nothing going on in the game being replayed, just kill engine process to count this attempt as failed.
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    62
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    63
It is fine to have multiple instances of checker running, even on the same host and on the same account, if you like. This helps when you have lots of replays to check and some spare cpu cores.