diff --git a/README.md b/README.md index d5d9f6b..3e5b68e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,241 @@ -# GrindstoneMC +
-Grindstone is a Minecraft Modpack built to supply a near-endless grind. \ No newline at end of file +# BLADEWORKS Grind Pack + +**An endless-grind NeoForge 1.21.1 modpack built around Create, combat progression, and player-driven economy.** + +![Minecraft](https://img.shields.io/badge/Minecraft-1.21.1-62B47A?style=flat-square) +![NeoForge](https://img.shields.io/badge/NeoForge-21.1.x-D9522C?style=flat-square) +![Status](https://img.shields.io/badge/Status-In_Development-FFA500?style=flat-square) +![Mods](https://img.shields.io/badge/Mods-~370-8A2BE2?style=flat-square) +![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square) + +*Built by [BLADEWORKS](https://bladeworks.dev) · Hosted on the SCOPENET homelab* + +
+ +--- + +## Overview + +BLADEWORKS Grind Pack is a Create-centric modpack designed around a **nearly endless progression loop**. It blends deep automation, souls-like combat, extensive magic systems, player-driven economy, and comprehensive exploration into a single cohesive experience. + +The pack is optimized for long-form multiplayer on dedicated servers, with careful attention to performance at scale and a progression system designed to reward both casual grinders and hardcore min-maxers. + +## Features + +- **Create-Centric Automation** — Create and 15+ addons form the foundation of all progression +- **Souls-Like Combat** — Epic Fight + skill trees, Apotheosis affixes, and a full magic system via Iron's Spells & Ars Nouveau +- **Deep Exploration** — 4 biome overhauls, 40+ structure mods, 5 new dimensions, and hundreds of new mobs +- **Player-Driven Economy** — Numismatic currency, player shops, and no admin intervention +- **Unique Travel** — Trains, airships (Valkyrien Skies), small ships, aircraft, and gliders +- **Quest-Guided Progression** — 200+ FTB Quests spanning early game to endgame +- **Server-First Design** — BlueMap, LuckPerms, FTB Chunks claiming, and full backup infrastructure + +## System Requirements + +| Component | Minimum | Recommended | +|-----------|---------|-------------| +| **Client RAM** | 6 GB allocated | 8 GB allocated | +| **Client CPU** | Quad-core 3.0 GHz | Modern 6-core+ | +| **Client GPU** | GTX 1060 / RX 580 | GTX 1660 / RX 5700+ | +| **Server RAM** | 12 GB allocated | 16 GB allocated | +| **Server CPU** | 4 cores @ 3.5 GHz+ | 6 cores @ 4.0 GHz+ | +| **Storage** | 15 GB free | 25 GB free (SSD) | + +> The server is tuned to run within a 4-core, 16 GB system budget. The client is tuned to run smoothly at 8 GB allocated RAM. + +## Quick Start + +### Client Installation + +1. Install [Prism Launcher](https://prismlauncher.org/) (recommended) or your preferred launcher +2. Download the latest pack release from the [Releases](../../releases) page +3. Import the `.zip` into your launcher +4. Allocate at least 6 GB of RAM to the instance +5. Launch the game and wait for first-load shader compilation (~2 minutes) + +### Server Installation + +```bash +# Clone the server files +git clone https://git.bladeworks.dev/blade/bladeworks-grind-pack.git +cd bladeworks-grind-pack/server + +# Run the installer +./install.sh + +# Edit server.properties and eula.txt +nano server.properties +nano eula.txt + +# Start the server +./start.sh +``` + +See [docs/SERVER_SETUP.md](docs/SERVER_SETUP.md) for detailed deployment instructions, including Pyrodactyl panel integration. + +## Mod Categories + +
+⚙️ Create & Addons (18 mods) + +Create, Create: Crafts & Additions, Create: Slice & Dice, Create: Ratatouille, Create: Bells & Whistles, Create: Let The Adventure Begin, Create: Enchantment Industry, Steam 'n' Rails NeoForge, Create: Modern Train Parts, Create: Garnished, Create: Arcane Engineering, Create: Compat O' Plenty, Create: Dreams & Desires, Create: Structures, Create: Copycats+, Create: Deco, Ars Creo, Ars Énergistique + +
+ +
+⚔️ Combat & Skills (~24 mods) + +Epic Fight + Skill Tree, Better Combat + Apotheosis Compat, Elenai Dodge 2, Combat Roll, Simply Swords, Spartan Weaponry suite, Apotheosis, More RPG Classes + Skill Tree, Iron's Spells 'n' Spellbooks + Dynamic Skill Trees, Champions, Cataclysm, and more. + +
+ +
+🧙 Magic Systems (~19 mods) + +Ars Nouveau + addons, Occultism, Hexerei, Mahou Tsukai, Malum, Enigmatic Legacy, Reliquary Reincarnations, Ice and Fire: Dragons, Artifacts, Theurgy, Forbidden & Arcanus, and more. + +
+ +
+🏗️ Tech & Automation (~32 mods) + +Applied Energistics 2, Refined Storage 2, Mekanism suite, Immersive Engineering, Industrial Foregoing, Thermal series, Powah, EnderIO, Pneumaticraft, RFTools suite, Sophisticated Storage/Backpacks, and more. + +
+ +
+🌾 Farming & Food (~19 mods) + +Farmer's Delight + all addons (Hearth and Harvest, Nether's Delight, End's Delight, Seasonal Delight), Pam's HarvestCraft 2, Nether Agriculture, Serene Seasons, Cooking for Blockheads, Spice of Life, Aquaculture 2, and more. + +
+ +
+🗺️ Exploration & World Gen (~36 mods) + +Terralith, Tectonic, BYG, Regions Unexplored, YUNG's full suite (11 mods), When Dungeons Arise, Towns & Towers, MVS/MES, Twilight Forest, The Aether, Undergarden, Deeper and Darker, Alex's Mobs, Alex's Caves, Ice and Fire, Cataclysm, and more. + +
+ +
+🚂 Travel & Transport (~12 mods) + +Create trains, Steam 'n' Rails, Immersive Aircraft, Small Ships, Valkyrien Skies + Eureka + Tournament, Paragliders, Waystones, Caelus API, and more. + +
+ +
+🏠 Building & Decoration (~25 mods) + +Full Macaw's suite (11 mods), Every Compat, MrCrayfish's Furniture Refurbished, Supplementaries, Quark, Decorative Blocks, Chisels & Bits, Framed Blocks, Architect's Palette, and more. + +
+ +
+📜 Questing & Economy (~9 mods) + +FTB Quests + Library + Teams + Optimizer, QuestShop, Numismatic Overhaul, Player Shops, NeoEssentials, Real Economy + +
+ +
+⚡ Performance & QoL (~35 mods) + +Embeddium, Oculus, FerriteCore, ModernFix, Canary, Clumps, LazyDFU, Distant Horizons, Entity Culling, Dynamic FPS, JEI, Jade, AppleSkin, Inventory HUD+, Curios, and more. + +
+ +See the full mod list in [docs/MODLIST.md](docs/MODLIST.md). + +## Progression Overview + +The quest system is organized into progressive chapters, each gating the next: + +1. **Survival Basics** — Stone tools to your first water wheel +2. **Create Fundamentals** — Stress, kinetics, and your first automation chain +3. **Combat Awakening** — Choose your combat path (weapon, magic, or hybrid) +4. **World Exploration** — Dimensional travel and structure hunting +5. **Magic Mastery** — Advance through Ars Nouveau or Occultism +6. **Industrial Tier** — AE2, Mekanism, and full factory automation +7. **Economic Integration** — Open a player shop, join the server economy +8. **Endgame** — Apotheosis maxed affixes, complete AE2 network, and the final grind loop + +## Server Infrastructure + +The official BLADEWORKS server runs on: + +- **Host:** SCOPENET homelab (Proxmox-managed) +- **Panel:** [Pyrodactyl](https://pyro.host) for admin control +- **Map:** [BlueMap](https://map.bladeworks.dev) — live 3D world map +- **Permissions:** LuckPerms with tiered ranks +- **Backups:** FTB Backups 2 (every 2 hours, 12 retained) +- **Monitoring:** Spark profiler + Prometheus/Grafana + +## Contributing + +Contributions are welcome — whether it's quest writing, balance feedback, bug reports, or config tweaks. + +### Reporting Issues + +Open an issue on Gitea with the following: + +- Crash report or log file (attached or linked via [mclo.gs](https://mclo.gs)) +- Steps to reproduce +- Your client/server specs +- Which pack version you're running + +### Pull Requests + +1. Fork the repo +2. Create a feature branch (`git checkout -b feature/my-change`) +3. Make your changes +4. Test locally on a clean server instance +5. Submit a PR with a clear description + +## Roadmap + +- [x] Phase 1: Create foundation stable +- [ ] Phase 2: Combat layer complete +- [ ] Phase 3: World gen and exploration tuned +- [ ] Phase 4: Magic integration +- [ ] Phase 5: Tech and storage tier +- [ ] Phase 6: Farming, food, and economy +- [ ] Phase 7: Building and immersion polish +- [ ] Phase 8: Server infrastructure hardened +- [ ] Phase 9: Full quest tree written +- [ ] Phase 10: Beta testing and soft launch +- [ ] v1.0.0 Public release + +See [ROADMAP.md](ROADMAP.md) for the full 50-step development plan. + +## License + +This modpack is distributed under the MIT License. See [LICENSE](LICENSE) for details. + +Individual mods retain their original licensing. All credit for mod content goes to their respective authors. This pack is a compilation and configuration project, not a redistribution of mod source code. + +## Credits + +- **Pack author:** Blade ([@SCOPEDD](https://twitch.tv/SCOPEDD)) +- **Core mod:** [Create](https://www.curseforge.com/minecraft/mc-mods/create) by simibubi +- **Questing framework:** [FTB Quests](https://www.curseforge.com/minecraft/mc-mods/ftb-quests-forge) by FTB Team +- **Every mod author** whose work makes this pack possible — full attribution in [CREDITS.md](CREDITS.md) + +## Links + +- 🌐 **Website:** [bladeworks.dev](https://bladeworks.dev) +- 🗺️ **Live Map:** [map.bladeworks.dev](https://map.bladeworks.dev) +- 📺 **Twitch:** [twitch.tv/SCOPEDD](https://twitch.tv/SCOPEDD) +- 💬 **Discord:** *(add invite)* +- 📦 **CurseForge:** *(add link when published)* +- 🔧 **Modrinth:** *(add link when published)* + +--- + +
+ +*Built with obsession in Bloomsburg, PA.* + +
\ No newline at end of file