dev

Developer Documentation

Technical documentation for contributors and those building the mod.

Documentation Structure

• Port Overview - High-level overview of the porting process and major changes
• Storage System - Detailed storage system implementation
• GUI System - User interface implementation and layout
• Configuration - TOML configuration system and options
• Build System - Multi-module Gradle configuration and build process
• Dependencies - Dependency versions and update tracking
• Integrations - Current mod integrations and future options
• Troubleshooting - Common issues and solutions
• Translations - Contributing language translations
• Branding - Brand identity and messaging guidelines
• Future Ideas - Planned features and roadmap
• Advanced Storage - Design docs for the companion advanced-storage mod
• Changelog - Version history and changes
• Testing - Test suite documentation

Quick Reference

Key Technologies

• Minecraft: 1.21.1
• NeoForge: 21.1.218
• ModDevGradle: 2.0.141
• Java: 21
• Gradle: 8.10.2

Architecture

The project uses a multi-module Gradle layout:

• core - Platform-agnostic code (vanilla MC classes only via neoFormVersion)
• neoforge - NeoForge-specific code (registration, config, packet handlers, JEI)

A platform abstraction layer (S3Platform, S3Config, S3NetworkHelper) decouples core code from loader-specific APIs.

Project Status

Version 1.0.2 — stable release

Implemented Features:

• Basic storage system with multiblock capacity scaling
• Storage Core GUI with sidebar item display and scrolling
• Expandable storage grid in crafting GUI (toggle between normal/extended layouts)
• Tiered storage blocks (Storage Box, Condensed, Compressed, Super, Ultra, Hyper, Ultimate)
• Item insertion and extraction with proper client-server sync
• Truncated item count display with suffixes (K/M/B) for large quantities
• JEI integration for recipe transfer and ingredient lookup
• Crafting Box with 3x3 crafting grid connected to storage
• Shift-click crafting with automatic ingredient repopulation
• Search Box with real-time filtering (name, tags, mod, tooltips)
• Sort Box with automatic sorting modes
• Statistics Box with detailed storage metrics display
• Security Box with player access control
• Access Terminal for remote access
• Input/Extract/Eject Ports for automation
• Storage Interface for cross-mod integration
• Blank Box for decorative multiblock components
• Dolly and Key items
• Advancement tree (21 advancements tracking block/item progression)

Getting Started

1. See Build System for setup instructions
2. Check Troubleshooting for common issues