MobileGlues

Language: English | 简体中文 | 繁體中文 | 日本語

[!NOTE]

The latest version:

2.0.0

See Releases

[!NOTE]

See CompatibleShaders.md to see compatible Minecraft shaders.

See CompatibleMods.md to see compatible Minecraft mods.

See Mod Support Matrix or Shader Support Matrix to check how your device works out.

MobileGlues, which stands for "(on) Mobile, GL uses ES", is a GL implementation running on top of host OpenGL ES 3.x (best on 3.2, minimum 3.0), with running Minecraft: Java Edition in mind.

Features

1. Capable of running Minecraft Sodium mod;

2. Capable of rendering most minecraft shaders with Minecraft Iris mod or Optifine.

3. Capable of running some Minecraft mods with custom rendering routines, such as JourneyMap and Create.

4. Additional QoL features: optional ANGLE as ES driver, shader caching for fast shaderpack reloads, supports Minecraft GPU% reporting, ...and more!

For Shader Developers

1. MobileGlues automatically:

   • Converts desktop GLSL → GLSL ES
   • Removes layout(binding) syntax
   • Handles version directives
   • Always declare precision explicitly:

     precision highp float;
     precision highp int;
     

2. MobileGlues (since V1.2.6) injects these macros into your shaders:

   #define MG_MOBILEGLUES                   // Indicates MobileGlues environment
   #define MG_MOBILEGLUES_VERSION 2000      // Version number (e.g. 2000 = V2.0.0)
   

   Use these macros for platform-specific logic:

   #ifdef MG_MOBILEGLUES
       #if MG_MOBILEGLUES_VERSION >= 2000
           // Logic for MobileGlues (version >= V2.0.0)
       #else
           // Logic for MobileGlues (version < V2.0.0)
       #endif
   #else
       // ...
   #endif
   

3. If encountering issues:

   • Enable Ignore shader/program error, and check the logs (located at /sdcard/MG/latest.log).

Open Source Links

MobileGlues

MobileGlues-plugin

License

MobileGlues and its plugin application are licensed under GNU LGPL-2.1 License.

Check signature of your release

This portion is a guide to help you identify if your apk is an official release from MobileGlues dev.

In your Android build-tools, find apksigner. Then run the following command:

apksigner verify --print-certs path/to/MobileGlues-plugin.apk

It should print out:

Signer #1 certificate DN: CN=MGDev, OU=MGDev, O=MGDev, L=Unknown, ST=Unknown, C=CN
Signer #1 certificate SHA-256 digest: 324f4efaff81632373dec9bc714a904b64740249410b551b61805340e42ff5d5
Signer #1 certificate SHA-1 digest: 615bc8b2741c24e7e5847b0c5c1d6816d5b0763a
Signer #1 certificate MD5 digest: 320ede9d22c709fe3792c804d5e00153

Check whether the certificate DN and certificate digest portion matches exactly like above.

In order that you may want to check against public key file, pub.cer and pub.pem are also provided. You can use your utility as you like to check your apk against those files.

Call to Action

Since we are a small team, we cannot own every distinct device and do through tests on them.

If you are interested in this project, please consider contributing to the project by:

Filling out the mod support matrix or shader support matrix!

We need your help to test the compatibility of shaders and mods, and a broad variety of devices!

[!NOTE] How to fill out the table

You may:

• Add a new device to the table, by appending a new row to the table. (You can get device codename from adb shell getprop ro.product.name)
• Add a new item to the table, by appending a new column to the table. (Make sure you have modify all the rows to add the column!)
• Fill out the table with the compatibility of the item on the device, by marking the cell with
  • a checkmark (✅) if the item is compatible,
  • or a cross (❌) if the item is fully not compatible (and file an issue/link to the issue).
  • If the item is not tested (not included in your modpack/you do not install this mod), mark the cell with a question mark (?).
  • a asterisk (*️⃣) if the item is working, but have missing features and/or have graphical glitches (and file an issue/link to the issue).
• If applicable, you may want to mention what additional drivers/plugins rather than the one vendor provides, are in use (such as turnip drivers, ANGLE, etc.) in the "Additional Drivers/Plugins in use" column.
• If applicable, you should add a file named *device_codename*.md, to provide additional information, and put the link in the last column.

Third-party components

MobileGlues

SPIRV-Cross by KhronosGroup - Apache License 2.0: github

glslang by KhronosGroup - Various Licenses: github

cJSON by DaveGamble - MIT License: github

FidelityFX-FSR by AMD - MIT License: github

Perfetto by Google - Apache License 2.0: github

xxHash by Yann Collet - BSD 2-Clause License: github

flat_hash_map by Malte Skarupke - Boost Software License 1.0: github (a fork of skarupke/flat_hash_map, carrying a fix that lets the header be included on 32-bit targets)

MobileGlues-plugin

Miuix by compose-miuix-ui - Apache License 2.0: github

Jetpack Compose by Android Open Source Project (AOSP) - Apache License 2.0: Android Developers

AndroidX by Android Open Source Project (AOSP) - Apache License 2.0: Android Developers

kotlinx.coroutines by JetBrains - Apache License 2.0: github

Gson by Google - Apache License 2.0: github