Skip to content
This repository was archived by the owner on Sep 23, 2025. It is now read-only.

Commit 7c9c076

Browse files
iscordianDev1ss0crystall1nedev
authored
Update README.md (#6590)
* Update README.md * Update README.md * Crystall1nedev's changes #1 * Small tweaks --------- Co-authored-by: Dev1ss0 <94245667+Dev1ss0@users.noreply.github.com> Co-authored-by: Eva Isabella Luna <me@crystall1ne.dev>
1 parent a6f3fc0 commit 7c9c076

File tree

1 file changed

+127
-110
lines changed

1 file changed

+127
-110
lines changed

‎README.md‎

Lines changed: 127 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,152 @@
1-
<H1 align="center">PojavLauncher</H1>
1+
<h1 align="center">PojavLauncher</h1>
22

33
<img src="https://github.com/PojavLauncherTeam/PojavLauncher/blob/v3_openjdk/app_pojavlauncher/src/main/assets/pojavlauncher.png" align="left" width="130" height="150" alt="PojavLauncher logo">
44

55
[![Android CI](https://github.com/PojavLauncherTeam/PojavLauncher/workflows/Android%20CI/badge.svg)](https://github.com/PojavLauncherTeam/PojavLauncher/actions)
66
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/PojavLauncherTeam/PojavLauncher)](https://github.com/PojavLauncherTeam/PojavLauncher/actions)
77
[![Crowdin](https://badges.crowdin.net/pojavlauncher/localized.svg)](https://crowdin.com/project/pojavlauncher)
8-
[![Discord](https://img.shields.io/discord/724163890803638273.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/invite/aenk3EUvER)
8+
[![Discord](https://img.shields.io/discord/724163890803638273.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/invite/aenk3EUvER)
99
[![Twitter Follow](https://img.shields.io/twitter/follow/plaunchteam?color=blue&style=flat-square)](https://twitter.com/PLaunchTeam)
1010

11-
* From [Boardwalk](https://github.com/zhuowei/Boardwalk)'s ashes here comes PojavLauncher!
11+
*From [Boardwalk](https://github.com/zhuowei/Boardwalk)'s ashes here comes PojavLauncher!*
1212

13-
* PojavLauncher is a launcher that allows you to play Minecraft: Java Edition on your Android device!
13+
PojavLauncher is a launcher that allows you to play Minecraft: Java Edition on your Android and [iOS](https://github.com/PojavLauncherTeam/PojavLauncher_iOS) devices.
1414

15-
* It can run almost every version of Minecraft, allowing you to use .jar only installers to install modloaders such as [Forge](https://files.minecraftforge.net/) and [Fabric](http://fabricmc.net/), mods like [OptiFine](https://optifine.net) and [LabyMod](https://www.labymod.net/en), as well as hack clients like [Wurst](https://www.wurstclient.net/), and much more!
15+
For more details, check out our [wiki](https://pojavlauncher.app/)!
1616

17-
* For more details [check out our wiki](https://pojavlauncherteam.github.io/)
18-
## Some notes to start with
19-
- We do not have an official TikTok account. No one from the dev team makes TikTok videos.
20-
- The official Twitter for PojavLauncher is [@PLaunchTeam](https://twitter.com/PLaunchTeam). Any others (most notably @PojavLauncher) are fake.
17+
## Important Notes
2118

22-
## Navigation
23-
- [Introduction](#introduction)
24-
- [Getting PojavLauncher](#getting-pojavlauncher)
25-
- [Building](#building)
26-
- [Current status](#current-status)
27-
- [License](#license)
28-
- [Contributing](#contributing)
29-
- [Credits & Third party components and their licenses](#credits--third-party-components-and-their-licenses-if-available)
19+
* We do not have an official TikTok account. No one from the dev team makes TikTok videos.
20+
* The official Twitter for PojavLauncher is [@PLaunchTeam](https://twitter.com/PLaunchTeam). Any others (most notably @PojavLauncher) are fake.
3021

31-
## Introduction
32-
* PojavLauncher is a Minecraft: Java Edition launcher for Android and iOS based on [Boardwalk](https://github.com/zhuowei/Boardwalk).
33-
* This launcher can launch almost all available Minecraft versions ranging from rd-132211 to 1.21 snapshots (including Combat Test versions).
34-
* Modding via Forge and Fabric are also supported.
35-
* This repository contains source code for Android.
36-
* For iOS/iPadOS, check out [PojavLauncher_iOS](https://github.com/PojavLauncherTeam/PojavLauncher_iOS).
22+
## Table of Contents
23+
24+
* [Introduction](#introduction)
25+
* [Getting PojavLauncher](#getting-pojavlauncher)
26+
* [Building](#building)
27+
* [Quick Build (Recommended)](#quick-build-recommended)
28+
* [Detailed Build](#detailed-build)
29+
* [Current Status](#current-status)
30+
* [Known Issues](#known-issues)
31+
* [FAQ](#faq)
32+
* [Contributing](#contributing)
33+
* [Support](#support)
34+
* [License](#license)
35+
* [Credits & Dependencies](#credits--dependencies)
36+
* [Roadmap](#roadmap)
37+
38+
## Introduction
39+
40+
* PojavLauncher is a Minecraft: Java Edition launcher for Android and iOS based on [Boardwalk](https://github.com/zhuowei/Boardwalk)
41+
* This launcher can launch almost all available Minecraft versions ranging from rd-132211 to 1.21 snapshots (including Combat Test versions)
42+
* Modding via Forge and Fabric are also supported.
43+
* This repository contains source code for Android. For iOS/iPadOS, check out [PojavLauncher_iOS](https://github.com/PojavLauncherTeam/PojavLauncher_iOS).
3744

3845
## Getting PojavLauncher
3946

4047
You can get PojavLauncher via three methods:
4148

42-
1. You can get the prebuilt app from [stable releases](https://github.com/PojavLauncherTeam/PojavLauncher/releases) or [automatic builds](https://github.com/PojavLauncherTeam/PojavLauncher/actions).
49+
1. **Releases:** Download the prebuilt app from our [stable releases](https://github.com/PojavLauncherTeam/PojavLauncher/releases) or [automatic builds](https://github.com/PojavLauncherTeam/PojavLauncher/actions).
50+
2. **Google Play:** Get it from Google Play by clicking on this badge: [![Google Play](https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png)](https://play.google.com/store/apps/details?id=net.kdt.pojavlaunch)
51+
3. **Build from Source:** Follow the [building instructions](#building) below.
4352

44-
2. You can get it from Google Play by clicking on this badge:
45-
[![Google Play](https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png)](https://play.google.com/store/apps/details?id=net.kdt.pojavlaunch)
46-
47-
3. You can [build](#building) from source.
4853
## Building
49-
If you want to build from source code, follow the steps below.
50-
### Java Runtime Environment (JRE)
51-
- JRE for Android is [here](https://github.com/PojavLauncherTeam/openjdk-multiarch-jdk8u), and the build script is [here](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch).
52-
- Follow build instruction on build script [README.md](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/blob/buildjre8/README.md).
53-
- You can also get [CI auto builds](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/actions) if you are lazy or are failing to build it for some reason.
54-
* Either get the `jre8-pojav` artifact from auto builds, or split all artifacts by yourself:</br>
55-
- Get JREs for all of 4 supported architectures (arm, arm64, x86, x86_64) </br>
56-
- Split JRE into parts:</br>
57-
Platform-independent: .jar files, libraries, configs, etc...</br>
58-
Platform-dependent: .so files, etc...</br>
59-
- Create:</br>
60-
A file named `universal.tar.xz` with all platform-independent files</br>
61-
4 files named `bin-<arch>.tar.xz` with all platform-dependent files per-architecture</br>
62-
- Put these in the `assets/components/jre/` folder</br>
63-
- (If needed) update the Version file with the current date</br>
64-
65-
### LWJGL
66-
The build instructions for the custom LWJGL are available over the [LWJGL repository](https://github.com/PojavLauncherTeam/lwjgl3)
67-
68-
### The Launcher
69-
- Because languages are auto-added by Crowdin, you need to run the language list generator before building. In the project directory, run:
70-
71-
* On Linux, Mac OS:
72-
```
73-
chmod +x scripts/languagelist_updater.sh
74-
bash scripts/languagelist_updater.sh
75-
```
76-
* On Windows:
77-
```
78-
scripts\languagelist_updater.bat
79-
```
80-
Then, run these commands ~~or build using Android Studio~~.
81-
82-
* Build GLFW stub:
83-
```
84-
./gradlew :jre_lwjgl3glfw:build
85-
```
86-
* Build the launcher
87-
```
88-
./gradlew :app_pojavlauncher:assembleDebug
89-
```
90-
(Replace `gradlew` with `gradlew.bat` if you are building on Windows).
91-
92-
## Current status
93-
- [x] ~~OpenJDK 9 Mobile port: ARM32, ARM64, x86, x86_64.~~ Replaced by JRE8.
94-
- [x] OpenJDK 8 Mobile port: ARM32, ARM64, x86, x86_64
95-
- [x] OpenJDK 17 Mobile port: ARM32, ARM64, x86, x86_64
96-
- [x] Headless mod installer
97-
- [x] Mod installer with GUI. Used `Caciocavallo` project for AWT without X11.
98-
- [x] OpenGL in OpenJDK environment
99-
- [x] OpenAL (works on most devices)
100-
- [x] Support for Minecraft 1.12.2 and below. Used [lwjglx](https://github.com/PojavLauncherTeam/lwjglx), a LWJGL2 compatibility layer for LWJGL3.
101-
- [x] Support for Minecraft 1.13 and above. Used [GLFW stub](https://github.com/PojavLauncherTeam/lwjgl3-glfw-java).
102-
- [x] Support for Minecraft 1.17 (22w13a to be exact) and above. Used [Holy GL4ES](https://github.com/PojavLauncherTeam/gl4es-114-extra)
103-
- [x] Game surface zooming.
104-
- [x] New input pipe rewritten to native code to boost performance.
105-
- [x] Rewritten entire controls system (thanks to @Mathias-Boulay)
106-
- [ ] More to come!
54+
55+
### Quick Build (Recommended)
56+
57+
The easiest way to build PojavLauncher is to use the pre-built JREs provided by our CI.
58+
59+
1. Clone the repository: `git clone https://github.com/PojavLauncherTeam/PojavLauncher.git`
60+
2. Build the launcher: `./gradlew :app_pojavlauncher:assembleDebug` (Use `gradlew.bat` on Windows)
61+
62+
The built APK will be located in `app_pojavlauncher/build/outputs/apk/debug/`.
63+
64+
### Detailed Build
65+
66+
If you need more control over the build process, follow these steps:
67+
68+
1. **Java Runtime Environment (JRE):** Download the `jre8-pojav` artifact from our [CI auto builds](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/actions). 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](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch) repository.
69+
70+
2. **LWJGL:** The build instructions for the custom LWJGL are available over the [LWJGL repository](https://github.com/PojavLauncherTeam/lwjgl3).
71+
72+
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:
73+
* Linux/macOS:
74+
```bash
75+
chmod +x scripts/languagelist_updater.sh
76+
bash scripts/languagelist_updater.sh
77+
```
78+
* Windows:
79+
```batch
80+
scripts\languagelist_updater.bat
81+
```
82+
83+
4. **Build GLFW stub:** `./gradlew :jre_lwjgl3glfw:build`
84+
85+
5. **Build the launcher:** `./gradlew :app_pojavlauncher:assembleDebug` (Replace `gradlew` with `gradlew.bat` on Windows).
86+
87+
## Current Status
88+
89+
* [x] OpenJDK 8 Mobile port: ARM32, ARM64, x86, x86_64
90+
* [x] OpenJDK 17 Mobile port: ARM32, ARM64, x86, x86_64
91+
* [x] OpenJDK 21 Mobile port: ARM32, ARM64, x86, x86_64
92+
* [x] Headless mod installer
93+
* [x] Mod installer with GUI
94+
* [x] OpenGL in OpenJDK environment
95+
* [x] OpenAL (works on most devices)
96+
* [x] Support for Minecraft 1.12.2 and below
97+
* [x] Support for Minecraft 1.13 and above
98+
* [x] Support for Minecraft 1.17 (22w13a) and above
99+
* [x] Game surface zooming
100+
* [x] New input pipe rewritten to native code
101+
* [x] Rewritten entire controls system
102+
* [ ] More to come!
107103

108104
## Known Issues
109-
- Controller mods aren't working.
110-
- Random crashes could happen very often on Android 5.x when loading the game or joining a world.
111-
- With big modpacks textures could be messed up
112-
- Probably more, that's why we have a bug tracker ;)
113105

114-
## License
115-
- PojavLauncher is licensed under [GNU LGPLv3](https://github.com/PojavLauncherTeam/PojavLauncher/blob/v3_openjdk/LICENSE).
106+
See our [issue tracker](https://github.com/PojavLauncherTeam/PojavLauncher/issues) for a list of known issues and their current status.
107+
108+
## FAQ
109+
110+
See our [wiki](https://pojavlauncherteam.github.io/) for more information.
116111

117112
## Contributing
118-
Contributions are welcome! We welcome any type of contribution, not only code. For example, you can help the wiki shape up. You can help the [translation](https://crowdin.com/project/pojavlauncher) too!
119-
120-
121-
Any code change to this repository (or iOS) should be submitted as a pull request. The description should explain what the code does and give steps to execute it.
122-
123-
## Credits & Third party components and their licenses (if available)
124-
- [Boardwalk](https://github.com/zhuowei/Boardwalk) (JVM Launcher): Unknown License/[Apache License 2.0](https://github.com/zhuowei/Boardwalk/blob/master/LICENSE) or GNU GPLv2.
125-
- Android Support Libraries: [Apache License 2.0](https://android.googlesource.com/platform/prebuilts/maven_repo/android/+/master/NOTICE.txt).
126-
- [GL4ES](https://github.com/PojavLauncherTeam/gl4es): [MIT License](https://github.com/ptitSeb/gl4es/blob/master/LICENSE).<br>
127-
- [OpenJDK](https://github.com/PojavLauncherTeam/openjdk-multiarch-jdk8u): [GNU GPLv2 License](https://openjdk.java.net/legal/gplv2+ce.html).<br>
128-
- [LWJGL3](https://github.com/PojavLauncherTeam/lwjgl3): [BSD-3 License](https://github.com/LWJGL/lwjgl3/blob/master/LICENSE.md).
129-
- [LWJGLX](https://github.com/PojavLauncherTeam/lwjglx) (LWJGL2 API compatibility layer for LWJGL3): unknown license.<br>
130-
- [Mesa 3D Graphics Library](https://gitlab.freedesktop.org/mesa/mesa): [MIT License](https://docs.mesa3d.org/license.html).
131-
- [pro-grade](https://github.com/pro-grade/pro-grade) (Java sandboxing security manager): [Apache License 2.0](https://github.com/pro-grade/pro-grade/blob/master/LICENSE.txt).
132-
- [bhook](https://github.com/bytedance/bhook) (Used for exit code trapping): [MIT license](https://github.com/bytedance/bhook/blob/main/LICENSE).
133-
- [libepoxy](https://github.com/anholt/libepoxy): [MIT License](https://github.com/anholt/libepoxy/blob/master/COPYING).
134-
- [virglrenderer](https://github.com/PojavLauncherTeam/virglrenderer): [MIT License](https://gitlab.freedesktop.org/virgl/virglrenderer/-/blob/master/COPYING).
135-
- Thanks to [MCHeads](https://mc-heads.net) for providing Minecraft avatars.
113+
114+
Contributions are welcome! We welcome any type of contribution, not only code. For example, you can help improve the [wiki](https://pojavlauncherteam.github.io/), contribute to the [translations](https://crowdin.com/project/pojavlauncher), or submit bug reports and feature requests.
115+
116+
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it.
117+
118+
## Support
119+
120+
For support, please join our [Discord server](https://discord.com/invite/aenk3EUvER).
121+
122+
## License
123+
124+
PojavLauncher is licensed under [GNU LGPLv3](https://github.com/PojavLauncherTeam/PojavLauncher/blob/v3_openjdk/LICENSE).
125+
126+
## Credits & Dependencies
127+
128+
* [Boardwalk](https://github.com/zhuowei/Boardwalk) (JVM Launcher): Unknown License/[Apache License 2.0](https://github.com/zhuowei/Boardwalk/blob/master/LICENSE) or GNU GPLv2.
129+
* Android Support Libraries: [Apache License 2.0](https://android.googlesource.com/platform/prebuilts/maven_repo/android/+/master/NOTICE.txt).
130+
* [GL4ES](https://github.com/PojavLauncherTeam/gl4es): [MIT License](https://github.com/ptitSeb/gl4es/blob/master/LICENSE).
131+
* [OpenJDK](https://github.com/PojavLauncherTeam/openjdk-multiarch-jdk8u): [GNU GPLv2 License](https://openjdk.java.net/legal/gplv2+ce.html).
132+
* [LWJGL3](https://github.com/PojavLauncherTeam/lwjgl3): [BSD-3 License](https://github.com/LWJGL/lwjgl3/blob/master/LICENSE.md).
133+
* [LWJGLX](https://github.com/PojavLauncherTeam/lwjglx) (LWJGL2 API compatibility layer for LWJGL3): unknown license.
134+
* [Mesa 3D Graphics Library](https://gitlab.freedesktop.org/mesa/mesa): [MIT License](https://docs.mesa3d.org/license.html).
135+
* [pro-grade](https://github.com/pro-grade/pro-grade) (Java sandboxing security manager): [Apache License 2.0](https://github.com/pro-grade/pro-grade/blob/master/LICENSE.txt).
136+
* [bhook](https://github.com/bytedance/bhook) (Used for exit code trapping): [MIT license](https://github.com/bytedance/bhook/blob/main/LICENSE).
137+
* [libepoxy](https://github.com/anholt/libepoxy): [MIT License](https://github.com/anholt/libepoxy/blob/master/COPYING).
138+
* [virglrenderer](https://github.com/PojavLauncherTeam/virglrenderer): [MIT License](https://gitlab.freedesktop.org/virgl/virglrenderer/-/blob/master/COPYING).
139+
* Thanks to [MCHeads](https://mc-heads.net) for providing Minecraft avatars.
140+
141+
## Roadmap
142+
143+
We are currently focusing on:
144+
145+
* Exploring new rendering technologies.
146+
147+
Future plans include:
148+
149+
* Improving stability and performance.
150+
* Enhancing the mod installation experience.
151+
152+
We welcome community feedback and suggestions for our roadmap. Please feel free to open a feature request in our [issue tracker](https://github.com/PojavLauncherTeam/PojavLauncher/issues).

0 commit comments

Comments
 (0)