diff --git a/.vuepress/config.js b/.vuepress/config.js index e99a4db3..07f5563e 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -88,7 +88,7 @@ module.exports = { 'BUILD-FROM-SOURCE', // Building PojavLauncher from source 'SIGN-IN', // Signing in 'INSTALL-MC', // Downloading Minecraft - 'DEFAULT-CONTROLS', // Taking a look at the controls + 'CUSTOM-CONTROLS', // Customizing the on-screen controls 'DISCORD', // Official PojavLauncher Discord server ] }, @@ -104,7 +104,6 @@ module.exports = { children: [ 'JIT', // iOS and "JIT" 'APPSTORE', // Will PojavLauncher ever come to App Store for iOS? - 'IOSMODPACKS', // how do i install modpacks on PojavLauncher iOS? ] }, { @@ -120,8 +119,6 @@ module.exports = { 'ZINK', // What's Zink, and why it's not what you think 'SHADERS', // Look what we got here. 'RENDERERS', // I have no idea what they do and why PojavLauncher needs it. - '3PTYCLIENTS', // Reminders about installing third party clients from unknown sources - '117CC', // Basics to get 21w10(?)a+ running. Useless ] }, // FAQ that applies to both platforms goes here @@ -133,7 +130,6 @@ module.exports = { collapsable: true, sidebarDepth: 1, children: [ - 'CUSTOM-CONTROLS', // Customizing the on-screen controls 'OPTIMIZATION', // Optimizing the game 'CUSTOM-MC', // Custom Minecraft! 'MODPACKS', // Everything you need to know about Modpacks support @@ -165,9 +161,8 @@ module.exports = { collapsable: false, sidebarDepth: 1, children: [ - 'CONT-POJAV', // Contributing to PojavLauncher itself 'CONT-WEBSITE', // Contributing to this website - 'CONT-TRANSLATIONS', //Contributing to PojavLauncher translations, hopefully website translations later on + 'CONT-TRANSLATIONS', //Contributing to PojavLauncher translations, hopefully website translations later on ] }, diff --git a/117CC.md b/117CC.md deleted file mode 100644 index e69de29b..00000000 diff --git a/32BIT.md b/32BIT.md index a3da592e..eb8b8e36 100644 --- a/32BIT.md +++ b/32BIT.md @@ -1,17 +1,24 @@ # PojavLauncher's 32-bit support -Most of you, Android users, who are reading this now, won't be bothered by this documentation, but for the poor souls who have a 32-bit device, let's press ~~L~~ F to pay respect to them. +Most of you, Android users, who are reading this now, won't be bothered by this documentation, but for the poor souls who have a 32-bit device, let's press ~~L~~ F to pay respects to them. Before ARM transitioned into the more-powerful, more-utilizing `arm64/aarch64` architecture; everyone was using `arm/aarch32` We're not here to give you historical information of it, but feel free to read [this documentary about the ARM platform.](https://en.m.wikipedia.org/wiki/ARM_architecture_family) -**You may encounter issues while using PojavLauncher on 32-bit devices. Here's a list of stuff that's known to be problematic:** +**You may encounter issues while using PojavLauncher on 32-bit devices. Here's a list of things that are known to be problematic:** ## RAM Allocation -* **Real 32-bit devices (32-bit hardware and firmware), can't allocate more than 768MB of RAM to PojavLauncher. This can't be changed even if the device has more free RAM.** + +**Real 32-bit devices (32-bit hardware and firmware), can't allocate more than 768MB of RAM to PojavLauncher. This can't be changed even if the device has more free RAM.** + * Examples of real 32-bit SoCs: Qualcomm Snapdragon 801, 800, 600, 400, S4, S3, S2, S1 -* **64-bit devices limited to 32-bit firmware can't allocate more than ~1000MB of RAM. As said earlier, this can't be changed.** + +**64-bit devices limited to 32-bit firmware can't allocate more than ~1000MB of RAM. As said earlier, this can't be changed.** + * Examples of 64-bit SoCs limited to 32-bit firmware: MediaTek Helio G37, G35, G25, P35, P25, P23, P22 ## Performance Due to 32-bit's processing speed limit, Minecraft's performance is always compromised. Even with optimization mods installed, you may get big stutters even on lowest settings. Decreasing RAM Allocation may help performance in certain scenarios. + +## Compatibility +As of snapshot [24w14a](https://minecraft.wiki/w/Java_Edition_24w14a), Minecraft has officially dropped support for the 32-Bit architecture, If you own a 32-Bit device you will not be able to run Minecraft 1.20.5+ on said device. diff --git a/3PTYCLIENTS.md b/3PTYCLIENTS.md deleted file mode 100644 index 2f259b79..00000000 --- a/3PTYCLIENTS.md +++ /dev/null @@ -1 +0,0 @@ -s \ No newline at end of file diff --git a/APPSTORE.md b/APPSTORE.md index d650d89a..9ea92c4a 100644 --- a/APPSTORE.md +++ b/APPSTORE.md @@ -1,6 +1,10 @@ # Will PojavLauncher ever come to App Store for iOS? -## from the AppStore review guidelines -2.5.2 Apps should be self-contained in their bundles, and may not read or write data outside the designated container area, nor may they download, install, or execute code which introduces or changes features or functionality of the app, including other apps. Educational apps designed to teach, develop, or allow students to test executable code may, in limited circumstances, download code provided that such code is not used for other purposes. Such apps must make the source code provided by the Application completely viewable and editable by the user. -Also, $99 per year is required for pushing updates. -So you will know if PojavLauncher will ever be pushed to App Store. +### From the App Store review guidelines: +__2.5.2__: Apps should be self-contained in their bundles, and may not read or write data outside the designated container area, nor may they download, install, or execute code which introduces or changes features or functionality of the app, including other apps. Educational apps designed to teach, develop, or allow students to test executable code may, in limited circumstances, download code provided that such code is not used for other purposes. Such apps must make the source code provided by the Application completely viewable and editable by the user. + +Apple Developer Documentation Referenced: [Section 2.5.2](https://developer.apple.com/app-store/review/guidelines/#performance:~:text=Apps%20should%20be,by%20the%20user) + +Additionally, $99 per year is required for pushing updates. + +**If PojavLauncher is ever pushed to the App Store, you will know!** diff --git a/CONT-POJAV.md b/CONT-POJAV.md deleted file mode 100644 index c2ca5bc5..00000000 --- a/CONT-POJAV.md +++ /dev/null @@ -1 +0,0 @@ -# Contributing to PojavLauncher itself diff --git a/CUSTOM-CONTROLS.md b/CUSTOM-CONTROLS.md index 0d533439..994cf384 100644 --- a/CUSTOM-CONTROLS.md +++ b/CUSTOM-CONTROLS.md @@ -1 +1,44 @@ -# Customizing the on-screen controls \ No newline at end of file +# Customizing the on-screen controls + +### There is "Custom controls" button in the main menu, by clicking that you will be able to change you custom controls. + + + +### You can access the options by clicking the cogwheel at the top of the screen. + + + +### After clicking the cogwheel, you get a drawer with the following options: + + + + 1- Adds a button of your liking. + + 2- Adds a button drawer, if you press it, your buttons that you assigned will show up. + + 3- Adds a joystick. + + 4- Loads custom controls. + + 5- Saves current custom controls. + + 6- Option to select default custom controls. + + 7- Exports current controls. + + + + + + + + + + + + + + + + + diff --git a/INSTALL.md b/INSTALL.md index 773d9fdd..95a503db 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -44,57 +44,22 @@ If you want the latest and greatest to test before the official release, you can ## iOS Instructions for installing PojavLauncher on Apple devices. -::: details Sideloading TrollStore (No PC/Mac) -Notes: -- It is **highly recommended** you install __AdGuard__ from the __App Store__ to block Scarlet’s annoying ads -- This will be an extremely lengthy guide, so you’ll need a bunch of spare time. -- Only compatible for iOS/iPadOS 16 - 16.6.1 - -1. Now that you have gotten __AdGuard__ from the __App Store__, you are going to want __open the **Settings** app__, scroll down to **Safari**, and tap on extensions. - -__Enable **AdGuard**__, and **__allow all__** of its content blockers. - -2. Open __[Scarlet](https://usescarlet.com/)__. - -Scroll down to the bottom of the page and click the “**Install**” button. - -next, click “**Direct install**” - -wait the for 10 seconds. **Don’t do anything to the iDevice for 10 seconds**. - -when prompted to open the page in iTunes, click Open. - -When it displays the message:“would you like to install [insert random certificate here]” click install. you may now close the website. - -**Note**: the random unnamed certificate is completely normal. scarlet uses random enterprise certificates to be able to sideload apps on device. - -Note: due to scarlet using random enterprise certificates, the will commonly get revoked. if it is revoked try to install scarlet every few hours. - -3. Next, go to Settings, General, VPN and Device Management, and where it says “enterprise app” should be a random certificate that says “Not Trusted” click it, and click Trust “(Random Scarlet Certificate)” -when prompted to trust it, click “Trust” -you should now be able to open scarlet. - -4. Download the [TrollinstallerX.ipa](https://github.com/alfiecg24/TrollInstallerX/releases/download/1.0.2/TrollInstallerX.ipa) -^ This is your TrollStore installer ^ - -5. Open the Scarlet app, click the bottom middle button, and click the button in the top right corner. in the file browser, open the .ipa from where you've had saved it (regularly it would be in the Downloads folder.) and sideload the [TrollinstallerX.ipa](https://github.com/alfiecg24/TrollInstallerX/releases/download/1.0.2/TrollInstallerX.ipa) - -6. Once Scarlet is done installing [TrollinstallerX](https://github.com/alfiecg24/TrollInstallerX/releases/download/1.0.2/TrollInstallerX.ipa), open the installed app, and press "Install Trollstore", wait for a pop up that will show a list of System Apps, and pick one. (we suggest picking Tips) - -7. After that, the next steps are in the [Github Actions Tab](https://pojavlauncherteam.github.io/INSTALL.html#ios) -![](./images/Actions/ios/TSNOPC.png) -Note: enable URL Schemes in TrollStore Settings. -::: - ::: details Sideloading (TrollStore) We recommend TrollStore for all users if possible. This method allows for automatic JIT enabling, more memory allocation, and non-revoking installs. +Note: **Enable URL Schemes in TrollStore settings.** + ### TrollStore compatibility depends on whether your iDevice is arm64 (A8-A11) or arm64e (A12+/M1+) #### For arm64, TrollStore is compatible with the following iOS versions: - 14.0 to 16.6.1 - - 17.0 + - 17.0 + - 16.7 to 16.7.8 (*) + - 17.0.1 to 17.5.1 (*) + - 18 b1 to 18 b4 (*) + + (*) - requires the palera1n jailbreak #### For arm64e, TrollStore is compatible with the following iOS versions: @@ -111,7 +76,6 @@ We recommend TrollStore for all users if possible. This method allows for automa 3. Locate where the .ipa was downloaded, tap the Share icon, and choose TrollStore in the list of options available. You can now enjoy Minecraft: Java Edition on your iDevice! -Note: enable URL Schemes in TrollStore Settings. ::: ::: details Sideloading (Unjailbroken) diff --git a/IOSMODPACKS.md b/IOSMODPACKS.md deleted file mode 100644 index 1bbb68ac..00000000 --- a/IOSMODPACKS.md +++ /dev/null @@ -1,17 +0,0 @@ -# how do i install modpacks on iOS PojavLauncher? - -1. go to profiles from the sidebar. - -![](./images/Actions/ios/1.png) - -2. press the "+" button - -![](./images/Actions/ios/2.png) - -3. once a prompt appears, press the "Modpack" option. - -![](./images/Actions/ios/3.png) - -4. pick your desired modpack, enjoy! - -![](./images/Actions/ios/4.png) diff --git a/JIT.md b/JIT.md index 59584244..f279dee8 100644 --- a/JIT.md +++ b/JIT.md @@ -8,15 +8,34 @@ On Apple's mobile platforms (iOS, iPadOS, tvOS, in our case), a security feature ## What does this mean for PojavLauncher? ### Jailbroken devices -Jailbroken device users don't need to worry about JIT requirements, as PojavLauncher is built to detect jailbreaks and automatically enable new features. +Users with Jailbroken devices don't need to worry about JIT requirements, as PojavLauncher is built to detect jailbreaks and automatically enable new features. ### Unjailbroken devices -Unjailbroken users can see two different outcomes, based on what they used to sideload PojavLauncher. +Users with Unjailbroken devices can see two different outcomes, based on what they used to sideload PojavLauncher. #### TrollStore If you used TrollStore to sideload PojavLauncher, good news: PojavLauncher takes advantage of the extended capabilities with TrollStore and automatically enables JIT when launched. #### Normal sideload -If you sideload normally, you will need to enable JIT in some way. The most common method is to attach a debug server to the application while it's running - AltStore, SideStore, and Jitterbug all use this method with their JIT enabling functions. The only downside to this method is that you are required to be connected to a WiFi network in order to enable JIT. +If you sideload normally, you will need to enable JIT in some way. The most common method is to attach a debug server to the application while it's running - AltStore, SideStore, and Jitterbug all of these use this method to enable JIT. -You can also use [AltStore](https://faq.altstore.io/how-to-use-altstore/altjit), [SideStore](https://wiki.sidestore.io/guides/getting-started/#setting-up-wireguard), or, for more advanced users, [Jitterbug](https://github.com/osy/Jitterbug/tree/main/Jitterbug). Methods not listed here are not confirmed or recommended by us for use with PojavLauncher. +The only downside to this method is that you are required to be connected to a WiFi network in order to enable JIT. (*) + +(*) - For iOS 17.x & iOS 18 betas, enabling JIT will be done with pymobiledevice3, due to changes in iOS. pymobiledevice3 requires a computer to enable JIT. AltJIT via pymobiledevice3 only works on macOS. + +You can also use: +- [AltStore](https://faq.altstore.io/how-to-use-altstore/altjit) (*) + +- [Jitterbug](https://github.com/osy/Jitterbug/tree/main/Jitterbug) (^) + +- [SideStore](https://docs.sidestore.io/docs/faq/#:~:text=Can%20I%20activate,selecting%20'Enable%20JIT') (^) + +- [SideJITServer](https://github.com/nythepegasus/SideJITServer) (!) + +(*) - AltJIT for iOS 17.x & iOS 18 betas only works on macOS. Requires pymobiledevice3. + +(^) - Does not work for iOS 17.x & iOS 18 betas, as enabling JIT will be done with pymobiledevice3. + +(!) - Does not work for iOS 16.x or below, use the other methods listed above to enable JIT. This method is meant for iOS 17.x & iOS 18 betas. + +Methods not listed here are not confirmed or recommended by us for use with PojavLauncher. diff --git a/LEGAL.md b/LEGAL.md index 7762e86a..1b0a2a38 100644 --- a/LEGAL.md +++ b/LEGAL.md @@ -8,5 +8,5 @@ Authentication and downloads are performed directly with Mojang's servers--Pojav PojavLauncher does not cause harm to your device, and does not distribute harmful programs and executables. * This cannot be verified if you acquire PojavLauncher from a source that is not official. -* For iOS users: jailbreaking can be considered a security risk, so be cautious when jailbroken. +* For jailbroken iOS users: jailbreaking can be considered a security risk, so be cautious when jailbroken. * Other Minecraft: Java Edition on Android/iOS apps claims properties of PojavLauncher. They are not owned nor managed by PojavLauncherTeam. diff --git a/MCVERS.md b/MCVERS.md index adf3b9da..4dcf05a5 100644 --- a/MCVERS.md +++ b/MCVERS.md @@ -1,13 +1,18 @@ # Supported Minecraft versions -With each new Minecraft release comes questions: how well does it play nice with PojavLauncher? +With each new Minecraft release comes the question: *Will it play nice with PojavLauncher?* Thanks to the hard work from PojavLauncherTeam, both the Android and the iOS port now cover most Minecraft versions... ...with some small exceptions that will be listed below. ## Android -Current issues, as of the Foxglove update +Current issues, as of the Foxglove update: ## iOS -Current issues, as of the v2.2 Deepslate update +Current issues, as of the v2.2 Deepslate update: + + - v2.2 Deepslate will not open versions of minecraft past 1.20 (*) + - v2.2 Deepslate does not have Java 21. (*) + +(*) - To fix these issues, please use [the most recent github actions developer build](https://nightly.link/PojavLauncherTeam/PojavLauncher_iOS/workflows/development/main/net.kdt.pojavlauncher-ios.ipa.zip). diff --git a/MODPACKS.md b/MODPACKS.md index 31c3dde9..c6daf45b 100644 --- a/MODPACKS.md +++ b/MODPACKS.md @@ -9,5 +9,39 @@ Popular examples of these can be found on the [CurseForge](https://www.curseforg These modpacks are specially made for PojavLauncher, but it doesn't mean you can't try them on PC too! -## Installing Modpacks -⚠️ There is NO modpack installer in the launcher itself. It won't be added in the near future. +# Installing Modpacks + +## Android +1. Click on the profile section at top of the play button. + + + +2. Press on the "create new profile" button. + + + +3. Click on "create modpack profile". + + + +4. Pick your desired modpack, enjoy! + + + +## iOS + +1. Go to profiles from the sidebar. + + + +2. Press the "+" button + + + +3. Once a prompt appears, press the "Modpack" option. + + + +4. Pick your desired modpack, enjoy! + +