Text2McBook

<p align="center"> <picture> <img src="https://github.com/Neocky/Text2McBook/assets/13088544/e138462c-8ecd-4a6f-ad68-aeb77764fee1" alt="Lorem ipsum preview book" height="300px"> </picture> </p> <h1 align="center"> Text2McBook </h1>

📚 Convert any text file to a formatted text for minecraft books to use them as easily as possible ingame.

Issues? Found a bug?

Create an issue.

About

This script will convert text from a text file to a formatted minecraft book file. The file contains a native /give command which can be used ingame to get a writable_book with the text as content.
It supports different book formats which can be chosen with the parameter -f FORMATNAME.
I got inspiration from a post from r/admincraft.

Default

The default format will create a /give command which can be easily copied into a command block ingame to get the writable book. It will also format the text in a way in which it can be easily copy and pasted in a book in the game.

Denizen

Denizen is a scripting plugin for minecraft servers.
The denizen format will format the text for the text property in Book Script Containers. It will replace new line symbols with <n> and indents the line with 4 spaces to make it easily pasteable in the text properties of book script containers.

Installation

Python

Python (minimum: Version 3.10.4) needs to be installed on your machine.
Get it here.

Clone the repository / Download the latest release

Download the script:
Clone the repository or get the latest release here.

Usage

Create/edit the text file in the same folder where the python script is with the name text.txt and add your book text in there.
This is the text that you want to be converted to a minecraft book format.
Run the script: text2mcbook.py.
Now a booktext.txt file should be created.
In there is a /give command which can be inputted into a command block to get the book. There is also the formatted text which you can easily copy & paste in a book in minecraft.

Advanced Usage

Parametrs

This script supports the following parameters to change the usage for the script.

Get help about all available parameters

py text2mcbook.py -h

Input file

py text2mcbook.py INPUTFILENAME

Default: text.txt
Changes the input file.

Output file

py text2mcbook.py INPUTFILENAME OUTPUTFILENAME

Default: booktext.txt
Changes the output file.

Book format

py text2mcbook.py -f FORMAT
py text2mcbook.py --format FORMAT

Default: default
Possible Values: default, denizen
Changes the book format and the resulting formatting.

Characters per line

py text2mcbook.py -c NUMBEROFCHARACTERSPERLINE
py text2mcbook.py --characterlimit NUMBEROFCHARACTERSPERLINE

Default: 19
The number of characters one book line can have.
Warning: Don't set it to high or you are risking the loss of words!

Examples

Example 1

py text2mcbook.py book_to_convert.txt book_formatted.txt

Changes the input file to book_to_convert.txt and outupts the formatted book text to book_formatted.txt.

Example 2

py text2mcbook.py -f denizen -c 20

Outputs denizen formated text, which can be used in the text propert of Book Script Containers in Denizen. Also changes the number of characters per line to 20.