kokirigla.de
online Minecraft written book viewer
chore: update main readme
+1
-75
+1
-75
README.md
+1
-75
README.md
···
1
1
# nara
2
2
3
-
A web-based book archival/viewing tool for Minecraft 1.12.2 data exported via Infinity Item Editor.
4
-
5
-
## Prerequisites
6
-
7
-
- [Rust toolchain][rust] (to compile)
8
-
- [Minecraft: Java Edition][mc] (1.12.2)
9
-
- [Minecraft Forge for 1.12.2][forge]
10
-
- [Infinity Item Editor][iie] mod
11
-
12
-
## Usage
13
-
14
-
### 1. Build
15
-
16
-
```sh
17
-
cargo build --release
18
-
````
19
-
20
-
The binary will be in `target/release/` (`nara` or `nara.exe`).
21
-
22
-
### 2. Export books from Minecraft
23
-
24
-
1. Install the [Infinity Item Editor][iie] mod for Minecraft 1.12.2.
25
-
26
-
2. In Minecraft (with the mod installed), put your written books into Shulker Boxes (the colour of the Shulker Boxes does not matter).
27
-
28
-
3. Rename each shulker box in an anvil as:
29
-
30
-
`CATEGORY_NAME ID`
31
-
32
-
Example for a category named “Fiction”:
33
-
34
-
`Fiction 1`, `Fiction 2`, `Fiction 3`
35
-
36
-
4. Save each shulker box using Infinity Item Editor (default keybind: `G`, configurable in Controls).
37
-
38
-
Infinity Item Editor writes exports into `realm.nbt`.
39
-
40
-
### 3. Run
41
-
42
-
1. Make a new directory to hold both the app and the exported data.
43
-
2. Copy the `nara` binary into it.
44
-
3. Copy `realm.nbt` into it from your Minecraft directory:
45
-
46
-
* **Windows:** `%AppData%\.minecraft\infinity-data\realm.nbt`
47
-
* **Linux:** `~/.minecraft/infinity-data/realm.nbt`
48
-
* **macOS:** `~/Library/Application Support/minecraft/infinity-data/realm.nbt`
49
-
50
-
**macOS/Linux**
51
-
52
-
```sh
53
-
./nara
54
-
```
55
-
56
-
**Windows**
57
-
58
-
```bat
59
-
nara.exe
60
-
```
61
-
62
-
nara will print a local URL in the terminal - open it in your browser.
63
-
64
-
## Customization
65
-
66
-
All customization is via CLI flags:
67
-
68
-
```sh
69
-
./nara --help
70
-
```
71
-
72
-
Open an issue if anything is unclear.
73
-
74
-
[rust]: https://rustup.rs/ "rustup.rs - the Rust toolchain installer"
75
-
[mc]: https://minecraft.net/ "Minecraft"
76
-
[forge]: https://files.minecraftforge.net/net/minecraftforge/forge/index_1.12.2.html "Downloads for Minecraft Forge for 1.12.2"
77
-
[iie]: https://modrinth.com/mod/infinity-item-editor/version/0.15 "modrinth.com | 0.15 - Infinity Item Editor"
3
+
A cross-version Minecraft written book archiver and viewer.