HWPlaySchemeSyntax.wiki
changeset 1492 13e8497cc611
parent 736 e2b1f824f37b
child 1493 151399fffe42
--- a/HWPlaySchemeSyntax.wiki	Fri Jul 20 22:30:02 2018 +0100
+++ b/HWPlaySchemeSyntax.wiki	Sat Jul 21 14:29:17 2018 +0100
@@ -3,24 +3,32 @@
 = URL scheme handler =
 
 == Overview ==
-`hwplay` is an unofficial URL scheme for specifying a server and optionally a room. Hedgewars is able to interpret these URLs to automatically join the specified server and room.
+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. These are called “`hwplay` URLs” and can look like this:
+
+`hwplay://hedgewars.example.org`
 
-`hwplay` URLs are useful if you want to play on a server other than the official one.
+If your system is set-up to handle `hwplay` URLs, they will open Hedgewars and make it join the given server and room.
+
+Here's an example link, try it to see if `hwplay` URLs work for you:
+
+[hwplay://netserver.hedgewars.org]
 
 == Usage ==
 You can share a `hwplay` URL with other players so they join your server more easily.
 
-Since `hwplay` is an unofficial URL scheme, your browser and other software needs to learn first how to interpret these URLs.
-Applications might ask you which program to use with a `hwplay` URL. You have to point these to the Hedgewars program (`hedgewars.exe` on Windows, `hedgewars` on GNU/Linux and Mac OS).
+Your browser and other software needs to learn first how to deal with `hwplay`.
+The easiest way is to click on “Assign file types” in the Settings menu, Advanced tab, this should set it up automatically for you.
+
+If an application (like a browser) is confused about `hwplay`, point it to the Hedgewars program (`hedgewars.exe` on Windows, `hedgewars` on GNU/Linux and Mac OS).
 
 Hedgewars itself also can use a `hwplay` URL as a command-line argument. See [CommandLineOptions#Frontend] for more information.
 
-`hwplay` URLs are completely optional, you can of course join any server without a `hwplay` URL as long you know its hostname / IP address and port number (46631 by default).
+`hwplay` URLs are of course optional, you can join any server from the main menu by selecting the network game, then “local network”, then by selecting a server from the list or entering its address directly after clicking on the “Connect to” button.
 
 == Creating `hwplay` URLs ==
-When you are about to start a server in Hedgewas (Main menu → Network game → Local network → Start server), Hedgewars will create a `hwplay` URL for you and copy it into the clipboard if you click on the “invite” button.
+When you are about to start a server in Hedgewas (Main menu → Network game → Local network → Start server), Hedgewars will create a `hwplay` URL for you. You can copy it into the clipboard if you click on the “invite” button.
 
-Note the generated URL might only work in your LAN, so please check the IP address. You can obtain your Internet IP address on http://myip.is/ (for example).
+Note the generated URL might only work in your LAN and not world wide, so please check the IP address. You can obtain your Internet IP address on http://myip.is/ (for example).
 
 Of course, you can also try to create the URLs from hand (see below).
 
@@ -43,7 +51,7 @@
 == Examples ==
 Here are some example `hwplay` URLs:
 
- * `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
+ * [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
  * `hwplay://192.168.43.6:54321`: Points to the lobby on a LAN server with IP 192.168.42.6, port number 54321
  * `hwplay://example.org?room=MyRoom`: Points to the room called “MyRoom” on the server “example.org”
  * `hwplay://example.com:59000`: Points to the server “example.com”, port number 59000
\ No newline at end of file