Merge pull request #88 from PiterWeb/main

Pre release 0.9.9

Author: PiterWeb

.gitignore

@@ -1,3 +1,4 @@
+.task/
 build/
 /*.exe
 /*.dll

CONTRIBUTING.md

@@ -7,7 +7,7 @@
   - docs/ (All the development documentation)
   - frontend/src/lib/i18n (All the translations of the project)
 
-## Requisites
+## Requisites (only apply to code contributions)
   - If you want to contribute first you need to check the issues, them if you like any of the open issues work on it and merge it to the project (obviously you can open a new issue to enhance the features or correct any bug you found to work on it later)
   - Try to do self-explanatory code (if cannot be you can comment to enhance the comprehension)
 
@@ -16,6 +16,8 @@
   - [LibreRemotePlay Docs](./docs/README.md)
   - [How to run the project](./README.md#run-dev)
   - [How to build the project](./README.md#build)
+  - [LibreRemotePlay Wiki](https://github.com/PiterWeb/LibreRemotePlay/wiki)
+  - [LibreRemotePlay DeepWiki](https://deepwiki.com/PiterWeb/LibreRemotePlay)
 
 ## How to
 
@@ -28,13 +30,15 @@
 
 ## Translations 🔠
 
+By default English is the language of reference so you can check if there are entries in english that are missing in the language you may want to contribute to 
+
 ### How to
 
   1. Fork this repository
   2. Clone it
   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))
+     - Add the entries (you can do manually but using [i18n Ally extension](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) is recommended)
   5. When you have finished make a pull request to merge it with the main branch
   6. Wait for merge
   7. Done

README.md

@@ -1,4 +1,4 @@
-![LibreRemotePlay logo banner](https://github.com/user-attachments/assets/9173246d-1d65-4f29-bd79-0206250c538c)
+![LibreRemotePlay logo banner](./assets/libreremoteplaybanner.webp)
 
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/PiterWeb/LibreRemotePlay)
 
@@ -7,6 +7,10 @@
 > [!IMPORTANT]  
 > The software for the moment is very experimental, may not always work an all systems. If you find a bug you can report it on issues page or discord.
 
+> [!NOTE]  
+> If you are interested in contributing (code/translations) you can follow [this guide](./CONTRIBUTING.md)
+
+
 ### An open source, free (as in freedom) and P2P alternative to Steam Remote Play
 
 - Website 🌐: https://libreremoteplay.vercel.app/
@@ -16,6 +20,8 @@
 - Discord Community 👥: https://discord.gg/v7qd7nU3fJ
 
 - Series of WebRTC Articles 👨‍💻: https://dev.to/piterweb/series/30718
+  
+- Codeberg Mirror 🗃️: https://codeberg.org/PiterWeb/LibreRemotePlay 
 
 ## Use cases ✨
 
@@ -29,7 +35,7 @@
 ## Resources 📚
 
 - [Docs](./docs/) 📘
-- [Linux Docs](./docs/LINUX.md) 📘
+- [Linux Docs](https://github.com/PiterWeb/LibreRemotePlay/wiki/installation-&-execution#execute-in-linux) 📘
 - [Wiki](https://github.com/PiterWeb/LibreRemotePlay/wiki) (Guides, FAQ, ...)
 - [Discord Community](https://discord.gg/v7qd7nU3fJ)
 
@@ -42,18 +48,26 @@ https://github.com/user-attachments/assets/f4a412fa-f403-4429-85fb-9c1e74bff458
 
 ## Features 🧩
 
-- [x] Portable
-- [x] Simple & Modern UI
-- [x] Interactive Tutorial
-- [x] Peer-to-Peer (WebRTC)
+- [x] FOSS (Free & Open Source Software)
+- [x] Gamepad support (See the table below) 
+- [x] Portable (No installations needed)
+- [x] Privacy-friendly (No data collected in APP / Client website)
+- [x] Based on Europe: Developed mainly by me (PiterWeb) from Spain
+- [x] Simple & modern UI
+- [x] Includes an interactive tour through the application
+- [x] Peer to Peer connections (WebRTC)
+- [x] LAN mode (It is not necessary to use the Internet) 
 - [ ] Groups
 - [x] Remote Video Streaming
-  - [x] Video Quality Config 
-- [x] Browser Client
-- [x] Localization (translation to multiple languages)
-- [x] Support for custom STUN & TURN servers
-- [x] Keyboard (Experimental)
-- [x] Toogle Devices
+  - [x] Stream video quality Config (Codecs, FPS, resolution)
+  - [ ] WHIP streaming compatibility (Stream your screen using: Gstreamer, OBS, ...)
+- [x] Client role works on browser
+- [x] Translated to multiple languages
+- [x] You can customize the STUN & TURN servers
+- [x] Keyboard support (Experimental)
+- [ ] Mouse support
+- [x] Toogle gamepad/keyboard access
+- [x] [EasyConnect](https://github.com/PiterWeb/LibreRemotePlayEasyConnectServer) 
 
 ### OS Support 💻
 
@@ -75,12 +89,14 @@ https://github.com/user-attachments/assets/f4a412fa-f403-4429-85fb-9c1e74bff458
 
 ## Self Hosting ☁
 
-There is no way to self-host the infrastructure of LibreRemotePlay because it has no backend. But instead you can self-host if you want the TURN & STUN servers and then add them to the config.
+There is no way to self-host the infrastructure of LibreRemotePlay because it has no backend. But instead you can self-host if you want the TURN & STUN servers and then add them to the config or the [EasyConnectServer](https://github.com/PiterWeb/LibreRemotePlayEasyConnectServer).
 
 - 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, so is not very usefull)
 
+- If you want to self-host an EasyConnectServer you can follow the docs of [EasyConnectServer repo](https://github.com/PiterWeb/LibreRemotePlayEasyConnectServer), this service is also packed in the desktop app and run in app startup but instead you can launch it along. EasyConnectServer is a signaling server that makes code passing in an automatic way.
+
 ## Run Dev
 
 ### Prerequisites
@@ -160,6 +176,14 @@ These projects are making LibreRemotePlay a reality.
 ## Did you like the project 👍 ?
 You can give us a star and join our [Discord Community](https://discord.gg/v7qd7nU3fJ), the project is always looking for feedback :)
 
+## Are you interested in other gaming projects 🤔? 
+
+<br/>
+<img width="128" height="128" alt="logo of gamelinksafe cli" src="https://github.com/user-attachments/assets/615bfb59-7f1c-4e9d-8e84-c9368e92f2f7" />
+
+You may be interested in [GameLinkSafeCLI](https://github.com/PiterWeb/GameLinkSafeCLI) is like ngrok but works with TCP/UDP without account and no need to self-host in normal enviroments. 
+Can be used like a hamachi alternative for gamers who are familiar with CLIs.
+
 ## Star History
 Here you can see how fast the community is growing
 <br/>

Taskfile.yml

@@ -1,69 +1,87 @@
 version: '3'
 
 tasks:
-  build-front:
+  dev-all:
+    deps: [build-front]
+    cmds:
+      - wails dev
+    desc: Run the application in development mode
+  dev-front:
     dir: frontend
+    deps: [install-front]
     cmds:
-      - pnpm install
-      - pnpm run build
-    desc: Build the frontend
+      - pnpm run dev
+    desc: Run the frontend in development mode
   build:
     deps: [build-front]
     cmds:
-      - wails build -s -platform=windows/amd64,windows/arm64,linux/amd64,linux/arm64
+      - wails build -s -platform=windows/amd64,linux/amd64
     desc: Build the application for all platforms
   build-win:
     deps: [build-front]
     cmds:
-      - wails build -s -platform=windows/amd64,windows/arm64
+      - wails build -s -platform=windows/amd64
     desc: Build the application for Windows
   build-debug-win:
     deps: [build-front]
     cmds:
-      - wails build -debug -s -platform=windows/amd64,windows/arm64
+      - wails build -debug -s -platform=windows/amd64
     desc: Build the debug application for Windows
   build-linux:
     deps: [build-front]
     cmds:
-      - wails build -s -platform=linux/amd64,linux/arm64
+      - wails build -s -platform=linux/amd64
     desc: Build the application for Linux
   build-debug-linux:
     deps: [build-front]
     cmds:
-      - wails build -debug -s -platform=linux/amd64,linux/arm64
+      - wails build -debug -s -platform=linux/amd64
     desc: Build the debug application for Linux
   build-linux-appimage:
+    deps: [build-linux]
     cmds:
       - wget https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
       - chmod +x linuxdeploy-x86_64.AppImage
       - wget -c "https://raw.githubusercontent.com/linuxdeploy/linuxdeploy-plugin-gtk/master/linuxdeploy-plugin-gtk.sh"
       - chmod +x linuxdeploy-plugin-gtk.sh
-      - ./linuxdeploy-x86_64.AppImage --appdir AppDir --desktop-file assets/LibreRemotePlay.desktop --executable build/bin/LibreRemotePlay-linux-amd64 --plugin gtk -i assets/remotecontroller.png -d assets/LibreRemotePlay.desktop --output appimage
-    desc: Build AppImage for Linux based on previously generated binaries 
-  build-wasm-front-linux:
-    dir: frontend/static/wasm
-    cmds:
-      - GOOS=js GOARCH=wasm go build -o signal.wasm
-    desc: Build the frontend wasm for Linux
-  build-wasm-front-win:
+      - ./linuxdeploy-x86_64.AppImage --appdir AppDir --desktop-file assets/LibreRemotePlay.desktop --executable build/bin/LibreRemotePlay --plugin gtk -i assets/remotecontroller.png -d assets/LibreRemotePlay.desktop --output appimage
+    desc: (Experimental) Build AppImage for Linux based on previously generated binaries (wget required)
+  build-wasm-front:
     dir: frontend/static/wasm
+    env: 
+      GOOS: js
+      GOARCH: wasm
     cmds:
-      - powershell.exe -Command { $env:GOOS="js";$env:GOARCH="wasm"; go build -o signal.wasm }
-    desc: Build the frontend wasm for Windows
-  dev-all:
-    deps: [build-front]
-    cmds:
-      - wails dev
-    desc: Run the application in development mode
-  dev-front:
-    dir: frontend
-    deps: [build-front]
-    cmds:
-      - pnpm run dev
-    desc: Run the frontend in development mode
+      - go build -o signal.wasm
+    desc: Build the frontend wasm
+    sources:
+      - signal.wasm
   test:
     desc: Run E2E tests
     dir: frontend
     deps: [dev-all]
     cmds:
-      - pnpm run test
+      - pnpm run test
+  install-front:
+    dir: frontend
+    cmds:
+      - pnpm install
+    sources:
+      - package.json
+    status:
+      - test -d node_modules
+  build-front:
+    deps: [install-front, build-wasm-front]
+    dir: frontend
+    cmds:
+      - pnpm run build
+    sources:
+        - src/**/*.js
+        - src/**/*.ts
+        - src/**/*.svelte
+        - src/**/*.json
+        - vite.config.ts
+        - svelte.config.js
+        - tailwind.config.js
+        - package.json
+    desc: Build the frontend