meatloaf-config/README.md

60 lines
1.7 KiB
Markdown

# Meatloaf Manipulator
A Progressive Web App (PWA) for configuring and managing [Meatloaf](https://meatloaf.cc) devices — open-source Commodore 64/128 hardware that adds modern networking, storage, and peripheral support.
## Features
- **Status** — live system status, activity log, file info, loading progress, directory and disk map overlays
- **Devices** — browse and manage attached storage devices with detailed device overlays
- **IEC** — configure the IEC serial bus
- **Network** — manage network settings and scan for Wi-Fi networks
- **Apps** — built-in tools grouped by category:
- **Disk**: Directory Editor, Sector Editor, BAM Editor, Disk Visualizer, RAM/ROM Explorer, Dump/Write Disk Image
- **Cartridge**: PRG to CRT, Magic Desk Cart Builder, Easy Flash Cart Builder
- **Development**: Basic Editor, Assembler, Sprite Editor, Character Set Editor, PETSCII Editor
- **Display**: Idle Animation, Loading Animation
- **Tools & Settings** — general configuration and utility tools
- **PWA** — installable on desktop and mobile; runs offline via service worker
## Requirements
- Node.js 18+
- npm or pnpm
## Installation
```bash
npm install
# or
pnpm install
```
## Development
```bash
npm run dev
```
The app is served at `http://localhost:5173/config/` by default.
To use a different base path:
```bash
BASE_PATH=/my-path/ npm run dev
```
## Production Build
```bash
npm run build
```
Output is written to `dist/`. The build uses `/config/` as the base path by default. Override with the `BASE_PATH` environment variable at build time:
```bash
BASE_PATH=/config/ npm run build
```
Deploy the contents of `dist/` to the Meatloaf device web server under the configured base path.