From 4588496300e083df03bc6ac39020f703eb2f52f4 Mon Sep 17 00:00:00 2001 From: Stefan Sundin Date: Tue, 30 May 2023 22:59:40 -0700 Subject: [PATCH] Add information about game clients with native support. --- README.md | 13 +++++++++++++ linux/README.md | 32 ++++++++++++++++++++++++++++++++ mac/README.md | 8 +++++++- 3 files changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc91fa7..2ddb92f 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,16 @@ To get this working in Firefox, you have to open `about:config`. Once there, enter `network.protocol-handler.expose.stvef` in the search field and create it as a boolean. Once created, set the value to `false`. Based on https://github.com/stefansundin/vlc-protocol. + +## Game clients with native support + +After a lengthy process, I have managed to get native protocol handler support merged to the ioquake3 codebase (see: [final commit](https://github.com/ioquake/ioq3/commit/31c6d2f9d502868970ccbe62d7cef36206cbc8b1), [pull request](https://github.com/ioquake/ioq3/pull/540)). This means that eventually this repository won't be needed anymore. + +It will take time for game clients to merge in support and release new versions, so your client of choice may not work out of the box just yet. Even when new clients have been released, you may still need to perform manual steps: +- Windows users will still need to register the protocol in the Windows registry (usually done by running a `.bat` file). +- macOS users will just need to drag the `.app` file to `/Applications/`. +- Linux users need to install a `.desktop` file ([see here](linux/README.md)). + +If your favorite game client has not merged support yet then feel free to use [my test build](https://github.com/stefansundin/elite-force/releases/tag/lilium-protocol-handler-v1). + +(The native support requires a new URL format compared to what efservers.com used in the past. LocutusOfBorg recently changed the links on efservers.com to use the new format.) diff --git a/linux/README.md b/linux/README.md index 507cb77..1c2871c 100644 --- a/linux/README.md +++ b/linux/README.md @@ -10,6 +10,38 @@ The download from `holomat.ch` includes all of the necessary files. For the othe If you use Wine to install the Windows executable from holomat.ch, then you need to run `winetricks vcrun2015`. +## Native support + +If you are using a client with native protocol handler support then you just need [`stvef.desktop`](stvef.desktop). If your favorite game client has not merged support yet then feel free to use [my test build](https://github.com/stefansundin/elite-force/releases/tag/lilium-protocol-handler-v1). + +You need to modify the file to make sure it is launching the correct executable. + +```shell +# Download the icon file and install it: +curl -L -o stvef.png https://github.com/stefansundin/stvef-protocol/raw/main/linux/stvef.png +xdg-icon-resource install stvef.png --size 64 --novendor + +# Download the example file: +curl -L -o stvef.desktop https://github.com/stefansundin/stvef-protocol/raw/main/linux/stvef.desktop + +# Modify the stvef.desktop file. You need to edit the "Exec=" path to be correct. + +# Install the desktop file: +xdg-desktop-menu install stvef.desktop --novendor + +# Optional clean up: +rm stvef.desktop +rm stvef.png +``` + +Uninstall: + +```shell +xdg-desktop-menu uninstall stvef.desktop +xdg-icon-resource uninstall stvef.png +``` + + ## Install stvef-protocol The [`stvef-protocol`](stvef-protocol) script makes some assumptions regarding where the game is installed. Edit the script if the game is located elsewhere. diff --git a/mac/README.md b/mac/README.md index a66fb64..a81145a 100644 --- a/mac/README.md +++ b/mac/README.md @@ -11,6 +11,12 @@ Be sure to turn on `Auto Downloading` in the game settings. Note that in Tulip Voyager, the key combination to bring up the console is Shift + ~. +## Native support + +If you are using a game client with native support then you don't need to download anything. The links should work after you move the `.app` to `/Applications/`. + +If your favorite game client has not merged support yet then feel free to use [my test build](https://github.com/stefansundin/elite-force/releases/tag/lilium-protocol-handler-v1). + ## Install stvef-protocol [You can download the app from the releases section.](https://github.com/stefansundin/stvef-protocol/releases/latest) @@ -19,7 +25,7 @@ Note that in Tulip Voyager, the key combination to bring up the console is To build and install, run: -``` +```shell git clone https://github.com/stefansundin/stvef-protocol.git cd stvef-protocol/mac ./build.sh