Git Product home page Git Product logo

braillebooks's Introduction

BrailleBooks

A tool to convert any image into Minecraft written book. It uses braille Unicode characters to achieve better resolution. Works with Minecraft 1.14

Examples

Give commands and original images can be found in Examples folder

Cube Mario

Usage

.NET Framework 4.6.1 is required to run the application.

To convert an image into a book, drag an image file onto the program. Supported formats are PNG, JPEG, and GIF. Each frame of a gif file will be placed on a separate page.

Another way to make a multi-page book is to drag a folder onto the program. The folder should contain PNG or JPEG files named as "01.png", "02.png" etc. (with trailing zeros).

To achieve best results, use 76x56 images (or smaller). Larger images will be downscaled.

The resulting command will be saved in command.mcfunction file near the original image/folder. You can either open it with a text editor and copypaste the command into a command block or add the file to a datapack. Be aware that there is a limit of 32200 characters when using a commands block, any commands longer than this can only be run through a datapack.

Usage again if above isn't clear enough

Usage

braillebooks's People

Contributors

equbuxu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

dn2048

braillebooks's Issues

Suggestion -- Adding hex codes, issues with line spacing

Since books can now support hex colour formats, I believe it's possible to implement this into the program to produce colours more accurate to the image given.

I've also encountered a problem where my images on the book would be stretched vertically, I believe this is due to how line spacing on the Minecraft books creates more vertical space.

Perhaps there could be an optional switch to compensate for this stretch?
Deforming the source image in the program could fix the issue, however this would decrease the image quality especially for stuff like pixel art where the image is to-scale to begin with,
or parts of the image can be 'erased' according to where the line spaces occur, which would conserve quality at the loss of parts of the image being erased.

Hopefully you're still working on this project, I've found this really useful as the only tool capable of bringing images to Minecraft books!

"Book too large!" error on paper server

Seemingly Paper servers believe books using these characters are part of some sort of item duplication hack or "ban book" hack, and auto-kick players who try to create them.

I understand this may not be a problem that BrailleBooks can really do anything about, and may just depend on Paper servers being smarter about checking for whether a book is part of some hack or just using unicode/wide characters like BrailleBooks does.

Steps to reproduce:

  1. Run a papermc server with no plugins
  2. Log in to the server with a minecraft client
  3. try to paste this in to a written book on the server:
    §0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀§8⣤§7⡄§8⣀⡀§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀§7⢀§8⣤⣤⣿⣿⣿⣧⣤⡀§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀§7⢀⣀§8⣴⣿§7⣿⣿⣿⣿⣿§8⣿⣿⣿§7⡆§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀§8⠘⣿§7⣿⣿§8⡿⢿§7⣿⣿§8⣿§7⣿⣿⣿⣿§8⣄§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀§7⣾§8⣿⣿⢯§7⡄§0⠀§8⠉⠉§7⢡§8⣿⣿⡽§7⢿⣿§8⣧§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀§7⣿§0⠀§8⣏§7⠈§0⠀⠀§7⠶⣂⣀§8⣸⣿⡇§7⢠§8⡟⠁§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀§7⠘⢷⣭⣟§8⡟§7⠛§8⢻⣿§7⡉⠉⠙§8⣦⠞§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀§7⠈§8⡇§0⠀§7⠘§8⢿⡏§0⠀§8⣀⣼§7⣇§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀§8⣿⣶⣿⣿⣿⣿⣿⣿⣿§7⡄§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀§8⠹⣿⣿⠿⠿⠿⠿⠻⣿§7⡇§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀§8⣼⣿§7⠆§0⠀⠀⠀§7⢠§8⣿⠇§0⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  4. click "done" and be auto-kicked.

Versions:
BrailleBooks version 1.0
Papermc version paper-1.17.1-154
Minecraft Client: 1.17.1

what is this?

Loading...
Resizing...

Unbehandelte Ausnahme: System.NullReferenceException: Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt.
bei BrailleBooks.Program.ResizeFrameList(List`1 frameList)
bei BrailleBooks.Program.Main(String[] args)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.