Amethyst (Minecraft Java)

<h1 align="center">Angel Aura Amethyst</h1> <img src="https://github.com/AngelAuraMC/Amethyst-Android/blob/v3_openjdk/app_pojavlauncher/src/main/assets/amethyst.png" align="left" width="130" height="130" alt="Amethyst logo">

From Boardwalk's ashes and PojavLauncher's ruined reputation, here comes Amethyst!

Amethyst is a launcher that allows you to play Minecraft: Java Edition on your Android and iOS devices.

For more details, check out our wiki!

Table of Contents

• Introduction
• Getting Amethyst
• Building
  • Quick Build (Recommended)
  • Detailed Build
• Current Status
• Known Issues
• FAQ
• Contributing
• Support
• License
• Credits & Dependencies
• Roadmap

Introduction

• Amethyst is a Minecraft: Java Edition launcher for Android and iOS based on Boardwalk and PojavLauncher
• This launcher can launch almost all available Minecraft versions ranging from rd-132211 to 26.3-snapshot-1.
• Modding via Forge and Fabric are also supported.
• This repository contains source code for Android. For iOS/iPadOS, check out Amethyst-iOS.

Getting Amethyst

You can get Amethyst via two methods:

1. Releases: Download the latest prebuilt app from nightly.link or select an older version from our automatic builds.
2. Build from Source: Follow the building instructions below.

Building

Quick Build (Recommended)

The easiest way to build Amethyst is to use the pre-built JREs provided by our CI.

1. Clone the repository: git clone --recursive https://github.com/AngelAuraMC/Amethyst-Android.git
2. Build the launcher: ./gradlew :app_pojavlauncher:assembleDebug (Use gradlew.bat on Windows)

The built APK will be located in app_pojavlauncher/build/outputs/apk/debug/.

Detailed Build

If you need more control over the build process, follow these steps:

1. Java Runtime Environment (JRE): Download the jre8-pojav artifact from our CI auto builds. This package contains pre-built JREs for all supported architectures. If you need to build the JRE yourself, follow the instructions in the android-openjdk-build-multiarch repository.

2. LWJGL: The build instructions for the custom LWJGL are available over the LWJGL repository.

3. Language List: Because languages are auto-added by Crowdin, you need to run the language list generator before building. In the project directory, run:

   • Linux/macOS:

     chmod +x scripts/languagelist_updater.sh
     bash scripts/languagelist_updater.sh
     

   • Windows:

     scripts\languagelist_updater.bat
     

4. Build GLFW stub: ./gradlew :jre_lwjgl3glfw:build

5. Build the launcher: ./gradlew :app_pojavlauncher:assembleDebug (Replace gradlew with gradlew.bat on Windows).

Current Status

• OpenJDK 8 Mobile port: ARM32, ARM64, x86, x86_64
• OpenJDK 17 Mobile port: ARM32, ARM64, x86, x86_64
• OpenJDK 21 Mobile port: ARM32, ARM64, x86, x86_64
• Headless mod installer
• Mod installer with GUI
• OpenGL in OpenJDK environment
• OpenAL (works on most devices)
• Support for Minecraft 1.12.2 and below
• Support for Minecraft 1.13 and above
• Support for Minecraft 1.17 (22w13a) and above
• Game surface zooming
• New input pipe rewritten to native code
• Rewritten entire controls system
• More to come!

Known Issues

See our issue tracker for a list of known issues and their current status.

FAQ

See our wiki for more information.

Contributing

Contributions are welcome! We welcome any type of contribution, not only code. For example, you can help improve the wiki, contribute to the translations, or submit bug reports and feature requests.

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it.

Support

For support, please join our Discord server.

License

Amethyst is licensed under GNU LGPLv3.

Credits & Dependencies

• Boardwalk (JVM Launcher): Unknown License/Apache License 2.0 or GNU GPLv2.
• PojavLauncher: GLGPL
• Android Support Libraries: Apache License 2.0.
• GL4ES: MIT License.
• MobileGlues: LGPL-2.1 License.
• Krypton Wrapper: MIT License
• ANGLE: All Rights Reserved.
• OpenJDK: GNU GPLv2 License.
• LWJGL3: BSD-3 License.
• LWJGLX (LWJGL2 API compatibility layer for LWJGL3): unknown license.
• Mesa 3D Graphics Library: MIT License.
• bhook (Used for exit code trapping): MIT license.
• libepoxy: MIT License.
• virglrenderer: MIT License.
• OpenAL-Soft: GNU GPLv2
  • oboe: Apache License 2.0.
  • pfffft: ARR
• SDL3: zlib License
• sdl2-compat: zlib License
• Thanks to MCHeads for providing Minecraft avatars.

Roadmap

We are currently focusing on:

• Exploring new rendering technologies.

Future plans include:

• Improving stability and performance.
• Enhancing the mod installation experience.

We welcome community feedback and suggestions for our roadmap. Please feel free to open a feature request in our issue tracker.