Installation – CyberEther Docs

CyberEther is currently installed by building from source. Follow the instructions below to compile it on your system. More installation methods are coming soon.

Build From Source

CyberEther requires a C++20 compiler (GCC 11+ or Clang 14+), Meson, and Ninja.

Dependencies

Linux (Arch Linux)

Core dependencies.

BASH

pacman -S git base-devel cmake pkg-config ninja meson git zenity

Graphical dependencies for X11-based display servers.

BASH

pacman -S glslang glfw-x11
yay -S spirv-cross

Graphical dependencies for Wayland-based display servers.

BASH

pacman -S glslang glfw-wayland
yay -S spirv-cross

Vulkan backend dependencies.

BASH

pacman -S vulkan-icd-loader vulkan-validation-layers

Optional

SoapySDR block with RTL-SDR support.

BASH

pacman -S soapysdr soapyrtlsdr

Remote capabilities.

BASH

pacman -S gstreamer gst-plugins-base gst-libav
pacman -S gst-plugins-good gst-plugins-bad gst-plugins-ugly

Examples metadata.

BASH

pacman -S python-yaml

Linux (Ubuntu 22.04)

Core dependencies.

BASH

apt install git build-essential cmake pkg-config ninja-build meson git zenity

Graphical dependencies.

BASH

apt install spirv-cross glslang-tools libglfw3-dev

Vulkan backend dependencies.

BASH

apt install mesa-vulkan-drivers libvulkan-dev vulkan-validationlayers

Optional

SoapySDR block with RTL-SDR support.

BASH

apt install libsoapysdr-dev soapysdr-module-rtlsdr

Remote capabilities.

BASH

apt install libgstreamer1.0-dev gstreamer1.0-libav \
            gstreamer1.0-plugins-base libgstreamer-plugins-bad1.0-dev \
            libgstreamer-plugins-base1.0-dev libgstreamer-plugins-good1.0-dev \
            gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly

Examples metadata.

BASH

apt install python3-yaml

macOS 13+ (Apple Silicon)

This assumes Homebrew is installed. Older versions of macOS might work but installing a newer Clang compiler (14+) will be necessary. Metal on Intel-based Macs is not supported by CyberEther. As a workaround, make sure to install the optional Vulkan dependencies listed below.

Core dependencies.

BASH

brew install cmake pkg-config ninja meson

Graphical dependencies.

BASH

brew install spirv-cross glslang glfw

Optional

SoapySDR block with RTL-SDR support.

BASH

brew install soapysdr soapyrtlsdr

Remote capabilities.

BASH

brew install gstreamer

Examples metadata.

BASH

python -m pip install PyYAML

Vulkan backend (required for Intel-based Macs).

BASH

brew install molten-vk vulkan-tools vulkan-headers

Browser (Chrome)

All CyberEther runtime dependencies for the browser are included in the repository. You only need to make sure you have Python 3, Emscripten, and Rust Cargo installed.

iOS (iPhone & iPad)

All CyberEther dependencies for iOS are included in the repository. You only need to make sure you have the latest Xcode installed.

Clone

Clone the repository from GitHub.

BASH

git clone --recursive https://github.com/luigifcruz/CyberEther.git
cd CyberEther

Build & Install

Linux or macOS

Build and install.

BASH

meson setup -Dbuildtype=debugoptimized build && cd build
ninja install

Done! The executable will be installed in the default terminal path. For usage instructions, run cyberether --help.

Browser (Chrome)

Build project with cross-compilation to WebAssembly.

BASH

meson setup --cross-file meson/crosscompile/emscripten.ini \
            -Dbuildtype=debugoptimized build-browser && \
            cd build-browser
ninja

Copy dependencies to the build directory.

BASH

cp ../resources/web/cyberether.html .
cp ../resources/images/cyberether.png .

Start the web server and navigate to http://localhost:8000/cyberether.html.

BASH

python ../resources/web/local_server.py

iOS (iPhone & iPad)

Build the project with cross-compilation to iOS and install binaries in the Xcode project.

BASH

meson setup --cross-file meson/crosscompile/ios.ini \
            --prefix $(pwd)/apps/ios/CyberEtherMobile/Library \
            -Dbuildtype=debugoptimized build-ios && \
            cd build-ios
ninja install

After the build is complete, open the Xcode project in apps/ios/ and run it on your device.