Skip to content

Simple web interface to view and interact with a Minecraft AE2 ME storage system via Advanced Peripherals.

Notifications You must be signed in to change notification settings

SchachSebastian/me-web-interface

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minecraft Storage Web Interface

Because vanilla Minecraft is too basic.
This is a fun side project that brings high-tech flair to my Minecraft world. I wanted a smoother way to interact with my Applied Energistics 2 ME storage system—so I built a custom web interface to view everything I’ve hoarded in style.

🚀 What It Does

This project connects a Minecraft CC Tweaked computer to a web-based React interface via a Node.js server, allowing you to:

  • 📦 View all items stored in your Applied Energistics 2 ME system or RS system
  • 🧠 Interface using a Lua script with Advanced Peripherals’ ME Bridge or RS Bridge
  • 🌐 Browse your inventory from a sleek React frontend
  • 🛠️ Even remotely craft items directly from the web interface — just click and let the ME/RS system handle the rest!

🛠️ Installation & Setup

🐳 Option 1: Use the Pre-built Docker Image from Docker Hub (Recommended)

If you’re using the ATM 10 modpack, you can skip the setup steps and use the pre-built Docker image available on Docker Hub. This is the fastest and easiest way to get up and running.

Run the following command:

docker run -e SECRET=yourSecretHere -e CRAFTING_SECRET=yourCraftingSecretHere -p 80:80 schachsebastian/me-web-interface:atm10
  • The server will run on port 80.

🖼️ Option 2: Build the Server from Scratch

If you prefer to build everything manually or you’re using a custom modpack, follow these steps.

1. Install Python Dependencies

First, you need to install the required dependencies for the Python script. This can be done by installing the packages in the requirements.txt file:

pip install -r requirements.txt

This will install the necessary dependencies for the image extraction script.

2. Extract Minecraft Item Icons

Before building the server, you’ll need to extract item icons from the modpack you're using.

You can achieve this by using a mod I created item-image-export.

Once exported, copy the png images into the public/assets directory of the frontend.

After that run scripts/convertImages.py to convert the images into webp format and remove the background.

3. Build & Run the Web Server with Docker

After extracting the images, build and run the Docker container:

docker build -t me-web-interface .
docker run -e SECRET=yourSecretHere -e CRAFTING_SECRET=yourCraftingSecretHere -p 80:80 me-web-interface
  • The server runs on port 80.
  • The SECRET as well as the CRAFTING_SECRET are optional and default to "secret" and "crafting" —which is basically like leaving your key under the doormat.
    🔐 For better security (and to avoid chaos), set a custom secret!

Worst-case scenario?
Some random prankster starts crafting 10 000 buttons. 😱
Be smart—protect your ME system.

Once it’s up and running, open your browser and go to your server’s public IP address or domain name to access the web interface.


🖥️ 4. Install the Lua Script In-Game

On your CC Tweaked computer, run:

wget https://raw.githubusercontent.com/SchachSebastian/me-web-interface/refs/heads/main/minecraft/install.lua

Then execute install.lua to install the full script.

Configure the Lua Script

Edit the file: webInterface/config.lua

local config = {
    url = "ws://<your-server-ip>",  -- WebSocket URL of the Express server
    secret = "yourSecretHere",      -- Must match the Docker SECRET (or leave as "secret")
    maxItemsPerMessage = 100,       -- Maximum number of items to send in one websocket message
    system = "me",                  -- Type of storage system ("me" for Applied Energistics 2 ME system or "rs" for Refined Storage)
}

return config

After that restart the computer to begin syncing your ME/RS system with the web interface.


📦 Tech Stack

  • Frontend: React
  • Backend: Node.js with Express
  • Communication: WebSocket
  • Minecraft Mods: Applied Energistics 2 or Refined Storage, CC Tweaked, Advanced Peripherals

About

Simple web interface to view and interact with a Minecraft AE2 ME storage system via Advanced Peripherals.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published