Skip to content
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

Wslg docs #9842

Merged
merged 4 commits into from
Sep 20, 2023
Merged

Wslg docs #9842

merged 4 commits into from
Sep 20, 2023

Conversation

jimmcnulty41
Copy link
Contributor

Objective

  • WSL documentation was out-of-date and potentially misleading. The release of WSLg makes a lot of stuff easier

Solution

  • Just updating docs for now

NB

I haven't been able to get a full end-to-end GPU on WSL test going yet, but plan to update this documentation again once I have more of a grasp on that

WSL doesn't require a specific distro and could work with any distro
on this page in theory
@github-actions
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 A-Rendering Drawing game state to the screen O-Linux Specific to the Linux desktop operating system O-Windows Specific to the Windows desktop operating system and removed A-Rendering Drawing game state to the screen labels Sep 18, 2023
@IceSentry
Copy link
Contributor

This may have changed, but wslg was only available with windows 11 in the past.

Copy link
Contributor

@IceSentry IceSentry left a comment

Choose a reason for hiding this comment

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

Alright, I read the docs again. It seems they finally accepted that maybe supporting windows 10 too is a good idea. I remember originally they had no plans to do it.

@jimmcnulty41
Copy link
Contributor Author

This may have changed, but wslg was only available with windows 11 in the past.

I don't have a windows 10 instance to test on, but my understanding (from the wslg release and the wslg docs) is that it is available on up-to-date windows 10 installs

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Sep 18, 2023
@Elabajaba
Copy link
Contributor

I'd probably mention something about getting an up to date version of mesa (eg. through the kisak ppa for ubuntu) to run bevy on vulkan instead of gl (since bevy's GL targets GLES 3.0/webgl2 which is extremely limiting).

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 20, 2023
Merged via the queue into bevyengine:main with commit 038d113 Sep 20, 2023
22 checks passed
@inodentry
Copy link
Contributor

I took this opportunity to do some research and try running Bevy from WSLg myself. I have now added detailed instructions for it in Bevy Cheatbook: https://bevy-cheatbook.github.io/platforms/windows.html#running-linux-builds-using-wslg

rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# Objective

- WSL documentation was out-of-date and potentially misleading. The
release of WSLg makes a lot of stuff easier

## Solution

- Just updating docs for now

## NB
I haven't been able to get a full end-to-end GPU on WSL test going yet,
but plan to update this documentation again once I have more of a grasp
on that
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 O-Linux Specific to the Linux desktop operating system O-Windows Specific to the Windows 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