Files
PojavLauncher_iOS/README.md
T
Duy Tran Khanh 719ad7e2f0 Update README.md
Change Discord invite link to #general-ios
2021-09-12 08:30:29 +07:00

77 lines
5.3 KiB
Markdown

# PojavLauncher
![iOS build](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/workflows/iOS%20build/badge.svg)
[![Discord](https://img.shields.io/discord/724163890803638273.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/x5pxnANzbX)
[![Reddit](https://img.shields.io/badge/dynamic/json.svg?label=r/PojavLauncher%20member%20count&query=$.data.subscribers&url=https://www.reddit.com/r/PojavLauncher/about.json)](https://reddit.com/r/PojavLauncher)
## Note
- The official Twitter for PojavLauncher is [@PLaunchTeam](https://twitter.com/PLaunchTeam). Any others (most notably @PojavLauncher) are fake, please report them to Twitter's moderation team.
## Introduction
PojavLauncher is a Minecraft: Java Edition launcher for Android and iOS based on [Boardwalk](https://github.com/zhuowei/Boardwalk). This launcher can launch most of available Minecraft versions (from 1.6.1 to 21w08b (1.17) snapshot, including Combat Test versions). 1.17 support is available with our current workaround described [here](https://pojavlauncherteam.github.io/updates/117). Modding via Forge (1.16.x only) and Fabric are also supported. Older versions of Forge and Fabric can be used with OpenJDK 8. This repository contains source code for iOS/iPadOS platform. For Android platform, check out [PojavLauncher repository](https://github.com/PojavLauncherTeam/PojavLauncher).
This launcher is available on the Procursus repo, thanks to [@Diatrus](https://twitter.com/Diatrus), and Doregon's Repository, thanks to [@Doregon](https://twitter.com/AdamTunnic)
## Getting started with PojavLauncher
The [PojavLauncher Website](https://pojavlauncherteam.github.io) has extensive documentation on how to install, set up, and play! For those who wish to install quickly, here's the basics (on iOS 12 or later):
### Procursus-bootstraps
If you have Chimera, Taurine, Odyssey, or another jailbreak that comes with **libhooker**, this one's for you.
1. Search for `pojavlauncher` with your favorite package manager.
2. Install `PojavLauncher iOS`.
### Bingner/Elucubratus bootstraps
If you have unc0ver, checkra1n, or another jailbreak that comes with **Cydia Substrate** or **Substitute**, this one's for you. You can also use this if you have a libhooker jailbreak.
1. Add `https://apt.doregon.gq` to your sources list.
2. Search for `pojavlauncher` with your favorite package manager.
3. Install the package you wish to have, according to your preference:
* `pojavlauncher` is the stable build. This one gets updated with new releases or tags on this repository, or when Procursus updated their copy.
* `pojavlauncher-dev` is the latest commit on the `main` branch of this repository. It may have application breaking bugs, but also has more features.
## Known issues
* Minecraft 1.12.2 and below are very buggy: you can't type text, random crashes, etc...
* When using certain versions, the camera may jump to a random position when you start to touch the screen.
* Some Forge versions may fail with `java.lang.reflect.InvocationTargetException`.
* The game will be prone to JetsamEvents.
## Work in progress
* Custom controls
* OpenJDK 8 iOS port
## Contributors
PojavLauncher is amazing, and surprisingly stable, and it wouldn't be this way without the following people that helped and contribute to the project!
@khanhduytran0 - Lead iOS port developer
@artdeell - Lead developer
@LegacyGamerHD - Lead developer
@zhouwei - Original Boardwalk code
@Doregon - PojavLauncher hosting on Doregon's Repository, iOS port developer
@Mathius-Boulay - Developer
@Diatrus - PojavLauncher hosting on Procursus
@Syjalo
@pedrosouzabrasil
@notfoundname
@buzybox11
@RealEthanPlayzDev
@HongyiMC
@thecoder08
@genericrandom64
## Third party components and their licenses
- [Caciocavallo](https://github.com/PojavLauncherTeam/caciocavallo): [GNU GPLv2 License](https://github.com/PojavLauncherTeam/caciocavallo/blob/master/LICENSE).
- [jsr305](https://code.google.com/p/jsr-305): [3-Clause BSD License](http://opensource.org/licenses/BSD-3-Clause).
- [org.json](https://github.com/stleary/JSON-java): [The JSON License](https://www.json.org/license.html).
- [Boardwalk](https://github.com/zhuowei/Boardwalk): [Apache 2.0 License](https://github.com/zhuowei/Boardwalk/blob/master/LICENSE)
- [GL4ES](https://github.com/ptitSeb/gl4es) by @lunixbochs @ptitSeb: [MIT License](https://github.com/ptitSeb/gl4es/blob/master/LICENSE).
- [MetalANGLE](https://github.com/kakashidinho/metalangle) by @kakashidinho and ANGLE team: [BSD 2.0 License](https://github.com/kakashidinho/metalangle/blob/master/LICENSE).
- [OpenJDK 16](https://www.ios-repo-updates.com/repository/procursus/package/openjdk-16-jre) ported to iOS by @Diatrus: [GNU GPLv2 License](https://openjdk.java.net/legal/gplv2+ce.html).
- [LWJGL3](https://github.com/PojavLauncherTeam/lwjgl3): [BSD-3 License](https://github.com/LWJGL/lwjgl3/blob/master/LICENSE.md).
- [LWJGLX](https://github.com/PojavLauncherTeam/lwjglx) (LWJGL2 API compatibility layer for LWJGL3): unknown license.
- [DBNumberedSlider](https://github.com/immago/DBNumberedSlider): [Apache 2.0 License](https://github.com/immago/DBNumberedSlider/blob/master/LICENSE)
- [fishhook](https://github.com/facebook/fishhook) (jailed environment usage only): [BSD-3 License](https://github.com/facebook/fishhook/blob/main/LICENSE).
<!-- Ava was here -->