Skip to content

Update linux dependency documentation for NixOS (and nix) #16881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 29, 2024

Conversation

to-bak
Copy link
Contributor

@to-bak to-bak commented Dec 18, 2024

Objective

  • Updates the linux-dependencies docs to 1) fix problems with nix alsa-lib, and 2) include additional documentation to run bevy with nix on non NixOS systems. (nix is a package manager that can be run outside of NixOS).

Solution

  1. the nix alsa-lib package doesn't include alsa-plugins, which bevy depends on. Instead, use the alsa-lib-with-plugins package, which wraps alsa-plugins into alsa-lib. For more information see: alsa-lib: provide wrapper for run-time access to plugins NixOS/nixpkgs#277180
  2. using nix on non NixOS systems, software like nixGL is required to correctly link graphics drivers.

Testing

  • Tested on ubuntu 22.04 with nix.

Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation O-Linux Specific to the Linux desktop operating system S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Dec 18, 2024
@mockersf
Copy link
Member

nixGL seems to be a wrapper for OpenGL, but also contains nixVulkan which wraps Vulkan. Could you mention it first instead of running with nixGL?

Copy link
Contributor

@NthTensor NthTensor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't speak to the change, as I'm on NixOS and these instructions are for using the nix package manager on other operating systems. But seems to be correct.

@to-bak
Copy link
Contributor Author

to-bak commented Dec 19, 2024

nixGL seems to be a wrapper for OpenGL, but also contains nixVulkan which wraps Vulkan. Could you mention it first instead of running with nixGL?

I updated the documentation to make this more clear. Please have another look

@BenjaminBrienen BenjaminBrienen added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it D-Straightforward Simple bug fixes and API improvements, docs, test and examples and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Dec 25, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Dec 29, 2024
Merged via the queue into bevyengine:main with commit 3136710 Dec 29, 2024
28 checks passed
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Jan 6, 2025
…#16881)

# Objective
- Updates the linux-dependencies docs to 1) fix problems with nix
`alsa-lib`, and 2) include additional documentation to run bevy with nix
on non NixOS systems. (nix is a package manager that can be run outside
of NixOS).

## Solution
1. the nix `alsa-lib` package doesn't include `alsa-plugins`, which bevy
depends on. Instead, use the `alsa-lib-with-plugins` package, which
wraps `alsa-plugins` into `alsa-lib`. For more information see:
NixOS/nixpkgs#277180
2. using nix on non NixOS systems, software like `nixGL` is required to
correctly link graphics drivers.

## Testing
- Tested on ubuntu 22.04 with nix.
mrchantey pushed a commit to mrchantey/bevy that referenced this pull request Feb 4, 2025
…#16881)

# Objective
- Updates the linux-dependencies docs to 1) fix problems with nix
`alsa-lib`, and 2) include additional documentation to run bevy with nix
on non NixOS systems. (nix is a package manager that can be run outside
of NixOS).

## Solution
1. the nix `alsa-lib` package doesn't include `alsa-plugins`, which bevy
depends on. Instead, use the `alsa-lib-with-plugins` package, which
wraps `alsa-plugins` into `alsa-lib`. For more information see:
NixOS/nixpkgs#277180
2. using nix on non NixOS systems, software like `nixGL` is required to
correctly link graphics drivers.

## Testing
- Tested on ubuntu 22.04 with nix.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples O-Linux Specific to the Linux desktop operating system S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants