|
1 | | -# WARNING |
2 | | -a lot of people have reported they are unable to run the game at all. |
3 | | -i am looking into this and will be working on it |
4 | | -in the following days |
| 1 | +# Notice |
5 | 2 |
|
6 | | -# Changes made |
7 | | -* updated lwjgl 3.3.3 to 3.4.1 from versions 26.1 onwards |
| 3 | +many people have reported issues with using this repo. most of this started when i added moltenvk as a renderer. im not sure why this broke a lot of things but here we are. instead of just fixing the issues ive decided to rebase everything ive changed. |
8 | 4 |
|
| 5 | +this launcher was being held up with tape, it was bound to break at some point. |
| 6 | +so ill start rebasing everything and making sure it will be a functional launcher once done. |
9 | 7 |
|
10 | | -* added lwjgl 3.3.3 for versions 1.21.11 and under |
| 8 | +# releases |
11 | 9 |
|
12 | | -* updated moltenvk, and every other dylib. |
| 10 | +my releases will stll be up for people to use but I dont recommend using them. instead use either |
| 11 | +https://github.com/AngelAuraMC/Amethyst-iOS the offical amethyst repo where youll get the most stability or https://github.com/catsruledogs/Amethyst-iOS-25 if you want to use mc versions 26.1+ |
13 | 12 |
|
14 | | -* added java 25 support. |
15 | 13 |
|
16 | | -* simple voice chat working (thank you congcq for the fix) |
17 | | - |
18 | | - |
19 | | -# changes potentially coming in the future |
20 | | -* fix open gl crashing on 26.1-26.2 |
21 | | - |
22 | | -* ~~make the java 25 implementation less "hacky"~~ |
23 | | - |
24 | | -# ISSUES |
25 | | - |
26 | | -* keyboard dosent work properly |
27 | | - |
28 | | -# NOTE |
29 | | -if you do use this build and want to use the new |
30 | | -snapshots you must change the rendering backend |
31 | | -to vulkan. open gl currently crashes from 26.1-26.2 |
32 | | - |
33 | | -# Angel Aura Amethyst (iOS) |
34 | | -[](https://github.com/AngelAuraMC/Amethyst-iOS/actions/workflows/development.yml) |
35 | | -[](https://crowdin.com/project/angelauramc) |
36 | | -[](https://discord.gg/5ptqkyZxEy) |
37 | | - |
38 | | - |
39 | | - |
40 | | -## Introduction |
41 | | -Amethyst is a Minecraft: Java Edition launcher for Android, iOS, and iPadOS, based off of zhuowei's [Boardwalk](https://github.com/zhuowei/Boardwalk) project. |
42 | | -* Supports most versions of Minecraft: Java Edition, from the very first beta to the newest snapshots. |
43 | | -* Supports Forge, Fabric, OptiFine, and Quilt for you to customize the experience with supported mods. |
44 | | -* Includes customizable on-screen controls, keyboard and mouse support, and game controller support. |
45 | | -* Optimized for jailbroken and TrollStore devices to enable better capabilities. |
46 | | -* Microsoft account and demo mode support for logging into Minecraft. |
47 | | -* ...and much more! |
48 | | - |
49 | | -This repository contains the code for our iOS and iPadOS port of Amethyst. Looking for [Android?](https://github.com/AngelAuraMC/Amethyst-Android) |
50 | | - |
51 | | -## Getting started with Amethyst |
52 | | -The [Amethyst wiki](https://wiki.angelauramc.dev/wiki/getting_started/INSTALL.html#ios) has extensive documentation on how to install, set up, and play! For those who wish to install quickly, here's the basics: |
53 | | - |
54 | | -### Requirements |
55 | | -At the minimum, you'll need one of the following devices on **iOS 14.0** and later: |
56 | | -- iPhone 6s and later |
57 | | -- iPad (5th generation) and later |
58 | | -- iPad Air (2nd generation) and later |
59 | | -- iPad mini (4th generation) and later |
60 | | -- iPad Pro (all models) |
61 | | -- iPod touch (7th generation) |
62 | | - |
63 | | -However, we recommend one of the following devices on **iOS 14.0** and later: |
64 | | -- iPhone XS and later, excluding iPhone XR and iPhone SE (2nd generation) |
65 | | -- iPad (10th generation) and later |
66 | | -- iPad Air (4th generation) and later |
67 | | -- iPad mini (6th generation) and later |
68 | | -- iPad Pro (all models, except for 9.7-inch) |
69 | | - |
70 | | -Recommended devices provide a smoother and more enjoyable gameplay experience compared to other supported devices. |
71 | | -- iOS 17.x and iOS 18.x is supported. However, a computer is required. For more information, please check out [the official wiki](https://wiki.angelauramc.dev/wiki/faq/ios/JIT.html#what-are-the-methods-to-enable-jit) |
72 | | - |
73 | | -### Setting up to sideload |
74 | | -Amethyst can be sideloaded in many ways. Our recommended solution is to install [TrollStore](https://github.com/opa334/TrollStore) if your iOS version supports it. Installing with TrollStore allows you to permanently sign the application, automatically enable JIT, and increase memory limits. |
75 | | - |
76 | | -If you cannot, [AltStore](https://altstore.io) and [SideStore](https://sidestore.io) are your next best options. |
77 | | -- Signing services that do not use your UDID (and use distribution certificates) are not supported, as Amethyst requires capabilities they do not allow. However, if you do managed to gain access to a Development certificate, due to it having the necessary entitlement (being com.apple.security.get-task-allow) to attach a debugger to the running process (enabling JIT), you may use a Development certificate. |
78 | | - |
79 | | -- Only install sideloading software and Amethyst from trusted sources. We are not responsible for any harm caused by using unofficial software. |
80 | | -- Jailbreaks also benefit from permenant signing, autoJIT, and increased memory limits. However, we do not recommend them on devices intended for regular use. |
81 | | - |
82 | | -### Installing Amethyst |
83 | | -#### Release build (TrollStore) |
84 | | -1. Download an IPA of Amethyst in [Releases](https://github.com/AngelAuraMC/Amethyst-iOS/releases). |
85 | | -2. Open the package in TrollStore using the share menu. |
86 | | - |
87 | | -#### Release build (AltStore/SideStore trusted source) |
88 | | -These builds will be available soon, stay tuned. |
89 | | - |
90 | | -#### Nightly builds |
91 | | -*These builds can contain game-breaking bugs. Use with caution.* |
92 | | -1. Download an IPA build of Amethyst in the [Actions tab](https://github.com/AngelAuraMC/Amethyst-iOS/actions). |
93 | | -2. Open the downloaded IPA in your sideloading app to install. |
94 | | - |
95 | | -#### Nightly builds (AltStore/SideStore trusted sources) |
96 | | -These builds will be available soon, stay tuned. |
97 | | - |
98 | | -### Enabling JIT |
99 | | -Amethyst makes use of **just-in-time compilation**, or JIT, to provide usable speeds for the end user. JIT is not supported on iOS without the application being debugged, so workarounds are required to enable it. You can use this chart to determine the best solution for you and your setup. |
100 | | -| Application | AltStore | SideStore | StikDebug | TrollStore | Jitterbug | Jailbroken | |
101 | | -|---------------------|----------|-----------|-----------|------------|--------------------|------------| |
102 | | -| Requires ext-device | Yes | Yes (#) | Yes (#) | No | If VPN unavailable | No | |
103 | | -| Requires Wi-Fi | Yes | Yes (#) | Yes (#) | No | Yes | No | |
104 | | -| Auto enabled | Yes (*) | No | Yes | Yes | No | Yes | |
105 | | - |
106 | | -(*) AltServer running on the local network is required. |
107 | | -(#) Only the first time. |
108 | | - |
109 | | -## Contributors |
110 | | -Amethyst is amazing, and surprisingly stable, and it wouldn't be this way without the commmunity that helped and contribute to the project! Some notable names: |
111 | | - |
112 | | -@crystall1nedev - Project manager, iOS port developer |
113 | | -@khanhduytran0 - iOS port developer |
114 | | -@artdeell |
115 | | -@Mathius-Boulay |
116 | | -@zhuowei |
117 | | -@jkcoxson |
118 | | -@Diatrus |
119 | | - |
120 | | -## Third party components and their licenses |
121 | | -- [Caciocavallo](https://github.com/PojavLauncherTeam/caciocavallo): [GNU GPLv2 License](https://github.com/PojavLauncherTeam/caciocavallo/blob/master/LICENSE). |
122 | | -- [jsr305](https://code.google.com/p/jsr-305): [3-Clause BSD License](http://opensource.org/licenses/BSD-3-Clause). |
123 | | -- [Boardwalk](https://github.com/zhuowei/Boardwalk): [Apache 2.0 License](https://github.com/zhuowei/Boardwalk/blob/master/LICENSE) |
124 | | -- [GL4ES](https://github.com/ptitSeb/gl4es) by @lunixbochs @ptitSeb: [MIT License](https://github.com/ptitSeb/gl4es/blob/master/LICENSE). |
125 | | -- [Mesa 3D Graphics Library](https://gitlab.freedesktop.org/mesa/mesa): [MIT License](https://docs.mesa3d.org/license.html). |
126 | | -- [MetalANGLE](https://github.com/khanhduytran0/metalangle) by @kakashidinho and ANGLE team: [BSD 2.0 License](https://github.com/kakashidinho/metalangle/blob/master/LICENSE). |
127 | | -- [MoltenVK](https://github.com/KhronosGroup/MoltenVK): [Apache 2.0 License](https://github.com/KhronosGroup/MoltenVK/blob/master/LICENSE). |
128 | | -- [openal-soft](https://github.com/kcat/openal-soft): [LGPLv2 License](https://github.com/kcat/openal-soft/blob/master/COPYING). |
129 | | -- [Azul Zulu JDK](https://www.azul.com/downloads/?package=jdk): [GNU GPLv2 License](https://openjdk.java.net/legal/gplv2+ce.html). |
130 | | -- [LWJGL3](https://github.com/PojavLauncherTeam/lwjgl3): [BSD-3 License](https://github.com/LWJGL/lwjgl3/blob/master/LICENSE.md). |
131 | | -- [LWJGLX](https://github.com/PojavLauncherTeam/lwjglx) (LWJGL2 API compatibility layer for LWJGL3): unknown license. |
132 | | -- [DBNumberedSlider](https://github.com/khanhduytran0/DBNumberedSlider): [Apache 2.0 License](https://github.com/immago/DBNumberedSlider/blob/master/LICENSE) |
133 | | -- [fishhook](https://github.com/khanhduytran0/fishhook): [BSD-3 License](https://github.com/facebook/fishhook/blob/main/LICENSE). |
134 | | -- [shaderc](https://github.com/khanhduytran0/shaderc) (used by Vulkan rendering mods): [Apache 2.0 License](https://github.com/google/shaderc/blob/main/LICENSE). |
135 | | -- [NRFileManager](https://github.com/mozilla-mobile/firefox-ios/tree/b2f89ac40835c5988a1a3eb642982544e00f0f90/ThirdParty/NRFileManager): [MPL-2.0 License](https://www.mozilla.org/en-US/MPL/2.0) |
136 | | -- [AltKit](https://github.com/rileytestut/AltKit) |
137 | | -- [UnzipKit](https://github.com/abbeycode/UnzipKit): [BSD-2 License](https://github.com/abbeycode/UnzipKit/blob/master/LICENSE). |
138 | | -- [DyldDeNeuralyzer](https://github.com/xpn/DyldDeNeuralyzer): bypasses Library Validation for loading external runtime |
139 | | -- Thanks to [MCHeads](https://mc-heads.net) for providing Minecraft avatars. |
| 14 | +once im happy with how the rebasing has went i will make a release for it and delete all thhe previous releases. |
0 commit comments