{"id":16379163,"url":"https://github.com/neocky/text2mcbook","last_synced_at":"2025-03-23T03:32:53.770Z","repository":{"id":65727744,"uuid":"350150952","full_name":"Neocky/Text2McBook","owner":"Neocky","description":"📚 Convert any textfile to a formatted text for minecraft books","archived":false,"fork":false,"pushed_at":"2025-01-04T00:14:37.000Z","size":38,"stargazers_count":16,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-18T17:14:28.846Z","etag":null,"topics":["bukkit","denizen","minecraft","minecraft-books","paper","python","spigot","textfile"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Neocky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-21T23:54:11.000Z","updated_at":"2025-02-17T10:45:49.000Z","dependencies_parsed_at":"2024-10-28T15:23:56.740Z","dependency_job_id":"5f622108-b88e-4993-9695-3a6075771dbd","html_url":"https://github.com/Neocky/Text2McBook","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Neocky%2FText2McBook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Neocky%2FText2McBook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Neocky%2FText2McBook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Neocky%2FText2McBook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Neocky","download_url":"https://codeload.github.com/Neocky/Text2McBook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245052639,"owners_count":20553162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","denizen","minecraft","minecraft-books","paper","python","spigot","textfile"],"created_at":"2024-10-11T03:47:40.348Z","updated_at":"2025-03-23T03:32:53.491Z","avatar_url":"https://github.com/Neocky.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cpicture\u003e\n  \u003cimg src=\"https://github.com/Neocky/Text2McBook/assets/13088544/e138462c-8ecd-4a6f-ad68-aeb77764fee1\" alt=\"Lorem ipsum preview book\" height=\"300px\"\u003e\n\u003c/picture\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\n  Text2McBook\n\u003c/h1\u003e\n\n📚 Convert any text file to a formatted text for minecraft books to use them as easily as possible ingame.\n\n## Issues? Found a bug?\n\n[Create an issue.](https://github.com/Neocky/Text2McBook/issues/new/choose) \n\n## About\n\nThis 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.  \nIt supports different book formats which can be chosen with the parameter [`-f FORMATNAME`](https://github.com/Neocky/Text2McBook#parmaters).  \nI got inspiration from a post from [r/admincraft](https://www.reddit.com/r/admincraft/).\n\n### Default\n\nThe `default` format will create a `/give` command which can be easily copied into a command block ingame to get the writable book.\nIt will also format the text in a way in which it can be easily copy and pasted in a book in the game. \n\n### Denizen\n\n[Denizen](https://denizenscript.com/) is a scripting plugin for minecraft servers.  \nThe `denizen` format will format the text for the `text` property in [Book Script Containers](https://meta.denizenscript.com/Docs/Search/book#book%20script%20containers). It will replace new line symbols with `\u003cn\u003e` and indents the line with 4 spaces to make it easily pasteable in the `text` properties of `book script containers`.  \n\n## Installation\n\n### Python\n\nPython (minimum: Version 3.10.4) needs to be installed on your machine.  \nGet it [here](https://www.python.org/downloads/).\n\n### Clone the repository / Download the latest release\n\nDownload the script:  \nClone the repository or get the latest release [here](https://github.com/Neocky/Text2McBook/releases).\n\n## Usage\n\nCreate/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.  \nThis is the text that you want to be converted to a minecraft book format.  \nRun the script: `text2mcbook.py`.  \nNow a `booktext.txt` file should be created.  \nIn 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 \u0026 paste in a book in minecraft.\n\n\n## Advanced Usage\n\n### Parametrs\n\nThis script supports the following parameters to change the usage for the script.\n\n#### Get help about all available parameters\n\n```shell\npy text2mcbook.py -h\n```\n\n#### Input file\n\n```shell\npy text2mcbook.py INPUTFILENAME\n```\n\nDefault: `text.txt`  \nChanges the input file.\n\n#### Output file\n\n```shell\npy text2mcbook.py INPUTFILENAME OUTPUTFILENAME\n```\n\nDefault: `booktext.txt`  \nChanges the output file.\n\n#### Book format\n\n```shell\npy text2mcbook.py -f FORMAT\npy text2mcbook.py --format FORMAT\n```\n\nDefault: `default`  \nPossible Values: `default`, `denizen`  \nChanges the book format and the resulting formatting.\n\n#### Characters per line\n\n```shell\npy text2mcbook.py -c NUMBEROFCHARACTERSPERLINE\npy text2mcbook.py --characterlimit NUMBEROFCHARACTERSPERLINE\n```\n\nDefault: `19`  \nThe number of characters one book line can have.  \nWarning: Don't set it to high or you are risking the loss of words!\n\n### Examples\n\n#### Example 1\n```shell\npy text2mcbook.py book_to_convert.txt book_formatted.txt\n```\n\nChanges the input file to `book_to_convert.txt` and outupts the formatted book text to `book_formatted.txt`.\n\n#### Example 2\n\n```shell\npy text2mcbook.py -f denizen -c 20\n```\n\nOutputs denizen formated text, which can be used in the `text` propert of [Book Script Containers](https://meta.denizenscript.com/Docs/Search/book#book%20script%20containers) in [Denizen](https://denizenscript.com/). Also changes the number of characters per line to 20. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneocky%2Ftext2mcbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneocky%2Ftext2mcbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneocky%2Ftext2mcbook/lists"}