1 #summary The Hedgewars URL scheme handler |
1 #summary The Hedgewars URL scheme handler |
2 |
2 |
3 = Hedgewars server links = |
3 = Hedgewars server links = |
4 == Overview == |
4 == Overview == |
5 Hedgewars supports special links for Hedgewars servers and rooms. You can join a server (and optionally a room) by using a simple link. These links always start with “`hwplay://`” and look like this: |
5 Hedgewars supports special links for Hedgewars servers. You can join a server by using a simple link. These links always start with “`hwplay://`” and look like this: |
6 |
6 |
7 `hwplay://hedgewars.example.org` |
7 `hwplay://hedgewars.example.org` |
8 |
8 |
9 If your system is set-up to handle `hwplay` URLs, it will start Hedgewars and puts you immediately in the server. |
9 If your system is set-up to handle `hwplay` URLs, it will start Hedgewars and puts you immediately in the server. |
10 |
10 |
30 Of course, you can also try to create the URLs from hand (see below). |
30 Of course, you can also try to create the URLs from hand (see below). |
31 |
31 |
32 == Syntax == |
32 == Syntax == |
33 `hwplay` is an unofficial URL scheme supported by Hedgewars. The syntax of the “hwplay” URL scheme is: |
33 `hwplay` is an unofficial URL scheme supported by Hedgewars. The syntax of the “hwplay” URL scheme is: |
34 |
34 |
35 `hwplay://<HOST>[:<PORT NUMBER>[?room=<ROOM NAME>]]` |
35 `hwplay://<HOST>[:<PORT NUMBER>]` |
36 |
36 |
37 Parts in square brackets are optional. |
37 Parts in square brackets are optional. |
38 Parts enclosed in less-then and greater-than signs are parameters, where |
38 Parts enclosed in less-then and greater-than signs are parameters, where |
39 |
39 |
40 * `<HOST>` is the IP address or host name of the server |
40 * `<HOST>` is the IP address or host name of the server |
41 * `<PORT NUMBER>` stands for the TCP port number of the server |
41 * `<PORT NUMBER>` stands for the TCP port number of the server |
42 * `<ROOM NAME>` is the name of a room in the server |
|
43 |
42 |
44 If the port number is omitted, Hedgewars assumes the default port 46631. |
43 If the port number is omitted, Hedgewars assumes the default port 46631. |
45 |
|
46 If the room name is given, the user will automatically join this room. Otherwise, the user will start in the lobby of the server. |
|
47 |
44 |
48 == Examples == |
45 == Examples == |
49 Here are some example `hwplay` URLs: |
46 Here are some example `hwplay` URLs: |
50 |
47 |
51 * [hwplay://netserver.hedgewars.org]: Points to the lobby of the official server. This is the same as if you'd click on the “official server” button in the main menu |
48 * [hwplay://netserver.hedgewars.org]: Points to the lobby of the official server. This is the same as if you'd click on the “official server” button in the main menu |
52 * `hwplay://192.168.43.6:54321`: Points to the lobby on a LAN server with IP 192.168.42.6, port number 54321 |
49 * `hwplay://192.168.43.6:54321`: Points to the lobby on a LAN server with IP 192.168.42.6, port number 54321 |
53 * `hwplay://example.org?room=MyRoom`: Points to the room called “MyRoom” on the server “example.org” |
|
54 * `hwplay://example.com:59000`: Points to the server “example.com”, port number 59000 |
50 * `hwplay://example.com:59000`: Points to the server “example.com”, port number 59000 |