feat: update installation instructions for Opus Package Manager and enhance startup script details

This commit is contained in:
MayaTheShy
2026-03-25 22:24:05 -04:00
parent 9a02b350c2
commit f1e418ad83

112
README.md
View File

@@ -64,62 +64,27 @@ A Minecraft inventory management system built on [CC:Tweaked](https://tweaked.cc
### Prerequisites ### Prerequisites
- Minecraft with [CC:Tweaked](https://tweaked.cc/) installed - Minecraft with [CC:Tweaked](https://tweaked.cc/) installed
- [Opus OS](https://github.com/kepler155c/opus) installed on all CC:Tweaked computers (required for the UI framework)
- A CC:Tweaked computer with a wired modem and monitor attached - A CC:Tweaked computer with a wired modem and monitor attached
- HTTP access enabled in the CC:Tweaked config (for the web bridge) - HTTP access enabled in the CC:Tweaked config (for the web bridge)
### 1. Install the Master Controller ### 1. Install via Opus Package Manager (Recommended)
On your main CC:Tweaked computer (with the monitor and wired modem), open the terminal and run: On any CC:Tweaked computer running Opus, open the shell and run:
``` ```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/inventoryManager.lua startup.lua package install inventory-manager
``` ```
This downloads `inventoryManager.lua` and saves it as `startup.lua` so it runs automatically on boot. Reboot the computer or run `startup.lua` to start. An interactive setup wizard will guide you through role selection (Manager, Client, Web Bridge, or Mining Turtle) and peripheral configuration. The package installs all required files and an autorun script that launches the correct program on boot. Reboot after installation.
### 2. Install a Display Client (Optional) To update later:
On a separate CC:Tweaked computer with a monitor:
``` ```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/inventoryClient.lua startup.lua package update inventory-manager
``` ```
### 3. Install the Crafting Turtle (Optional) ### 2. Start the Web Dashboard (Optional)
On a **Crafting Turtle** connected to the wired network:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/craftingTurtle.lua startup.lua
```
### 4. Install the Dropper Controller (Optional)
On a computer adjacent to a dropper block:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/dropperController.lua startup.lua
```
### 5. Install a Mining Turtle (Optional)
On a **Mining Turtle** connected to the wired network:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/miningTurtle.lua startup.lua
```
### 6. Install the Web Bridge (Optional)
On any CC:Tweaked computer with a wired modem and HTTP access:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/inventoryWebBridge.lua startup.lua
```
Configure the web server URL by editing `.webbridge_config` on the computer, or it will default to `http://localhost`.
### 7. Start the Web Dashboard (Optional)
On the host machine, navigate to the `web/` directory and run: On the host machine, navigate to the `web/` directory and run:
@@ -129,6 +94,57 @@ docker compose up -d --build
The dashboard will be available at `http://localhost` on port 80. The dashboard will be available at `http://localhost` on port 80.
### Manual Install (Without Opus)
If you are not using Opus, you can install individual components with `wget`. Note that the monitor dashboard requires the Opus UI framework (`opus.ui`), so Opus is still needed on computers with monitors.
<details>
<summary>Click to expand manual install instructions</summary>
#### Master Controller
On your main CC:Tweaked computer (with the monitor and wired modem):
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/manager.lua startup.lua
```
#### Display Client
On a separate CC:Tweaked computer with a monitor:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/client.lua startup.lua
```
#### Crafting Turtle
On a **Crafting Turtle** connected to the wired network:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/turtle.lua startup.lua
```
#### Mining Turtle
On a **Mining Turtle** connected to the wired network:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/miner.lua startup.lua
```
#### Web Bridge
On any CC:Tweaked computer with a wired modem and HTTP access:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/bridge.lua startup.lua
```
These startup scripts auto-download all required files from the repository before launching.
</details>
## Modem Channels ## Modem Channels
| Channel | Purpose | | Channel | Purpose |
@@ -140,9 +156,9 @@ The dashboard will be available at `http://localhost` on port 80.
| 4204 | Crafting Turtle → Master (craft results) | | 4204 | Crafting Turtle → Master (craft results) |
| 4205 | System channel (remote reboot all computers) | | 4205 | System channel (remote reboot all computers) |
## Auto-Updating Startup Scripts ## Startup Scripts
The `startup/` directory contains self-updating startup scripts that download the latest code from the git repository before launching. These are an alternative to the manual `wget` install: The `startup/` directory contains self-updating startup scripts that download the latest code from the git repository before launching. These are used by the manual install method above and can also be used standalone:
| Script | Role | | Script | Role |
|--------|------| |--------|------|
@@ -152,12 +168,6 @@ The `startup/` directory contains self-updating startup scripts that download th
| `startup/bridge.lua` | Web bridge with auto-update | | `startup/bridge.lua` | Web bridge with auto-update |
| `startup/miner.lua` | Mining turtle with auto-update | | `startup/miner.lua` | Mining turtle with auto-update |
To use one, download the appropriate startup script as `startup.lua` on the target computer. For example:
```
wget https://git.spatulaa.com/MayaTheShy/Inventory-Manager-CC/raw/branch/main/startup/manager.lua startup.lua
```
## License ## License
See [LICENSE](LICENSE) for details. See [LICENSE](LICENSE) for details.