1.0 dev (#7)

* 1.0 dev wip

* v1.0 - support for minecraft 1.20.6 and 1.21

Author: JiFish

README.md

@@ -1,43 +1,124 @@
-# Babel Book Loot v0.5
+# Babel Book Loot v1.0
 ## A customisable pre-written book loot datapack for Minecraft
 
 Babel Book Loot adds over 100 pre-written books to various loot tables in Minecraft. The default library of books is a collection of public domain fairy tales. You can customise the library by adding your own text files.
 
-It was last updated for Minecraft 1.18.2, but it should work in a wide range of versions.
+It was last updated for Minecraft 1.21.
 
 ## Quick-start
-Run `babel.py`. It will generate babel.zip. Put that file in your Minecraft world's datapack directory.
 
-Run `babel.py -h` to see more options.
+Download [babel_0.6.zip]() and place it in your Minecraft world's datapack directory.
+
+If you don't want zombies dropping books, download [babel_0.6_no_zombies.zip]() instead.
 
 ## How the datapack works in-game
+
 Written books can be dropped by zombies if killed by a player, or fished up with a fishing rod. They can also be found in villages, stronghold libraries and woodland mansions in chests.
 
-The generation of the book is determined randomly
+The generation of the book is determined randomly:
 - 69% Tattered Book
 - 30% Copy of a copy
 - 1% Copy of original
 - <1% Original
 
 ## Customising Books
+
+Run `py babel.py` (or `babel.exe` in windows.) this will output `babel.zip`. Put that file in your Minecraft world's datapack directory. Run `babel.py -h` to see more options.
+
 Any books in the `books` directory will be included. You can add and remove books as you wish.
 
-To create your own books go to https://minecraft.tools/en/book.php Once you've finished copy the command and delete the text `/give @p written_book` from the start. Then save it in `books` as `<Your Title>.json`.
+Book can be in JSON or YAML formats. Here is a simple example:
+
+**sample_book.yaml**
+```
+title: Sample Book
+author: Some Author
+pages:
+    - This is page one.
+    - This is page two.
+    - This is page three.
+```
+
+**sample_book.json:**
+```
+{
+    "title": "Sample Book",
+    "author": "Some Author",
+    "pages": [
+        "This is page one.",
+        "This is page two.",
+        "This is page three."
+    ]
+}
+```
+
+Minecraft accepts strictly non-valid JSON, so babel tries to too. Babel does it's best to read the books, but if it's having issues your best bet is to ensure the file is valid JSON.
+
+### Advanced Books
+
+You can do more advanced stuff with books if you need it.
+
+#### Colors, formatting, etc.
+
+Your pages can be in [Raw JSON text format](https://minecraft.wiki/w/Raw_JSON_text_format) e.g.
+
+```
+{
+    "title": "Sample Book",
+    "author": "Some Author",
+    "pages": [
+        [{"text":"Hello ","color":"dark_red"},{"text":"World","bold":true},{"text":"!"}],
+    ]
+}
+```
+
+#### Optional parameters
+
+Book files can contain the following optional parameters:
+- `weight` - The chance this book will be selected vs others in the table. Default is `1`, so a value of `2` would mean the book is twice as likely to be selected.
+- `lore` - Item lore text. Works like `pages`.
+- `custom_model_data` - Sets item's custom_model_data value to allow the book a unique texture via a resource pack.
+- `custom_data` - Sets item's custom data. Can be a string containing nbt tags, or the tags themselves.
+
+An example using all optional parameters:
+
+```
+{
+    "title": "Another Sample Book",
+    "author": "Some Author",
+    "pages": [
+        "Hello World!",
+    ],
+    "weight": 2,
+    "lore": [
+        [{"text":"Lore line 1","color":"blue"}],
+        "Lore line 2"
+    ],
+    "custom_model_data": 42,
+    "custom_data": {
+        "foo": "bar",
+        "number": 16
+    }
+}
+```
 
 ### Submitting books
 If you've made some books and the text is in the public domain, please consider submitting them back here!
 
 ### Default library
 The default collection of books was sourced from Project Gutenberg. https://www.gutenberg.org/
 
+### Updating books from v0.5
+If you already have books in the v0.5 format, you can update them by running `update_books.py`. The books directory must only contain v0.5 format books. The script will also overwrite the originals, so keep a backup.
+
 ## Advanced Customisation
 ### Altering where books will be found
 You can disable various book drops using command line options. Use `babel.py -h` to see the complete list. An example where zombies do not drop books:
 ```
 babel.py -d zombie
 ````
 
-You can add books to other loot tables using type `loot_table` and name `babel:books`.
+You can add books to other loot tables using type `minecraft:loot_table` and value `babel:books`.
 
 ### Dealing with datapack conflicts
 If any of your other datapacks modify loot tables used by babel, it might be possible to create a compatible pack. To do this, replace the loot tables in the `base_loot_tables` with the ones from the conflicting datapack. This isn't guaranteed to work, and won't if the tables are much different from expected.
@@ -48,21 +129,36 @@ If you just want to generate the loot table without the surrounding files, try:
 build_loottable.py > books.json
 ```
 
-### Advanced Customising Books
-If you build your own datapacks, you have probably noticed the format of books the `books` directory is JSON. Minecraft accepts strictly non-valid JSON, so babel tries to too. Babel does it's best to read the books, but if it's having issues your best bet is to ensure the file is valid JSON.
-
-The JSON determines the NBT tags to be added to the Written Book item. See the [full specification](https://minecraft.fandom.com/wiki/Player.dat_format#Written_Books) for more information. You could even add other tags such as `CustomModelData`.
-
-Bonus tip: Babel actually uses a YAML parser to read the books, so you can format your books as YAML if you wish.
+### Full argument list:
+```
+usage: babel.py [-h] [-v] [-d {fishing,village,mansion,stronghold,zombie}]
+                [-i] [-!] [filename]
+
+positional arguments:
+  filename              Optional output zip filename. (default: babel.zip)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -v, --version         show program's version number and exit
+  -d {fishing,village,mansion,stronghold,zombie}
+                        Disable adding books to the given loot tables. Can be
+                        repeated to disable more than one.
+  -i, --indent          Indent output JSON files.
+  -!, --no-wait         Don't wait for user input when finished. Triggered
+                        automatically by using any other argument. (Windows
+                        version only.)
+```
 
 ## Comments, suggestions or contributions?
-Please use the Issue Tracker on GitHub, or send me a tweet [@JiFish](https://twitter.com/intent/tweet?text=.@JiFish)
+Please use the Issue Tracker on GitHub, or send me a tweet [@JiFish](https://twitter.com/intent/tweet?text=.@JiFish) or Toot [@joe@social.jifish.co.uk](https://social.jifish.co.uk/@joe).
 
 ## Copyright & use in your own datapacks
-Assuming the books are your own work, loot tables outputted by babel belong to you. You can use them freely in your own datapack. A credit is apprecicated, but not required.
+Assuming the books are your own work, loot tables outputted by babel belong to you. You can use them freely in your own datapack. A credit is very appreciated, but not required.
 
-Books in the `books` directory are in the public domain. The loot table created from them is also in the public domain.
+Books in the `books` directory are in the public domain. The `books.json` file created from them is also in the public domain.
 
 The babel tool and datapack is copyright Joseph Fowler.
 
-Disclaimer: Software provided is "as is", without a warranty, and should be used at your own risk.
+## Disclaimer
+
+Software provided is "as is", without a warranty, and should be used at your own risk.

babel.py

@@ -1,84 +1,64 @@
-import zipfile
-import json
 import argparse
 import sys
+from build_datapack import *
 
 isCompiled = getattr(sys, 'frozen', False)
 isUsingDefaults = (len(sys.argv) < 2)
 validLootTableList = ['fishing', 'village', 'mansion', 'stronghold', 'zombie']
-greeting = "Babel Book Loot Generator, v0.5%s" % (' (Windows)' if isCompiled else '')
+greeting = "Babel Book Loot Generator, v1.0%s" % (' (Windows)' if isCompiled else '')
 
-print("\n"+greeting)
-print("="*len(greeting)+"\n")
+def restricted_float(x):
+    error = "%r not a value between 0.0 and 1.0"
+    try:
+        x = float(x)
+    except ValueError:
+        raise argparse.ArgumentTypeError(error % x)
+
+    if x < 0.0 or x > 1.0:
+        raise argparse.ArgumentTypeError(error % x)
+    return x
 
 parser = argparse.ArgumentParser()
-parser.add_argument('filename', help='Optional output zip filename. Default: babel.zip', nargs='?', default='babel.zip')
-parser.add_argument('-d', dest="loottable", default=[], action='append', help='Disable adding books to one of the following loot tables: '+
-                    ', '.join(validLootTableList)+'. Can be repeated to disable more than one.')
-parser.add_argument('-c', '--clean', help='Indent output JSON files.', action='store_true')
+parser.add_argument('filename', help='Optional output zip filename. (default: %(default)s)', nargs='?', default='babel.zip')
+parser.add_argument('-v', '--version', action='version', version=greeting)
+parser.add_argument('-d', dest="loottable", default=[], action='append', choices=validLootTableList,
+                    help='Disable adding books to the given loot tables. Can be repeated to disable more than one.')
+# parser.add_argument('--gen2', action='store', type=restricted_float, default=0.3, metavar="CHANCE",
+                    # help="Chance a book will be marked as a 'Copy of a copy', between 0.0 and 1.0. (default: %(default)s)")
+# parser.add_argument('--gen1', action='store', type=restricted_float, default=0.01, metavar="CHANCE",
+                    # help="Chance a book will be marked as a 'Copy of original', between 0.0 and 1.0. (default: %(default)s)")
+# parser.add_argument('--gen0', action='store', type=restricted_float, default=0.003, metavar="CHANCE",
+                    # help="Chance a book will be marked as an 'Original', between 0.0 and 1.0. (default: %(default)s)")
+#parser.add_argument('-l', '--loottable', action='store_true',
+                    # help="Don't build the datapack, instead just output the loot table. The default filename is books.json.")
+parser.add_argument('-i', '--indent', help='Indent output JSON files.', action='store_true')
 if isCompiled:
-    parser.add_argument('-!', '--no-wait', help="Don't wait for user input at the end of the build. Triggered automatically by using any other argument.",
-                        action='store_true')
+    parser.add_argument('-!', '--no-wait', action='store_true',
+                        help="Don't wait for user input when finished. Triggered automatically by using any other argument.")
 args = parser.parse_args()
 
-if set(args.loottable).issubset(validLootTableList) == False:
-    print("ERROR: Invalid input on -d argument\n")
-    parser.print_help()
-    exit(1)
-
-if args.clean:
+if args.indent:
     indent = 4
 else:
     indent = None
 
+print("\n"+greeting)
+print("="*len(greeting)+"\n")
+
 if isUsingDefaults:
     print("Using default configuration, for more options try %s -h\n" % sys.argv[0])
 
-print ("Importing Books... (This may take a while.)")
-from build_loottable import loottable
-print ("Found %d books." % len(loottable['pools'][0]['entries']))
+try:
+    from build_loottable import loottable
+    print ("Found %d books." % len(loottable['pools'][0]['entries']))
 
-def addToLootTable(lootfilename, weight = 1, pool = 0):
-    global indent
-    with open('base_loot_tables/'+lootfilename, 'r') as lootfile:
-        lootjson = json.loads(lootfile.read())
-    lootjson['pools'][pool]['entries'].append({
-        'type': 'loot_table',
-        'weight': weight,
-        "name": "babel:books"
-    })
-    return json.dumps(lootjson, indent=indent, ensure_ascii=False)
+    print ("Building datapack...")
+    buildDatapack(args.filename, args.loottable, loottable, indent=indent)
+    print ("\nDatapack build complete! Copy %s to your world's datapack directory." % args.filename)
 
-print ("Building datapack...")
-zf = zipfile.ZipFile(args.filename, mode='w')
-zf.writestr('pack.mcmeta', json.dumps({
-    "pack": {
-        "pack_format": 9,
-        "description": "Add pre-written books to your vanilla world"
-    }
-}, indent=indent, ensure_ascii=False))
-zf.writestr('data/babel/loot_tables/books.json', json.dumps(loottable, indent=indent, ensure_ascii=False))
-if 'stronghold' not in args.loottable:
-    print ("Adding to Stronghold Library loot table.")
-    zf.writestr('data/minecraft/loot_tables/chests/stronghold_library.json', addToLootTable('stronghold_library.json',15))
-if 'mansion' not in args.loottable:
-    print ("Adding to Woodland Mansion loot table.")
-    zf.writestr('data/minecraft/loot_tables/chests/woodland_mansion.json', addToLootTable('woodland_mansion.json',5))
-if 'village' not in args.loottable:
-    print ("Adding to Village loot table.")
-    zf.writestr('data/minecraft/loot_tables/chests/village/village_desert_house.json', addToLootTable('village_desert_house.json',3))
-    zf.writestr('data/minecraft/loot_tables/chests/village/village_plains_house.json', addToLootTable('village_plains_house.json',3))
-    zf.writestr('data/minecraft/loot_tables/chests/village/village_savanna_house.json', addToLootTable('village_savanna_house.json',3))
-    zf.writestr('data/minecraft/loot_tables/chests/village/village_snowy_house.json', addToLootTable('village_snowy_house.json',3))
-    zf.writestr('data/minecraft/loot_tables/chests/village/village_taiga_house.json', addToLootTable('village_taiga_house.json',3))
-if 'fishing' not in args.loottable:
-    print ("Adding to Fishing Treasure loot table.")
-    zf.writestr('data/minecraft/loot_tables/gameplay/fishing/treasure.json', addToLootTable('treasure.json',1))
-if 'zombie' not in args.loottable:
-    print ("Adding to Zombie drop loot table.")
-    zf.writestr('data/minecraft/loot_tables/entities/zombie.json', addToLootTable('zombie.json',1,1))
-zf.close()
-print ("\nDatapack build complete! Copy %s to your world's datapack directory." % args.filename)
+except Exception as e:
+    print("\nError: "+str(e))
 
-if isCompiled and isUsingDefaults:
-    input("\nPress ENTER or close this window.")
+finally:
+    if isCompiled and isUsingDefaults:
+        input("\nPress ENTER or close this window.")