diff --git a/README.md b/README.md index 2b079eb12..cf49f2b08 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ * For more details [check out our wiki](https://github.com/PojavLauncherTeam/PojavLauncher/wiki) ## Some notes to start with -- We do not exist on TikTok. No one from the dev team makes TikTok videos. +- We do not have an official TikTok account. No one from the dev team makes TikTok videos. - 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. ## Navigation @@ -37,21 +37,21 @@ ## Getting PojavLauncher -Getting PojavLauncher is divided into 3 parts. +You can get PojavLauncher via three methods: -1. You can get prebuilt app from [stable releases](https://github.com/PojavLauncherTeam/PojavLauncher/releases) or [automatic builds](https://github.com/PojavLauncherTeam/PojavLauncher/actions). +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). -2. You can get it from Google Play by clicking: +2. You can 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) 3. You can [build](#building) from source. ## Building -If you want to build after launcher code changes, follow the steps below. +If you want to build from source code, follow the steps below. ### Java Runtime Environment (JRE) - 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). - Follow build instruction on build script [README.md](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/blob/buildjre8/README.md). -- You can also get [CI auto builds](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/actions) if you are lazy or failing it for some reason. -* Either get `jre8-pojav` artifact from auto builds, or do splitting by yourself:
+- 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. +* Either get the `jre8-pojav` artifact from auto builds, or split all artifacts by yourself:
- Get JREs for all of 4 supported architectures (arm, arm64, x86, x86_64)
- Split JRE into parts:
Platform-independent: .jar files, libraries, configs, etc...
@@ -59,7 +59,7 @@ If you want to build after launcher code changes, follow the steps below. - Create:
A file named `universal.tar.xz` with all platform-independent files
4 files named `bin-.tar.xz` with all platform-dependent files per-architecture
- - Put these in `assets/components/jre/` folder
+ - Put these in the `assets/components/jre/` folder
- (If needed) update the Version file with the current date
### LWJGL @@ -87,13 +87,13 @@ Then, run these commands ~~or build using Android Studio~~. ``` ./gradlew :app_pojavlauncher:assembleDebug ``` -(Replace `gradlew` to `gradlew.bat` if you are building on Windows). +(Replace `gradlew` with `gradlew.bat` if you are building on Windows). ## Current status - [x] ~~OpenJDK 9 Mobile port: ARM32, ARM64, x86, x86_64.~~ Replaced by JRE8. - [x] OpenJDK 8 Mobile port: ARM32, ARM64, x86, x86_64 - [x] OpenJDK 17 Mobile port: ARM32, ARM64, x86, x86_64 -- [x] Mod installer headless +- [x] Headless mod installer - [x] Mod installer with GUI. Used `Caciocavallo` project for AWT without X11. - [x] OpenGL in OpenJDK environment - [x] OpenAL (works on most devices) @@ -107,7 +107,7 @@ Then, run these commands ~~or build using Android Studio~~. ## Known Issues - Controller mods aren't working. -- Random crashes could happen very often on Android 5.x during game load or join world. +- Random crashes could happen very often on Android 5.x when loading the game or joining a world. - With big modpacks textures could be messed up - Probably more, that's why we have a bug tracker ;)