Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/jailbreaking/Legacy/post-jailbreak/disable-ota.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Kindles automatically update when connected to Wi-Fi, which despite a `hotfix`,

> [!WARNING]
> You may skip this if you jailbroke using Winterbreak, Springbreak, or Sanctuary. OTA updates have already been blocked for you.
>
> **Exception:** If you used **WinterBreak2** and your `winterbreak.log` says `Please Install HOTFIX now`, OTA updates have **not** been blocked for you — you **must** complete this step.

<div id="guide">
<div class="buttons">
Expand Down Expand Up @@ -132,7 +134,7 @@ Kindles automatically update when connected to Wi-Fi, which despite a `hotfix`,
</div>
</div>

<script>new Guide("guide", "#", "Finish");</script>
<script>new Guide("guide", "./koreader.html", "Installing KOReader");</script>

## Credits

Expand Down
124 changes: 124 additions & 0 deletions content/jailbreaking/Legacy/post-jailbreak/koreader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
---
layout: default
parent: Post Jailbreak
title: Installing KOReader
weight: 4
---

# Installing KOReader

_KOReader is a document viewer for E Ink devices. Supported formats include EPUB, PDF, DjVu, XPS, CBT, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, DOC, MOBI and ZIP files._

> [!NOTE]
> Your Kindle must be jailbroken and have MRPI and KUAL installed to be able to run KOReader.

