v1.1 (#8)

* v1.1 init commit:
- indent now 2 when using -i
- added optional crafting recipe
- replace HotV librarian reward

* Switch to config system. Bump version, fixes...

* more

* tweaks

* readme update

* Re-organise directories, add pack.png to data pack output, replace exe builder with icon, catch more errors, readme images + tweaks

* New build script and readme changes

Author: JiFish

.gitignore

@@ -128,5 +128,8 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# Babel output file
-babel.zip
+# VSCode
+*.code-workspace
+
+# Babel output zips
+*.zip

README.md

@@ -1,37 +1,58 @@
-# Babel Book Loot v1.0
-## A customisable pre-written book loot datapack for Minecraft
+![Logo](readme_images/logo.png)
 
-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.
+![Demo](readme_images/babel.gif)
+
+# Babel Book Loot v1.1
+## A customizable pre-written book loot data pack 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 customize the library by adding your own books.
 
 It was last updated for Minecraft 1.21.
 
 ## Quick-start
 
-Download [babel_v1.0.zip](https://github.com/JiFish/babel/releases/download/v1.0/babel_v1.0.zip) and place it in your Minecraft world's datapack directory.
-
-If you don't want zombies dropping books, download [babel-no-zombie-loot_v1.0.zip](https://github.com/JiFish/babel/releases/download/v1.0/babel-no-zombie-loot_v1.0.zip) instead.
+Download [babel_v1.1.zip](https://github.com/JiFish/babel/releases/download/v1.1/babel_v1.1.zip) and place it in your Minecraft world's `datapacks` directory.
 
-## How the datapack works in-game
+## How the data pack 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:
-- 69% Tattered Book
-- 30% Copy of a copy
+- 33% Tattered Book (not copyable)
+- 65% Copy of a copy (not copyable)
 - 1% Copy of original
 - <1% Original
 
-## Customising Books
+If you are hero of the village, librarians throw a guaranteed copyable book.
+
+## Pre-customized options
+
+These data packs are variations with tweaked rules for obtaining the books:
+
+- [babel-no-copying_v1.1.zip](https://github.com/JiFish/babel/releases/download/v1.1/babel-no-copying_v1.1.zip) - All books are "copy of a copy" and can't be duplicated. Also disables hero of the village reward.
+- [babel-no-zombie-loot_v1.1.zip](https://github.com/JiFish/babel/releases/download/v1.1/babel-no-zombie-loot_v1.1.zip) - Zombies don't drop books.
+- [babel-only-chests_v1.1.zip](https://github.com/JiFish/babel/releases/download/v1.1/babel-only-chests_v1.1.zip) - Books can only be found in chests. No zombie drops, fishing, or hero of the village reward.
+- [babel-recipe_v1.1.zip](https://github.com/JiFish/babel/releases/download/v1.1/babel-recipe_v1.1.zip) - Includes the below recipe to craft random books.
 
-First get babel-builder-windows_v1.0.zip or babel-builder-python_v1.0.zip from the [releases page](https://github.com/JiFish/babel/releases).
+#### Optional recipe
 
-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.
+If you got the version with the crafting recipe. Just combine 1 Book and Quill, 1 Soul Sand Block, 1 Chest, and 1 Emerald. (The recipe is shapeless.) This gives a chest which once placed will have a single random book inside.
+
+![Recipe Image](readme_images/optional_recipe.png)
+
+## Advanced customization using Babel Builder Tool
+
+First get babel-builder-windows_v1.1.zip or babel-builder-python_v1.1.zip from the [releases page](https://github.com/JiFish/babel/releases).
+
+Run `py babel.py` (or `babel.exe` in windows.) this will output `babel.zip`. Put that file in your Minecraft world's `datapacks` directory.
+
+### Changing included books
 
 Any books in the `books` directory will be included. You can add and remove books as you wish.
 
-Book can be in JSON or YAML formats. Here is a simple example:
+Books can be in JSON or YAML formats. Here are some simple examples:
 
-**sample_book.yaml**
+#### sample_book.yaml
 ```
 title: Sample Book
 author: Some Author
@@ -41,7 +62,7 @@ pages:
     - This is page three.
 ```
 
-**sample_book.json:**
+#### sample_book.json
 ```
 {
     "title": "Sample Book",
@@ -56,13 +77,13 @@ pages:
 
 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
+**Important note**: There is no easy way to find out how much text will fit on a page and Minecraft will allow pages longer than it can display. The simplest way to figure out the correct page lengths is to write the pages in minecraft itself, then copy the text out. [Text2Book](https://thewilley.github.io/Text2Book/) can assist you with splitting up your text.
 
-You can do more advanced stuff with books if you need it.
+**If you've made book files and the text is in the public domain, please consider submitting them back here!**
 
 #### Colors, formatting, etc.
 
-Your pages can be in [Raw JSON text format](https://minecraft.wiki/w/Raw_JSON_text_format) e.g.
+Your book pages can be in [Raw JSON text format](https://minecraft.wiki/w/Raw_JSON_text_format) e.g.
 
 ```
 {
@@ -74,7 +95,7 @@ Your pages can be in [Raw JSON text format](https://minecraft.wiki/w/Raw_JSON_te
 }
 ```
 
-#### Optional parameters
+#### Optional book 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.
@@ -104,62 +125,47 @@ An example using all optional parameters:
 }
 ```
 
-### 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
+#### 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 `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.
+### Changing other pack settings
 
-### For use making your own datapacks
-If you just want to generate the loot table without the surrounding files, try:
-```
-build_loottable.py > books.json
-```
+You can disable various loot drops, change generation chances, and make other customizations by editing `config.yaml`.
 
 ### Full argument list:
 ```
-usage: babel.py [-h] [-v] [-d {fishing,village,mansion,stronghold,zombie}]
-                [-i] [-!] [filename]
+usage: babel.py [-h] [-v] [-!] [-i] [-a] [filename]
 
 positional arguments:
-  filename              Optional output zip filename. (default: babel.zip)
+  filename              Configuration filename. (default: config.yaml)
 
 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.)
+  -!, --no-wait         Don't wait for user input when finished. (Windows version only.)
+  -i, --indent          Indent output json files. Overrides config field.
+  -a, --append-version  Append babel version number to output filename.
 ```
 
+## Use with other data packs
+
+### Using as part of your own data packs
+You can add books to other loot tables using type `minecraft:loot_table` and value `babel:books`.
+
+If you just want to generate the loot table without the surrounding files, try running: `py build_loottable.py > books.json`
+
+### Dealing with data pack conflicts
+If any of your other data packs modify loot tables used by babel, it might be possible to create a compatible pack. To do this, replace the loot tables in the `data/base_loot_tables` with the versions from the conflicting data pack. Then make sure this data pack is loaded before the conflicting one. This isn't guaranteed to work, and won't if the tables are much different from expected.
+
 ## Comments, suggestions or contributions?
 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 very appreciated, but not required.
+## Copyright & use in your own data packs
+Assuming the books are your own work, loot tables outputted by babel belong to you. You can use them freely in your own data pack. A credit is very appreciated, but not required.
 
-Books in the `books` directory are in the public domain. The `books.json` file created from them is also in the public domain.
+Books in the `books` directory are in the public domain, sourced from [Project Gutenberg](https://www.gutenberg.org/). The `books.json` file created from them is also in the public domain.
 
-The babel tool and datapack is copyright Joseph Fowler.
+The babel tool and data pack is copyright Joseph Fowler.
 
 ## Disclaimer
 

babel.gif

@@ -1,64 +1,106 @@
+# By Joseph "JiFish" Fowler. All rights reserved.
+
 import argparse
 import sys
+import yaml;
+import os;
 from build_datapack import *
+from build_loottable import *
 
-isCompiled = getattr(sys, 'frozen', False)
-isUsingDefaults = (len(sys.argv) < 2)
-validLootTableList = ['fishing', 'village', 'mansion', 'stronghold', 'zombie']
-greeting = "Babel Book Loot Generator, v1.0%s" % (' (Windows)' if isCompiled else '')
-
-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)
+def loadAndValidateYaml(yamlFilePath):
+    # Load the YAML file
+    with open(yamlFilePath, 'r') as file:
+        data = yaml.safe_load(file)
+    
+    # Define the required fields and their types
+    requiredFields = {
+        'output-filename': str,
+        'books-path': str,
+        'add-crafting-recipe': bool,
+        'add-fishing-loot': bool,
+        'add-village-loot': bool,
+        'add-mansion-loot': bool,
+        'add-stronghold-loot': bool,
+        'add-zombie-drop': bool,
+        'replace-hero-of-the-village-gift': bool,
+        'indent-output': bool,
+        'copy-of-copy-chance': float,
+        'copy-of-original-chance': float,
+        'original-chance': float,
+    }
+    
+    # Check for unrecognized fields
+    for field in data:
+        if field not in requiredFields:
+            raise ValueError(f"Unrecognized field: {field}")
+    
+    # Validate the fields
+    for field, fieldType in requiredFields.items():
+        if field not in data:
+            raise ValueError(f"Missing required field: {field}")
+        
+        # Floats can also be ints, convert now
+        if type(data[field]) == int:
+            data[field] = float(data[field])
+        
+        value = data[field]
+        if not isinstance(value, fieldType):
+            raise TypeError(f"Incorrect type for field '{field}'. Expected {fieldType.__name__}, got {type(value).__name__}.")
+        
+        # For float fields, ensure they are between 0 and 1
+        if fieldType is float and not (0 <= value <= 1):
+            raise ValueError(f"Field '{field}' must be between 0 and 1. Got {value}.")
+    
+    return data
 
-    if x < 0.0 or x > 1.0:
-        raise argparse.ArgumentTypeError(error % x)
-    return x
+isCompiled = getattr(sys, 'frozen', False)
+version = "v1.1%s" % (' (Windows)' if isCompiled else '')
 
 parser = argparse.ArgumentParser()
-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')
+parser.add_argument('filename', help='Optional config filename. (default: %(default)s)', nargs='?', default='config.yaml')
+parser.add_argument('-v', '--version', action='version', version=version)
+parser.add_argument('-i', '--indent', action='store_true', help="Indent output json files. Overrides config field.")
+parser.add_argument('-a', '--append-version', action='store_true', help="Append babel version number to output filename.")
+
 if isCompiled:
     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()
+                        help="Don't wait for user input when finished.")
+    # Handle windows style help arg
+    if len(sys.argv) == 2 and sys.argv[1] == '/?':
+        sys.argv[1] = '--help'
 
-if args.indent:
-    indent = 4
-else:
-    indent = None
+args = parser.parse_args()
 
-print("\n"+greeting)
-print("="*len(greeting)+"\n")
+print("")
+print("░█▀▄░█▀█░█▀▄░█▀▀░█░░░░░█▀▄░█▀█░█▀█░█░█░░░█░░░█▀█░█▀█░▀█▀")
+print("░█▀▄░█▀█░█▀▄░█▀▀░█░░░░░█▀▄░█░█░█░█░█▀▄░░░█░░░█░█░█░█░░█░")
+print("░▀▀░░▀░▀░▀▀░░▀▀▀░▀▀▀░░░▀▀░░▀▀▀░▀▀▀░▀░▀░░░▀▀▀░▀▀▀░▀▀▀░░▀░ " + version)
+print('By JiFish. email: %s' % 'ku.oc.hsifij@eoj'[::-1])
+print("")
 
-if isUsingDefaults:
-    print("Using default configuration, for more options try %s -h\n" % sys.argv[0])
+print("Using configuration: %s.\n" % args.filename)
 
 try:
-    from build_loottable import loottable
-    print ("Found %d books." % len(loottable['pools'][0]['entries']))
+    config = loadAndValidateYaml(args.filename)
+
+    # indent arg overrides config field
+    if args.indent:
+        config['indent-output'] = True
+
+    # Append version alters 'output-filename'
+    if args.append_version:
+        filename, extension = os.path.splitext(config['output-filename'])
+        config['output-filename'] = filename + '_' + version + extension
+
+    loottable = buildLootTable(config)
 
-    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 ("\nBuilding data pack...")
+    buildDatapack(config, loottable, version)
+    print ("Data pack build complete!\n\nCopy %s to your world's 'datapacks' directory." % config['output-filename'])
 
 except Exception as e:
     print("\nError: "+str(e))
 
 finally:
-    if isCompiled and isUsingDefaults:
+    if isCompiled and not args.no_wait:
         input("\nPress ENTER or close this window.")