MinerSebas c9f19d8663 Cleanup of Markdown Files and add CI Checking (#1463 )

I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo.
The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md

Rules I didn't follow/fix:
* MD024/no-duplicate-heading
  * Changelog: Here Heading will always repeat.
  * Examples Readme: Platform-specific documentation should be symmetrical.
* MD025/single-title
* MD026/no-trailing-punctuation
  * Caused by the ! in "Hello, World!".
* MD033/no-inline-html
  * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much.
* ~~MD036/no-emphasis-as-heading:~~
  * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~
* ~~MD041/first-line-heading~~
  * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~

---

I also sorted the Examples in the Readme and Cargo.toml in this order/Priority:
* Topic/Folder
* Introductionary Examples
* Alphabetical Order

The explanation for each case, where it isn't Alphabetical :
* Diagnostics
  * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own.
* ECS (Entity Component System)
  * ecs_guide: The guide should be read, before diving into other Features.
* Reflection
  * reflection: Basic Explanation should be read, before more advanced Topics.
* WASM Examples
  * hello_wasm: It's "Hello, World!".

2021-02-22 04:50:05 +00:00

3.0 KiB

Raw Blame History

Installing Linux dependencies

This page lists the required dependencies to build a Bevy project on your Linux machine.

If you don't see your distro present in the list, feel free to add the instructions in this document.

Ubuntu 20.04

sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev

If you want to enable fast compiles

sudo apt-get install clang

Windows Subsystem for Linux (WSL 2)

Graphics and audio need to be configured for them to work with WSL 2 backend. Please see the ubuntu WSL documentation on how to set up graphics and audio.

Fedora 33

sudo dnf install gcc-c++ libX11-devel alsa-lib-devel systemd-devel

Arch / Manjaro

sudo pacman -S libx11 pkgconf alsa-lib

Solus

sudo eopkg install pkg-config libx11-devel g++ alsa-lib-devel

Void

sudo xbps-install -S pkgconf alsa-lib-devel libX11-devel eudev-libudev-devel

NixOS

Add a build.rs file to your project with the following:

fn main() {
    if cfg!(target_os = "linux") {
        println!("cargo:rustc-link-lib=vulkan");
    }
}

These packages provide the dependencies required to run a bevy project. They can be installed globally or via nix-shell.

nix-shell -p pkgconfig x11 xorg.libXcursor xorg.libXrandr xorg.libXi vulkan-tools lutris vulkan-headers vulkan-loader vulkan-validation-layers alsaLib

Alternatively, you can copy the following code block and create a file called shell.nix. You can now enter nix-shell just by running nix-shell.

# shell.nix

{ pkgs ? import <nixpkgs> { } }:

pkgs.mkShell {
  buildInputs = [
    pkgs.alsaLib
    pkgs.lutris
    pkgs.pkgconfig
    pkgs.vulkan-headers
    pkgs.vulkan-loader
    pkgs.vulkan-tools
    pkgs.vulkan-validation-layers
    pkgs.x11
    pkgs.xorg.libXcursor
    pkgs.xorg.libXi
    pkgs.xorg.libXrandr
  ];
}

At this point, projects should successfully compile but fail on execution. This is due to glslang_validator which, unfortunately, needs to have it's binary patched to link correctly. This is a known issue, and there are plans to remove this dependency.

find target -type f -name glslang_validator in order to find glslang_validator in target/debug/build/bevy-glsl-to-spirv-<hash>/out/glslang_validator. The directory containing glslang_validator will be referenced again, so save it for later: export OUT_DIR="$(dirname $(find target -type f -name glslang_validator))".
Running ldd $OUT_DIR/glslang_validator may show libstdc++.so.6 is not found. If all dependencies are found, then bevy should work. If not, install (globally or in nix-shell) any of the results found by nix-locate -w libstdc++.so.6. For example purposes, consider nixos.gcc-unwrapped. In theory, any of the ones in find -L /nix/store -type f -name libstdc++.so.6 will work.
patchelf --set-interpreter "$(cat $NIX_CC/nix-support/dynamic-linker)" --set-rpath /nix/store/784rh7jrfhagbkydjfrv68h9x3g4gqmk-gcc-8.3.0-lib/lib $OUT_DIR/glslang_validator
Bevy should now be working correctly!

3.0 KiB Raw Blame History