initial commit for shared version repo of Batteries mod - currently supports 1.21.11 and 1.21.1 of NeoForge.

README.md

@@ -0,0 +1,117 @@
+# Batteries
+
+Batteries is a tech mod for Minecraft using NeoForge. It's a port of my old 1.16 Batteries mod, with some additional features.
+
+The mod focuses on charging items in your inventory in a configurable way.
+
+This mod was born out of frustration with having a "power-hungry" item that sucked up all battery charge, leaving other items in my inventory with no charge.
+
+Instead, each battery in this mod lets you configure what and how it charges.
+
+## Features
+
+### Batteries
+![Screenshot1.png](Screenshot1.png)
+
+The mod adds a battery progression with multiple tiers:
+
+- Basic Battery
+- Advanced Battery
+- Elite Battery
+- Ultimate Battery
+- Ender Battery
+- Creative Battery
+
+Batteries can be charged in your choice of the Charger (included in this mod) or any other mod's charger functionality.
+
+Each battery can be configured to charge:
+
+- hotbar items
+- main inventory items
+- worn armor and offhand items
+- nearby machines
+
+The battery GUI also supports:
+
+- whitelist and blacklist mode: only charge the things you want to charge
+- fair charging: don't let power-hungry items sap all your battery's energy; a battery configred with fair charging will charge items to equilibrium
+
+Ender Batteries can be linked to an Ender Charger for remote charging while carried by the player.
+
+### Chargers
+![Screenshot4.png](Screenshot4.png)
+
+The mod includes two charger blocks:
+
+- Charger
+- Ender Charger
+
+The regular Charger accepts normal batteries and charges them from inserted power.
+
+The Ender Charger accepts a linked Ender Battery and sends energy into that linked battery while the charger remains loaded and the Ender battery is in the player's inventory.
+
+### Battery Block
+![Screenshot3.png](Screenshot3.png)
+
+The Battery Block is a placeable energy storage block.
+
+It provides:
+
+- internal energy storage
+- a configurable sided I/O GUI
+- charge-level visuals on the block face
+- capacity upgrades by crafting with batteries or additional Battery Blocks
+
+### Coal Generator
+
+The Coal Generator is a simple starter power source.
+
+It:
+
+- burns any furnace fuel
+- generates configurable energy per tick
+- outputs energy on all sides
+- accepts fuel through its GUI
+- accepts fuel automation from item insertion via hoppers or other mods' item transport
+### Battery-Powered Gear
+![Screenshot2.png](Screenshot2.png)
+
+The mod adds battery-powered variants of gear:
+
+- Diamond sword and tools
+- Diamond armor
+- Shield
+- Bow
+
+Battery-powered items:
+
+- Are crafted with their respective item + one or more batteries
+- Can have their energy capacity upgraded by crafting with additional batteries at any time
+- Use energy instead of durability
+- Use configurable additional energy per enchantment
+- Stop functioning if out of energy, but don't break
+- otherwise function identically to their non-powered versions
+
+Notably:
+
+- Mending and Unbreaking don't do anything on enchanted battery-powered items
+
+### Recipes and Upgrades
+
+- When crafting batteries or battery-powered items, they retain the charge they had, if any
+- Batteries can be combined to make a new battery with larger capacity
+- Battery Blocks can be combined with other Battery Blocks or Batteries to make a new Battery Block with larger capacity
+- Battery-powered gear can similarly be upgraded with more battery storage
+- Any recipe that takes a Battery or Battery Block can take one or more of those items to grant more energy capacity
+
+### Debug Commands
+
+The mod includes a `/batteries` command for testing and development.
+
+Current commands include:
+
+- `/batteries charge held|hotbar|inventory|all [amount]`
+- `/batteries drain held|hotbar|inventory|all [amount]`
+- `/batteries kit`
+
+`/batteries kit` places a chest in front of the player containing the vanilla materials and base gear needed to craft the mod content from scratch.