> [!WARNING]
> This is the **manual** installation method, which is used by the Legacy post-jailbreak stack (KUAL & MRPI). If your jailbreak pre-installed **KPM** instead, use `;kpm install koreader` in the search bar, as detailed in the [What's Next](/jailbreaking/whats-next/index.html) section!

<div id="guide">
<div class="buttons">
<button id="prev">Previous Step</button>
<span id="stepCounter"></span>
<button id="next">Next Step</button>
</div>
<div id="stepwrapper" class="stepwrapper">
<div class="step">
<h2>Determine your firmware version</h2>
<div class="stepContent">
<p>Before proceeding, check your Kindle's firmware version by going to:</p>
<p><strong>Home → Menu → Settings → Menu → Device Info</strong></p>
<p class="highlight">Different firmware versions require different KOReader packages</p>
</div>
</div>

<div class="step">
<h2>Download KOReader</h2>
<div class="stepContent">
<p>Download KOReader from the <a href="https://github.com/koreader/koreader/releases" target="_blank">official release page</a></p>
<p>Choose the correct package for your Kindle:</p>
<div class="version-block">
<p class="version-label">KOReader Packages:</p>
<code>kindle-legacy</code>: K2, DX, K3 (and all variants)
<br/>
<code>kindle</code>: K4, K5, PW1
<br/>
<code>kindlepw2</code>: PW2 and newer models running firmware =< 5.16.2.1.1
<br/>
<code>kindlehf</code>: <b>Any Kindle device</b> running firmware >=5.16.3
</div>
</div>
</div>

<div class="step">
<h2>Alternative Download Method</h2>
<div class="stepContent">
<div class="version-block">
<p class="version-label">Firmware >=5.16.3:</p>
<a href="https://scriptlets.notmarek.com/" target="_blank">Marek's KOReader Installer (nightly)</a> Download and copy this scriptlet into the <code>/documents</code> folder on your Kindle, run it from your Library and it will automatically download and install KOReader
<p class="note">This alternative method might not work for everyone</p>
</div>
</div>
</div>

<div class="step">
<h2>Connect your Kindle to your computer</h2>
<div class="stepContent">
<p>Plug your Kindle into your PC via USB cable</p>
<p>Wait for your computer to recognize the device</p>
<p class="highlight">Make sure your Kindle appears as a storage device on your computer</p>
</div>
</div>

<div class="step">
<h2>Install KOReader</h2>
<div class="stepContent">
<p>Unzip the downloaded file</p>
<p>Copy the <code>extensions</code> and <code>koreader</code> folders to the root directory of your Kindle</p>
<p class="highlight">When prompted, confirm to merge or replace existing files</p>
</div>
</div>

<div class="step">
<h2>Disconnect and Launch</h2>
<div class="stepContent">
<p>Safely eject and unplug your Kindle</p>
<p>Open KUAL (Kindle Unified Application Launcher)</p>
<p>Search for the KOReader menu entry and click on it</p>
<div class="version-block">
<p class="version-label">KOReader Launch Options</p>
<p>When launching KOReader, you may see three options:</p>
<code>Start KOReader</code>: The designed way to start KOReader
<br/>
<code>Start KOReader (no framework)</code>: Temporarily "kills" the Kindle UI to allocate more resources to KOReader
<br/>
<code>Start KOReader (ASAP)</code>: Skips a couple of checks and starts KOReader as soon as possible
<br/>
</div>
</div>
</div>

<div class="step">
<h2>Done</h2>
<div class="stepContent">
<p>KOReader is now installed on your Kindle!</p>
<p>We recommend reading the <a href="https://koreader.rocks/user_guide/" target="_blank">extensive but very helpful guide for KOReader</a></p>
<p class="note">
KOReader currently does not support USBMS mode (USB transfer) and will only charge the device, if you want to transfer files you must exit KOReader to do so
</p>
<p class="warning">
If KOReader appears in KUAL but doesn't work when clicked, delete both <code>koreader</code> folders, re-download koreader and make sure you're downloading the right package for your Kindle</p>
</div>
</div>
</div>
<div class="buttons">
<button id="prev">Previous Step</button>
<span id="stepCounter"></span>
<button id="next">Next Step</button>
</div>
</div>

<script>new Guide("guide", "/jailbreaking/jailbreak-faq.html", "Jailbreak FAQ");</script>

## Credits

- Written by Bundlerocks, re-designed to Fluent Style with ntindle and adapted from the [official KOReader Github installation page](https://github.com/koreader/koreader/wiki/Installation-on-Kindle-devices#err-there-are-four-kindle-packages-to-choose-from-which-do-i-pick)
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ A hotfix allows your Kindle's jailbreak to persist after updating. There are two
> [!WARNING]
> You may skip this if you jailbroke using Winterbreak, Springbreak, or Sanctuary. The hotfix has already been installed for you.
> This is also not necessary for some types of legacy jailbreaks, check the corresponding page.
> **Exception:** If you used **WinterBreak2** and your `winterbreak.log` says `Please Install HOTFIX now`, you **must** install the hotfix — do not skip this step.

<div id="guide">
<div class="buttons">
Expand Down
16 changes: 12 additions & 4 deletions content/jailbreaking/WinterBreak2/__index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,19 @@ WinterBreak2 is a browser-based jailbreak created by [Scam.Net](https://github.c
<h2>After Jailbreaking...</h2>
<div class="stepContent">
<div class="tip">
<b>What's Next?</b><br>
Commence to the <a href="../whats-next">What's Next</a> section to read about installing scriptlets, homebrew, and KOReader.<br>Read the <b>whole section</b> thoroughly.
<b>Check Your Log</b><br>
Plug your Kindle back into your computer and open the <code>winterbreak.log</code> file at the root of your Kindle's storage.<br><br>
If it contains <code>Please Install HOTFIX now</code>, your Kindle is on the <b>Legacy post-jailbreak stack</b>, and you <b>must</b> follow the steps below.
</div>
<div class="caution">
You may now <b>delete</b> any filler files. Updates have been automatically blocked for you.<br><br>
Do <b>not</b> use the <code>;kpm</code> package manager, as it does not apply to this stack. Instead, you must:<br>
1. Install the <a href="/jailbreaking/Legacy/post-jailbreak/setting-up-a-hotfix/">Universal Hotfix</a><br>
2. Install <a href="/jailbreaking/Legacy/post-jailbreak/installing-kual-mrpi/">KUAL &amp; MRPI</a><br>
3. <a href="/jailbreaking/Legacy/post-jailbreak/disable-ota.html">Disable OTA updates</a><br>
4. <a href="/jailbreaking/Legacy/post-jailbreak/koreader.html">Install KOReader manually</a>
</div>
<div class="caution">
You may now <b>delete</b> any filler files.<br><br>
Before you do this, also <b>remove any existing update files with a <code>.bin</code> extension</b>, if they exist in the Kindle's root.
</div>
<p>Have fun! :)</p>
Expand All @@ -106,7 +114,7 @@ WinterBreak2 is a browser-based jailbreak created by [Scam.Net](https://github.c
<button id="next">Next Step</button>
</div>
</div>
<script>new Guide("guide", "../whats-next", "What's Next?");</script>
<script>new Guide("guide", "/jailbreaking/Legacy/post-jailbreak/setting-up-a-hotfix/", "Setup a Hotfix");</script>

# Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion content/jailbreaking/jailbreak-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ This is also the case for the "Collecting Debug Info" message.

You can do one of the following:

- [Install KOReader](https://kindlemodding.org/jailbreaking/post-jailbreak/koreader.html)
- [Install KOReader](https://kindlemodding.org/jailbreaking/Legacy/post-jailbreak/koreader.html)
- [Downgrade your Kindle](https://kindlemodding.org/firmware-and-flashing/downgrading/)
- Download scriptlets:
- [Marek's Scriplets](https://scriptlets.notmarek.com/)
Expand Down