{"id":20740146,"url":"https://github.com/bjorntheprogrammer/library-books","last_synced_at":"2026-04-21T12:01:59.254Z","repository":{"id":65932122,"uuid":"602620986","full_name":"BjornTheProgrammer/Library-Books","owner":"BjornTheProgrammer","description":"A simple plugin, which allows you to easily add books into your Minecraft server.","archived":false,"fork":false,"pushed_at":"2023-02-22T01:05:42.000Z","size":1253,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-18T01:43:53.853Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","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/BjornTheProgrammer.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":"2023-02-16T15:43:39.000Z","updated_at":"2023-02-17T02:22:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"417b141c-3b0d-4dc2-9df7-b79e9876f1da","html_url":"https://github.com/BjornTheProgrammer/Library-Books","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/BjornTheProgrammer%2FLibrary-Books","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BjornTheProgrammer%2FLibrary-Books/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BjornTheProgrammer%2FLibrary-Books/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BjornTheProgrammer%2FLibrary-Books/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BjornTheProgrammer","download_url":"https://codeload.github.com/BjornTheProgrammer/Library-Books/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243030778,"owners_count":20224663,"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":[],"created_at":"2024-11-17T06:27:33.715Z","updated_at":"2026-04-21T12:01:59.213Z","avatar_url":"https://github.com/BjornTheProgrammer.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Book_JE2_BE2](https://user-images.githubusercontent.com/75190918/219589419-c6e1c62c-9742-4adc-a65d-72b361143a6e.png)\n# Library-Books\nA simple plugin, which allows you to easily add books into your Minecraft server.\n\n## Building the Plugin\nJust run compile.sh, having the java SDK installed via the command `./compile.sh`, then grab the `Library.jar` file which is now generated in this directory, and install by adding to your server's `plugins/` folder.\n\nAlternatively, just download the latest release from the listed releases in the sidebar in GitHub.\n\n## Setup\nOnce you have the plugin in your `plugins/` folder, you need to add the books, and the relevant chapters to the plugin directory.\n\nEverything is dependent on file structure. Every folder under Library will be displayed as a book. Every text file under a book will be a chapter, except the information.txt file. As seen below.\n\n```\nplugins/\n├─ Library/\n│ ├─ Odyssey/\n│ │ ├─ 1_1.txt\n│ │ ├─ 2_2.txt\n│ │ ├─ 3_3.txt\n│ │ ├─ 4_4.txt\n│ │ ├─ 5.txt\n│ │ ├─ 5_ending.txt\n│ │ ├─ information.txt\n├─ Library.jar\n```\n\nThe number before the underscore in the text file name denotes placement when listing off chapters in the book. The second number is just the name of the chapter.\nAs such `\u003cplacement\u003e_\u003cname\u003e.txt`\n\nNote that without the placement number and underscore, the placement of chapters when displayed to the player will be completely unpredictable, and items with placement numbers will always come before those without.\n\nFinally, information.txt has to look like the following...\n```\nauthor: Homer\ndescription: The Odyssey is an epic poem in 24 books traditionally attributed to the ancient Greek poet Homer.​\n```\n\nSo when calling `/read Odyssey`, the output will look something like this...\n\n```\nThe Odyssey is an epic poem in 24 books traditionally attributed to the ancient Greek poet Homer.\nType `/read Odyssey \u003cchapter\u003e` to view chapters for the book.\nBelow is a list of currently available chapters...\n1, 2, 3, 4, ending, 5\n```\n\n\nDo note that the largest size of a book is 100 pages, so if you have any books that need to be larger, split the chapters into 2.\n\nAdditionally, be cognizant that too many books in one chunk can cause players in that chunk to crash (blame 2b2t for that).\n\n## Commands\n![20fd2e023b12a67d50d55b4a19cee9cf52ecabb9](https://user-images.githubusercontent.com/75190918/219431708-be0811ff-4aba-44bd-9bc7-f969a4beff28.png)\n\nType `/read` to list off books contained within the `plugins/Library` directory on your server.\n\nType `/read \u003cbookname\u003e` to list off chapters and description of book contained within `plugins/Library/\u003cbookname\u003e` directory.\n\nType `/read \u003cbookname\u003e \u003cchapter\u003e` to get the Minecraft book with the chapter's text of the full book contained within `/plugins/Library/\u003cbookname\u003e/\u003cchapter\u003e.txt` file.\n  \n  ![20fd2e023b12a67d50d55b4a19cee9cf52ecabb9](https://user-images.githubusercontent.com/75190918/219434053-73910859-ac00-4a7a-8ae9-fe6a28ccf16d.png)\n\nType `/library` to view an interactive inventory with every book and their information.\n\nType `/library \u003cbookname\u003e` to view an interactive inventory with every chapter from the book.\n\n\u003cimg width=\"1440\" alt=\"Screenshot 2023-02-21 at 5 44 41 PM\" src=\"https://user-images.githubusercontent.com/75190918/220493808-0125653e-26cb-45d7-8745-eba2bf4b92bd.png\"\u003e\n\n\u003cimg width=\"1440\" alt=\"Screenshot 2023-02-21 at 5 44 58 PM\" src=\"https://user-images.githubusercontent.com/75190918/220493839-9387a910-1c1a-43b1-bb33-c8044b52a081.png\"\u003e\n\n## Permissions\nFive permissions come by default\n1. library.read: Needed to use the `/read` command\n2. library.read.books: Needed to use the `/read \u003cbookname\u003e`\n3. library.read.books.chapter: Needed to use the `/read \u003cbookname\u003e \u003cchapter\u003e` and get book\n4. library.library: Needed to use the `/library` command\n6. library.library.book: Needed to use the `/library \u003cbookname\u003e` command\n\nThen there are permissions which are created upon making a book. It will be in the format `library.\u003cbookname\u003e` to be able to read the description of the book and get all chapters of the book. Then there is the permission `library.\u003cbookname\u003e.\u003cchapter\u003e` which allows the user to only read that chapter from the book.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbjorntheprogrammer%2Flibrary-books","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbjorntheprogrammer%2Flibrary-books","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbjorntheprogrammer%2Flibrary-books/lists"}