small-improvements-and-cleanup

Co-authored-by: RX0FA <[email protected]>
Co-committed-by: RX0FA <[email protected]>

Author: RX0FA

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Generate Tag
       id: tag_step
       run: |-
-        program_version="$(echo 1.0.0)"
+        program_version=$(./dist/raptor-cage -V | awk '{print $2}')
         tag_name="${program_version}-$(date +%y%m%d%H%M)-$(git rev-parse HEAD | head -c 7)"
         printf "tag_name=${tag_name}\nprogram_version=${program_version}\n" | tee -a "$GITHUB_OUTPUT"
     # https://github.com/ncipollo/release-action.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "raptor-cage"
-version = "0.1.0"
+version = "1.0.1"
 edition = "2021"
 license = "CIL-1.0"
 

Cargo.toml

@@ -12,5 +12,6 @@ docker-build: clean
 	mkdir -p dist
 	docker build -f build.dockerfile . -t raptor-cage
 	docker run --rm raptor-cage cat /builder/target/release/raptor-cage > dist/raptor-cage
+	chmod +x dist/raptor-cage
 	tar czf dist/raptor-cage.tgz -C dist raptor-cage
 	sh -c 'cd dist && sha256sum raptor-cage.tgz | tee raptor-cage.sha256'

Makefile

@@ -9,18 +9,37 @@
 
 ## ⬇️ Installation
 
-TODO
+### ArchLinux
+
+```bash
+# Using paru.
+paru -S raptor-cage-bin
+
+# Manual clone.
+git clone https://aur.archlinux.org/raptor-cage-bin.git
+cd raptor-cage-bin
+makepkg -sri
+```
+
+### Manual Installation
+
+```bash
+download_url="$(curl -sL 'https://api.github.com/repos/RX0FA/raptor-cage/releases/latest' | grep -E 'browser_download_url.+\.tgz' | grep -oP '"browser_download_url": "\K[^"]+')"
+curl -L -o raptor-cage.tgz "$download_url"
+tar xf raptor-cage.tgz
+sudo install -Dm755 raptor-cage "/usr/local/bin/rcage"
+```
 
 ## 💡 Usage
 
 ### Command Line
 
 ```bash
 # Run Windows game, runner and prefix paths are relative to Bottles data directory.
-raptor-cage run -r soda-9.0-1 -p my_prefix -d ~/games/some_game -b game.exe
+rcage run -r soda-9.0-1 -p my_prefix -d ~/games/some_game -b game.exe
 
 # Run native binary, and pass custom parameters.
-raptor-cage run -r soda-9.0-1 -p my_prefix -d ~/games/some_game -b native_binary -- --param1
+rcage run -r soda-9.0-1 -p my_prefix -d ~/games/some_game -b native_binary -- --param1
 ```
 
 ## 📌 Frequently Asked Questions
@@ -65,19 +84,15 @@ cargo upgrade --dry-run
 
 * Some games (like HC2, DXM) create a detached sub-process, since we are using `--die-with-parent`, said games will not run when executed directly (with `-b` parameter, executing a shell and launching manually still works); so we need to think in a way to detect child processes and wait for them, or at least add a flag to enable this feature. Disabling `--die-with-parent` is another option, but that would undermine security a bit and leave lingering wine processes all over the place. Maybe add a `--lead-process=NAME_EXE:TIMEOUT` to wait for another process inside the sandbox.
 * Implement bash autocompletion, should be able to autocomplete prefix and runner names based on the ones detected under Bottles.
-* If application binary `-b` does not end with `.exe`, do not prepend `wine`, it's possible that the user wants to run a custom command like `mangohud` or a native Linux game.
 * Add `integrate` sub-command to create integrations e.g., `.desktop` shortcut, entry on Heroic launcher.
-* Native wayland support, see https://www.phoronix.com/news/Wine-9.22-Released and https://wiki.archlinux.org/title/Wine#Wayland.
+* Native wayland support, see https://www.phoronix.com/news/Wine-9.22-Released and https://wiki.archlinux.org/title/Wine#Wayland. Also consider bringing back `--unshare-ipc` if using Wayland prevents the issue described in bwrap.rs#90.
 * Add `kill` sub-command to terminate all processes in a sandbox, need to connect to existing bwrap container.
 * Add argument to mount additional paths (needed for installers and maintenance), syntax can be similar to Docker's `-v PATH:FLAGS`.
 * When using the `integrate` sub-command to create a `.desktop` shortcut, extract executable icon and set it respectively. It can be done with a small windows executable calling a win32 API call or natively on Linux by using `wrestool`.
 * Add NTSYNC support, see also https://www.phoronix.com/news/Linux-6.14-NTSYNC-Driver-Ready.
 
 #### Packaging
 
-* AUR package, also add `mangohud` as optional dependency.
-* Setup GitHub Actions to automatically publish AUR package.
-* Normal binary release.
 * cURL install script.
 * Create deb package. It should depend on Steam libraries (similarly to Arch's `steam-native-runtime`), see https://packages.ubuntu.com/search?keywords=steam&searchon=names&suite=noble&section=all.
 * Make a reusable lib version (`Cargo.lock` needs to be ignored, see https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html).

README.md

@@ -7,11 +7,11 @@ url='https://github.com/RX0FA/raptor-cage'
 source_x86_64=("https://github.com/RX0FA/raptor-cage/releases/download/{{TAG_NAME}}/raptor-cage.tgz")
 arch=('x86_64')
 license=('CIL-1.0')
-depends=('steam-native-runtime')
+depends=('bubblewrap' 'steam-native-runtime')
 optdepends=('mangohud: vulkan overlay')
 sha256sums_x86_64=('{{SHA256SUM}}')
 
 package() {
   cd "$srcdir/"
-  install -Dm755 raptor-cage "${pkgdir}/usr/bin/raptor-cage"
+  install -Dm755 raptor-cage "${pkgdir}/usr/bin/rcage"
 }

packaging/PKGBUILD

@@ -10,6 +10,7 @@ use clap::{ArgAction, Parser};
 use std::path::PathBuf;
 
 #[derive(Debug, Parser)]
+#[command(version = env!("CARGO_PKG_VERSION"))]
 pub enum Commands {
   /// Run application sandboxed.
   #[command(arg_required_else_help = true)]