Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NicolasGuilloux/blade-shadow-beta

Various documentation and tools for Shadow on Linux maintained by community
https://github.com/NicolasGuilloux/blade-shadow-beta

Last synced: 3 months ago
JSON representation

Various documentation and tools for Shadow on Linux maintained by community

Awesome Lists containing this project

README

        

> :warning: Since I canceled my subscription, I am no longer able to maintain this package. If somebody wants to continue the maintenance, feel free to fork or [contact me](mailto:[email protected])

# Why this?

The Shadow cloud-computing application by Blade (https://shadow.tech) is available for Ubuntu 18.04. This repository extends compatibility to additional distributions and hardwares, providing scripts and documentation. The usefulness of this repository decreases during time as Blade improves its compatibility and fixes bugs. Still, this repository provides great documentations made by the community!

A sexy website is available ans summarizes everything on this git: https://nicolasguilloux.github.io/blade-shadow-beta/

Check out our side-projects Discord: https://discord.gg/9HwHnHq

To generate a report and share your configuration in one command, please execute the following line in your terminal:
```bash
curl https://raw.githubusercontent.com/NicolasGuilloux/blade-shadow-beta/master/scripts/report.pl | perl
```

To check and install the necessary drivers, please execute the following line in your terminal:
```bash
curl https://raw.githubusercontent.com/NicolasGuilloux/blade-shadow-beta/master/scripts/check_driver.sh | bash
```

# Disclaimer

This Github is *NOT* official. It was created by regular users only to centralize scripts and reports. As this Github is not affiliated with the Blade company, no Shadow developper has to answer the issues and therefore, don't expect any quick response. The goal is to provide a support about what we know, and gather as much information as possible to help people.

That being said, there is no reason what so ever to complain about Shadow or Blade in general on this Github. This is not the place and it is not appropriate as we don't work for them. To complain about something, please use the official Discords where you will get an official response.

Moreover, we expect respect when talking to each other. We all are regular users, and we are all looking for some help or to help. To learn more about what we expect, please our [Code of Conduct](CODE_OF_CONDUCT.md).

## VA Drivers

The Shadow application requires your machine to support hardware decoding for H.264 or H.265, it will not work with software decoding. You can check whether hardware decoding is enabled by installing `vainfo` (Ubuntu, Linux Mint, Debian) or `libva-utils` (Arch, Solus) from the repository of your distribution, and then running `vainfo` in the terminal. If "H264" or "HEVC" show up in the output, you are good to go. Otherwise, you probably need drivers for VAAPI, or your hardware is outdated. Several options are available based on your GPU, please use the following documentation to enable hardware decoding on your machine:

- Debian based: https://doc.ubuntu-fr.org/vaapi
- Arch Linux: https://wiki.archlinux.org/index.php/Hardware_video_acceleration#Installing_VA-API

#### For most cases:

If your active GPU is an Intel chipset and you have no dedicated GPU, you will need the i965 Intel driver.
- Ubuntu: `sudo apt install i965-va-driver`
- Arch Linx: `sudo pacman -S libva-intel-driver`
- Solus: `sudo eopkg it libva-intel-driver`
- Fedora: `sudo dnf install libva-intel-hybrid-driver`

For NVIDIA users, you have 2 options:
- Use the Nouveau driver and install the old [NVIDIA firmware](https://aur.archlinux.org/packages/nouveau-fw) that provides support for the VA API.
- Use the [Arekinath patch](https://gitlab.com/aar642/libva-vdpau-driver) to provides VA API compatibility for recent NVIDIA cards.

In both cases, we strongly recommend you to follow this link: https://gitlab.com/aar642/shadowos-boot#support

#### For other cases:

If you still experience issues, more information are available on the [website](https://nicolasguilloux.github.io/blade-shadow-beta/#vainfo). Moreover, contact the Linux community on the [Discord](https://discord.gg/shadowtech) to get some help.

## AppImage

Shadow built an AppImage that should work on most recent distributions (> 2017). If you find any bug, please report it on the Discord or [create an issue](https://github.com/NicolasGuilloux/blade-shadow-beta/issues/new).

The AppImage embeds Ubuntu Bionic (18.04) libs and the official Shadow Beta application. However, it still requires a **working libVA** on your system and a **compatible GLIBC**.

To use the AppImage, [download the AppImage](https://nicolasguilloux.github.io/blade-shadow-beta/#appimage) to the folder you want, make it executable with `chmod a+x Shadow*.AppImage` and run it.

## The AUR package

The AUR package [shadow-beta](https://aur.archlinux.org/packages/shadow-beta/) available for all Arch Linux based distribution was initially created by **agentcobra#6142** and now also maintained by **Nover#9563**. It is a quick way to install Shadow on the machine and get the updates frequently with the system updates.

To build it locally, download the git files from the AUR website and build the package by executing `makepkg`.

## NixOS

**Elyhaka** built a NixOS package for Shadow. [Check out his repository](https://github.com/Elyhaka/shadow-nix).

# Other configuration

### Fedora

Make sure you installed `librtmp` from RMP Fusion. Checkout the issue [#49](https://github.com/NicolasGuilloux/blade-shadow-beta/issues/49).

# Issues

Check out the [known issues](https://nicolasguilloux.github.io/blade-shadow-beta/issues.html) or dig into the [Github issues page](https://github.com/NicolasGuilloux/blade-shadow-beta/issues) to solve it. If it is unsolved, create a new one!

# Acknowledgments

Thanks to **Alex^#1629** on Discord for being available every time somebody needs to kill a bug. Thanks a lot for the wonderful AppImage!

Thanks to **agentcobra#6142** on Discord for maintaining the AUR package and review my code. Many mistakes were corrected by you.

Thanks to **0x4cc3a96f#4425** for "mastering" Linux. We greatly appreciate all you help and efforts to make the Linux app better and better.

Thanks to **Ely#5135** who built the NixOS package and helped me a lot with the LiveOS.

Thanks to **raphco#0312** on Discord for being the guinea pig for Arch.

Thanks to **PofMagicfingers** for the corrections on the Arch scripts.

Thanks to **kabouik#7008** for relentlessly bothering us to add support for Solus.

Thanks to **TheWolf#0985** and **Brother/Ilya#0013** for their help with the german translations.

You can talk to us on the [French Shadow Discord](https://discord.gg/shadowtech). We are also available on all other Discord but please, speak English so we can understand you ;)

# Miscalleneous

### Community projects

- [Shadow Live OS](https://gitlab.com/NicolasGuilloux/shadow-live-os): A live Linux that start Shadow and all needed components, ready out of the box !
- [ShadowOS Networked boot](https://gitlab.com/aar642/shadowos-boot): A small ISO (~1Mo) that use iPXE to boot the Shadow Live OS using network.
- [Shadow Gaming](https://discord.gg/5yhkeV5): A discord to share the configuration of the game and discuss about benchmark.

### Support

If you want to support us, rather than make donations, we prefer to use the referral program for Shadow. As we are some people behind this git, you can choose the code you will use.

| Pseudo | Referral code | Link |
| :- | :-: | :- |
| GiantPandaRoux | `JLRYV` | https://shop.shadow.tech/invite/JLRYV |
| AgentCobra | `4LKBA` | https://show.shadow.tech/invite/4LKBA |
| Nover | `NICNC9DP` | https://shop.shadow.tech/invite/NICNC9DP |
| Elyhaka | `JRMIXPEY` | https://shop.shadow.tech/invite/JRMIXPEY |