RacerRoomSetup.wiki
author Wuzzy
Wed, 30 Oct 2019 11:09:48 +0000
changeset 2081 a0c2ba8d636a
parent 2079 388bb06bd16e
child 2082 bb914d6298f2
permissions -rw-r--r--
Releasing: Edited via web interface
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 ==
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
     6
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
     7
The server has 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.
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     8
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     9
== Removing the Room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    10
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    11
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
    12
{{{
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    13
/unfix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    14
/delegate YourNick
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    15
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    16
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    17
Then exit. The room will be removed.
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    18
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    19
== Updating the room config for a new release ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    20
1742
b597100d6111 RacerRoomSetup: Update file name
Wuzzy
parents: 1509
diff changeset
    21
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
    22
It is stored relative to the game server.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    23
According to unc0rr, any errors in syntax will kill the server, so be careful!
2079
388bb06bd16e RacerRoomSetup: The vim code no longer works :/
Wuzzy
parents: 2078
diff changeset
    24
To update for a new release you usually just need to update `AMMO` for any newly added weapon entries.
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    25
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
    26
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    27
== Setting up the room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    28
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    29
After having removed the old room, create a new room named "Official Racer Room". Restrict join to registered players only (unregistered players don't get recorded in the stats) then run:
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    30
{{{
1743
39ca8f9807e3 RacerRoomSetup: Update file name
Wuzzy
parents: 1742
diff changeset
    31
/loadroom racer.yaml
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    32
/fix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    33
/callvote map #01
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    34
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    35
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    36
And leave. The `/callvote` will cause error messages 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
    37
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    38
== Running checker ==
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    39
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
    40
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    41
To build checker:
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    42
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    43
$ cabal build checker
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    44
}}}
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    45
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    46
Put `checker.ini` into `~/.hedgewars` with such content:
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    47
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    48
[engine]
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    49
exe=/usr/home/hedgewars/<VERSION>/bin/hwengine
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    50
prefix=/usr/home/hedgewars/<VERSION>/share/hedgewars/Data
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    51
}}}
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    52
1744
039b534ff9d6 RacerRoomSetup: link to ProtocolNumbers
Wuzzy
parents: 1743
diff changeset
    53
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
    54
{{{
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    55
INSERT INTO gameversions (protocol, version) VALUES (59, '1.0.0'), (60, '1.0.1-dev');
1507
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    56
}}}
1508
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    57
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    58
(Replace the version numbers (i.e. β€œ1.0.0” and β€œ1.0.1-dev”) and protocol numbers (i.e. 59 and 60) with the correct ones.)
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    59
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    60
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 a live system, that's not a problem.
1508
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    61
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    62
It is also not a problem to stop checker at any point. If you have engine hanging for too long (shouldn't happen since 0.9.24) and `game0.log` suggests that there's nothing going on in the game being replayed, just kill the engine process to count this attempt as failed.
1508
2fe2497eb7d7 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1507
diff changeset
    63
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    64
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.