RacerRoomSetup.wiki
author sheepluva
Thu, 23 Mar 2023 20:47:32 +0000
changeset 2221 4bf8172a73a1
parent 2082 bb914d6298f2
permissions -rw-r--r--
TableOfContents: TableOfContents: Adjust two Entries
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2082
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
     1
#summary How to setup the Official Racer Challenge room
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
     2
2082
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
     3
= Official Racer Challenge Room Setup =
1420
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
2082
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
     7
The server has support for "fixed" server rooms in order to have a permanent room for e.g. hosting Racer/TechRacer maps. Fixed rooms can exist even when nobody is inside.
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
     8
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
     9
On the official server, we use this for the Official Racer Challenge.
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
    10
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
    11
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
    12
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    13
== Removing the Room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    14
2082
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
    15
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 Challenge room, then run:
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    16
{{{
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    17
/unfix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    18
/delegate YourNick
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    19
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    20
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    21
Then exit. The room will be removed.
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    22
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    23
== Updating the room config for a new release ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    24
1742
b597100d6111 RacerRoomSetup: Update file name
Wuzzy
parents: 1509
diff changeset
    25
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
    26
It is stored relative to the game server.
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    27
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
    28
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
    29
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
    30
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    31
== Setting up the room ==
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    32
2082
bb914d6298f2 RacerRoomSetup: official racer
Wuzzy
parents: 2079
diff changeset
    33
After having removed the old room, create a new room named "Official Racer Challenge". 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
    34
{{{
1743
39ca8f9807e3 RacerRoomSetup: Update file name
Wuzzy
parents: 1742
diff changeset
    35
/loadroom racer.yaml
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    36
/fix
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    37
/callvote map #01
1421
ac35ef6e999f add code tags
nemo
parents: 1420
diff changeset
    38
}}}
1420
7693d88707e4 bit of documentation for setting up the racer room
nemo
parents:
diff changeset
    39
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    40
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
    41
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    42
== Running checker ==
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    43
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
    44
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    45
To build checker:
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    46
{{{
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    47
$ cabal build checker
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    48
}}}
0df1fac87c44 RacerRoomSetup: Edited via web interface
unC0Rr
parents: 1421
diff changeset
    49
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    50
Put `checker.ini` into `~/.hedgewars` with such content:
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
[engine]
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    53
exe=/usr/home/hedgewars/<VERSION>/bin/hwengine
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    54
prefix=/usr/home/hedgewars/<VERSION>/share/hedgewars/Data
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
1744
039b534ff9d6 RacerRoomSetup: link to ProtocolNumbers
Wuzzy
parents: 1743
diff changeset
    57
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
    58
{{{
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    59
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
    60
}}}
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
(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
    63
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    64
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
    65
2078
499a9bda5571 RacerRoomSetup: Clean up grammar
Wuzzy
parents: 2077
diff changeset
    66
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
    67
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2051
diff changeset
    68
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.