Skip to content

Commit

Permalink
Fix a few minor wording details
Browse files Browse the repository at this point in the history
  • Loading branch information
CoolCat467 authored May 5, 2024
1 parent 82c02e2 commit f189406
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# fix-lwjgl
Fix LWJGL (Light Weight Java Game Library) version used in Minecraft for ARM devices
Fix which LWJGL (Light Weight Java Game Library) version is used in Minecraft for ARM devices

<!-- BADGIE TIME -->

Expand Down Expand Up @@ -39,39 +39,38 @@ tell me using [the discussions page](https://github.com/CoolCat467/fix-lwjgl/dis
Ensure Python 3 is installed on your computer, and use pip to
install this project with the command listed below:

```bash
```
pip install git+https://github.com/CoolCat467/fix-lwjgl.git
```

#### Installation on MacOS
If you are using MacOS will probably have to install [homebrew](https://brew.sh/) and
use homebrew to install [pipx](https://pipx.pypa.io/latest/installation/)
If you are using MacOS, you will probably have to install [homebrew](https://brew.sh/) to install [pipx](https://pipx.pypa.io/latest/installation/)
(use the links given, not copying their install instructions here because they will get out of date).

After pipx is installed, you can use the following command to install:

```bash
```
pipx install git+https://github.com/CoolCat467/fix-lwjgl.git
```

## About Installation
On default, all LWJGL files are expected to be in
`$HOME/.local/share/fix_lwjgl/lwjgl_{lwjgl_version}{system_arch}`, so
if the script was run on Raspberry Pi OS 32 bit, it would be `lwjgl_3arm32`. If this
folder does not exist or files are missing (only checks in lwjgl 3 mode), the folder
folder does not exist or files are missing (only checks in LWJGL 3 mode), the folder
is created and all required files are downloaded from https://build.lwjgl.org/
(browse at https://www.lwjgl.org/browse)
(browse at https://www.lwjgl.org/browse) (see also `can_download` in configuration)

If this script needs the LWJGL 2 folder, it will download the folders in this repository.
If this script needs any LWJGL 3 modules, it will download them from LWJGL's build repository
available to browse at https://www.lwjgl.org/browse

## Configuration
All configuration files should be located in `~/.config/fix_lwjgl/`. The current options
All configuration files should be located in `~/.config/fix_lwjgl/fix_lwjgl_config.ini`. The current options
as of writing include:
- `lwjgl_base_path` - Changing where the lwjgl folders are expected to live at (defaults to `$HOME/.local/share/fix_lwjgl`)
- `lwjgl_base_path` - Controls where the lwjgl folders are expected to live at (defaults to `$HOME/.local/share/fix_lwjgl`)
- `can_download` - If the wrapper is allowed to download files from the internet (defaults to True)
- `download_timeout` - Timeout in seconds for downloading files from the internet
- `download_timeout` - Timeout in seconds for downloading files from the internet (defaults to 15 seconds)

## Usage
Go to your Minecraft launcher, and somewhere in settings is likely the ability to
Expand All @@ -88,8 +87,8 @@ export MESA_GL_VERSION_OVERRIDE=4.2COMPAT
This tells mesa gl to pretend it's OpenGL 4.2, which stops Minecraft from trying to do
some things that might cause crashes.

You might also want to try using `4.3` or `4.5`, this is known to fix the
[`Could not initialize class com.mojang.blaze3d.systems.RenderSystem` issue](https://github.com/CoolCat467/fix-lwjgl/issues/30)
You might also want to try changing it from `4.2COMPAT` to `4.3` or `4.5`, this is known to fix the
["Could not initialize class com.mojang.blaze3d.systems.RenderSystem" issue](https://github.com/CoolCat467/fix-lwjgl/issues/30)

## Problems
If you encounter any issues regarding this program, please check and see if anyone else is
Expand All @@ -98,7 +97,7 @@ When posting your issue, be sure to include any relevant logs and what operating
you're using and what architecture your computer's processor uses.

Additionally, re-running Minecraft with the additional arguments
```bash
```
-Dorg.lwjgl.util.DebugLoader=true -Dorg.lwjgl.util.Debug=true
```
might help diagnose your issue. Just be sure to remove them after everything is
Expand Down

0 comments on commit f189406

Please sign in to comment.