diff -r 272505d2f8c9 -r 88ae278e5484 HWPlaySchemeSyntax.wiki --- a/HWPlaySchemeSyntax.wiki Sat Jul 21 14:32:37 2018 +0100 +++ b/HWPlaySchemeSyntax.wiki Sat Jul 21 14:42:27 2018 +0100 @@ -1,21 +1,19 @@ #summary The Hedgewars URL scheme handler -= URL scheme handler = += Hedgewars server links = == Overview == -Hedgewars supports an URL scheme for Hedgewars servers and rooms. These are basically links which allow you to join a server (and optionally a room) by using a simple link. You can join a Hedgewars server with a single click. These links are called “`hwplay` URLs” and look like this: +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: `hwplay://hedgewars.example.org` -If your system is set-up to handle `hwplay` URLs, they will open Hedgewars and make it join the given server and room. +If your system is set-up to handle `hwplay` URLs, it will start Hedgewars and puts you immediately in the server. -The following link goes to the official Hedgewars server. Try it to test if `hwplay` links work on your system: +The following link goes to the official Hedgewars server, you can try it out right now: [hwplay://netserver.hedgewars.org] == Usage == -You can share a `hwplay` URL with other players so they join your server more easily. - Your browser and other software needs to learn first how to deal with `hwplay`. We recommend to first click on “Assign file types” in the Settings menu, Advanced tab, this should set things up automatically for you. @@ -33,7 +31,7 @@ Of course, you can also try to create the URLs from hand (see below). == Syntax == -The syntax of the “hwplay” URL scheme is: +`hwplay` is an unofficial URL scheme supported by Hedgewars. The syntax of the “hwplay” URL scheme is: `hwplay://[:[?room=]]` @@ -46,7 +44,7 @@ If the port number is omitted, Hedgewars assumes the default port 46631. -If the room name is given, the user will automatically join this room. If it is not given, the user will start in the lobby of the server. +If the room name is given, the user will automatically join this room. Otherwise, the user will start in the lobby of the server. == Examples == Here are some example `hwplay` URLs: