Merge pull request #53 from PiterWeb/main

Linux support for Gamepad

Author: PiterWeb

CONTRIBUTING.md

@@ -30,10 +30,12 @@
 
   1. Fork this repository
   2. Clone it
-  3. Work on your translations (located in frontend/src/lib/i18n)
-  4. When you have finished make a pull request to merge it with the main branch
-  5. Wait for merge
-  6. Done
+  3. Work on your translations (located in frontend/src/lib/i18n):
+     - Create a JSON file of the language and register the language in the i18n.ts file (all of this if the language is not added already)
+     - Add the entries (you can do manually or using [i18n Ally extension](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally))
+  5. When you have finished make a pull request to merge it with the main branch
+  6. Wait for merge
+  7. Done
 
 
-## Thank you for reading this & also for your interest on contributing
+## Thank you for reading this & also for your interest on contributing

README.md

@@ -17,7 +17,8 @@
 
 ## Download 📦
 
-- https://remote-controller.vercel.app/download/
+- (Website) https://remote-controller.vercel.app/download/
+- (Github) https://github.com/PiterWeb/RemoteController/releases/latest
 
 ## Guides 📘
 
@@ -27,6 +28,7 @@
 ## Resources 📚
 
 - [Docs](./docs/) 📘
+- [Linux Docs](./docs/LINUX.md) 📘
 - [FAQ](https://remote-controller.vercel.app/info/resources/faq/) 💬
 - [Security](https://remote-controller.vercel.app/info/resources/security/) 🔐
 
@@ -41,7 +43,7 @@
 - [x] P2P "Decentralized" (WebRTC)
 - [x] Remote Streaming
 - [x] Browser Client
-- [x] Support for keyboard
+- [x] Support for keyboard (very experimental)
 - [x] ViGEmBus Setup (Windows)
 - [x] Localization (translation to multiple languages)
 - [x] Support for STUN & TURN
@@ -50,13 +52,13 @@
 
 | Windows 	| Linux 	| MacOS 	| Browser (Only Client) 	|
 |---------	|-------	|-------	|---------	|
-| ✔       	| (Only keyboard)⌛ Looking for contributions for Gamepad     	| (In theory keyboard works)⌛ Looking for contributions for Gamepad     	| ✔ (Known Issues with Safari)       	|
+| ✔       	| ✔ Gamepad support (❌ Keyboard/Streaming for the moment)     	| ❌ (No MacOS to test)     	| ✔ (Known Issues with Safari)       	|
 
 ### Native Gamepad Support 🎮
 
 | PC Controller (XInput/DirectInput) 	| Xbox Controller (XInput) 	| PlayStation Controler
 |---------	|-------	|-------	|
-| ✔       	| ✔     	| ❌ (You can achieve emulating a Xbox Controller)     	|
+| ✔       	| ✔     	| ❌ (But you can achieve [emulating a Xbox Controller](https://github.com/Ryochan7/DS4Windows))     	|
 
 ### Translations 🔠
 
@@ -70,13 +72,13 @@ There is no way to self-host the infrastructure of RemoteController because it h
 
 - If you want to self-host a TURN/STUN server you can [try Coturn](https://github.com/coturn/coturn). (This is only an example, you can choose other STUN/TURN implementations)
 
-- Also you can host the Web version (but it is only frontend) to make like a network of Remote Controller web clients
+- Also you can host the Web version (but it is only frontend, so is not very usefull)
 
 ## Run Dev
 
 ### Prerequisites
 
-You must have Task CLI, Wails CLI, NodeJS, pnpm and Golang installed.
+You must have [Task CLI](https://taskfile.dev/installation/), [Wails CLI](https://wails.io/docs/gettingstarted/installation#installing-wails), [NodeJS (~v20.x.x)](https://nodejs.org/en/download), [pnpm](https://pnpm.io/es/installation) and [Golang (min v1.22.4)](https://go.dev/doc/install) installed.
 
 ### How to
 
@@ -94,7 +96,7 @@ Go to the root project folder and run
 
 ### Prerequisites
 
-You must have Task CLI, Wails CLI, NodeJS, pnpm and Golang installed.
+You must have [Task CLI](https://taskfile.dev/installation/), [Wails CLI](https://wails.io/docs/gettingstarted/installation#installing-wails), [NodeJS (~v20.x.x)](https://nodejs.org/en/download), [pnpm](https://pnpm.io/es/installation) and [Golang (min v1.22.4)](https://go.dev/doc/install) installed.
 
 ### How to
 

Taskfile.yml

@@ -10,17 +10,17 @@ tasks:
   build:
     deps: [build-front]
     cmds:
-      - wails build -platform=windows/amd64,windows/arm64,linux/amd64,linux/arm64
+      - wails build -s -platform=windows/amd64,windows/arm64,linux/amd64,linux/arm64
     desc: Build the application for all platforms
   build-win:
     deps: [build-front]
     cmds:
-      - wails build -platform=windows/amd64,windows/arm64
+      - wails build -s -platform=windows/amd64,windows/arm64
     desc: Build the application for Windows
   build-linux:
     deps: [build-front]
     cmds:
-      - wails build -platform=linux/amd64,linux/arm64
+      - wails build -s -platform=linux/amd64,linux/arm64
     desc: Build the application for Linux
   build-wasm-front-linux:
     dir: frontend/static/wasm
@@ -37,7 +37,6 @@ tasks:
     cmds:
       - wails dev
     desc: Run the application in development mode
-
   dev-front:
     dir: frontend
     deps: [build-front]

docs/GamepadConversionTable.xlsx

@@ -0,0 +1,10 @@
+# Linux
+
+## Execute in Linux
+
+When you run RemoteController you will need to be sure to:
+
+- Your user has read/write permissions for /dev/input/event/* and uinput devices
+    - Example in Debian: sudo usermod -aG input $USER
+- Uinput module enabled
+    - Example in Debian: sudo modprobe uinput

docs/LINUX.md

@@ -0,0 +1,15 @@
+<script lang="ts">
+	import { isLinux } from '$lib/detection/detect_os';
+	import type { Snippet } from 'svelte';
+	let { children, not = false }: {children?: Snippet, not?: boolean} = $props();
+</script>
+
+{#await isLinux() then bool}
+	{#if bool}
+		{#if !not}
+			{@render children?.()}
+		{/if}
+	{:else if not}
+		{@render children?.()}
+	{/if}
+{/await}

docs/Xinput to GamepadAPI.xlsx

@@ -1,11 +1,15 @@
-<script>
+<script lang="ts">
 	import { isWindows } from '$lib/detection/detect_os';
-	/** @type {{children?: import('svelte').Snippet}} */
-	let { children } = $props();
+	import type { Snippet } from 'svelte';
+	let { children, not = false }: {children?: Snippet, not?: boolean} = $props();
 </script>
 
 {#await isWindows() then bool}
 	{#if bool}
+		{#if !not}
+			{@render children?.()}
+		{/if}
+	{:else if not}
 		{@render children?.()}
 	{/if}
 {/await}

frontend/src/lib/detection/IsLinux.svelte

@@ -4,16 +4,28 @@ import { GetCurrentOS } from '$lib/wailsjs/go/desktop/App';
 type OS = 'WINDOWS' | 'LINUX' | 'MACOS';
 
 export async function isWindows() {
-	if (onwebsite) return false;
-	else return ((await GetCurrentOS()) as OS) === 'WINDOWS';
+    try {
+        if (onwebsite) return false;
+        else return ((await GetCurrentOS()) as OS) === 'WINDOWS';
+    } catch {
+        return false
+    }
 }
 
 export async function isLinux() {
-    if (onwebsite) return false;
-    else return ((await GetCurrentOS()) as OS) === 'LINUX';
+    try {
+        if (onwebsite) return false;
+        else return ((await GetCurrentOS()) as OS) === 'LINUX';
+    } catch {
+        return false
+    }
 }
 
 export async function isMacOS() {
-    if (onwebsite) return false;
-    else return ((await GetCurrentOS()) as OS) === 'MACOS';
+    try {
+        if (onwebsite) return false;
+        else return ((await GetCurrentOS()) as OS) === 'MACOS';
+    } catch {
+        return false
+    }
 }

frontend/src/lib/detection/IsWindows.svelte

@@ -1,4 +1,9 @@
 // This file is used to determine if the app is running on the website(client only) or not.
 const onwebsite = import.meta.env?.VITE_ON_WEBSITE === 'true';
 
+// This will be true if using the linux client when browser opens
+const IS_RUNNING_EXTERNAL = window.location.port === "8080";
+
+export {IS_RUNNING_EXTERNAL}
+
 export default onwebsite;

frontend/src/lib/detection/detect_os.ts

@@ -3,8 +3,6 @@ import {
 	TryClosePeerConnection as closeConnectionFn
 } from '$lib/wailsjs/go/desktop/App';
 
-import { EventsOff, EventsOn, EventsOnce } from '$lib/wailsjs/runtime/runtime';
-
 import { _ } from 'svelte-i18n'
 import { get } from 'svelte/store';
 import { showToast, ToastType } from '$lib/toast/toast_hook';
@@ -14,6 +12,10 @@ import { StopStreaming } from '$lib/webrtc/stream/host_stream_hook';
 import type { ICEServer } from '$lib/webrtc/ice';
 import { exportStunServers } from './stun_servers';
 import { exportTurnServers } from './turn_servers';
+import { isLinux } from '$lib/detection/detect_os';
+import { IS_RUNNING_EXTERNAL } from '$lib/detection/onwebsite';
+
+const BROWSER_BASE_URL = "http://localhost:8080/mode/host/connection";
 
 let host: boolean = false;
 
@@ -50,13 +52,19 @@ export async function CreateHost(client: string) {
 		setLoadingMessage(get(_)('waiting-for-client-to-connect'));
 		setLoadingTitle(get(_)('make-sure-to-pass-the-code-to-the-client'));
 
-		EventsOnce('connection_state', (state: ConnectionState) => {
+		const {EventsOnce} = await import("$lib/wailsjs/runtime/runtime")
+
+		EventsOnce('connection_state', async (state: ConnectionState) => {
 			toogleLoading();
 
 			switch (state.toUpperCase()) {
 				case ConnectionState.Connected:
 					showToast(get(_)('connected'), ToastType.SUCCESS);
 					host = true;
+					if (await isLinux()) {
+						const {BrowserOpenURL} = await import("$lib/wailsjs/runtime/runtime")
+						BrowserOpenURL(BROWSER_BASE_URL);
+					} 
 					goto('/mode/host/connection');
 					break;
 				case ConnectionState.Failed:
@@ -85,7 +93,12 @@ export function CloseHostConnection(fn?: () => void) {
 	StopStreaming();
 }
 
-export function ListenForConnectionChanges() {
+export async function ListenForConnectionChanges() {
+
+	if (IS_RUNNING_EXTERNAL) return;
+
+	const {EventsOn, EventsOff} = await import("$lib/wailsjs/runtime/runtime")
+
 	const connectionStateCancelEventListener = EventsOn(
 		'connection_state',
 		(state: ConnectionState) => {