Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,60 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: gpl-3.0
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: gpl-3.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- python
|
| 7 |
+
- baseline
|
| 8 |
+
- ai
|
| 9 |
+
---
|
| 10 |
+
# Mario AI Base 🎮🤖🚀
|
| 11 |
+
|
| 12 |
+
Welcome to **Mario AI Base**! 🎉 This repository is your hub for an AI-powered *Super Mario Bros.* experience. An AI agent, trained with reinforcement learning, plays the game and streams its gameplay live to your browser. A Gradio-based updater app lets you manage daily notes from your LAN. Dive into retro gaming with a modern AI twist! 🌟
|
| 13 |
+
|
| 14 |
+
## Overview 🌍
|
| 15 |
+
|
| 16 |
+
- **Mario AI Streaming App**: An AI (PPO from `stable-baselines3`) plays *Super Mario Bros.*, streamed at ~30 FPS to `http://<your-rig-ip>:5111` via MJPEG with Flask. Supports CUDA acceleration.
|
| 17 |
+
- **Python Updater App**: Gradio-based tool to update GitHub notes daily, accessible at `http://<your-rig-ip>:2332`.
|
| 18 |
+
- **No ROM Included**: Users must provide their own *Super Mario Bros.* ROM due to licensing. 🕹️
|
| 19 |
+
|
| 20 |
+
## Features ✨
|
| 21 |
+
|
| 22 |
+
- **AI-Driven Gameplay**: Watch an AI navigate Mario levels! 🧠
|
| 23 |
+
- **Live Streaming**: Real-time gameplay in your browser. 📺
|
| 24 |
+
- **CUDA Acceleration**: Faster AI inference on GPUs like RTX 3060 Ti. ⚡
|
| 25 |
+
- **Daily Updates**: Log progress with the Gradio app. 📅
|
| 26 |
+
- **LAN Accessible**: Stream and control from your network. 🌐
|
| 27 |
+
- **Customizable**: Adjust AI model or add gameplay actions. 🎮
|
| 28 |
+
|
| 29 |
+
## Setup 🛠️
|
| 30 |
+
|
| 31 |
+
### Prerequisites 📋
|
| 32 |
+
|
| 33 |
+
- **OS**: Ubuntu 20.04+ (tested on "T-1000" with RTX 3060 Ti).
|
| 34 |
+
- **Python**: 3.8+ (`python3 --version`).
|
| 35 |
+
- **GPU (Optional)**: NVIDIA GPU (e.g., RTX 3060 Ti) for CUDA.
|
| 36 |
+
- **NES ROM**: Legal `Super Mario Bros.nes` (not provided) at `/home/ubuntu/mario/`.
|
| 37 |
+
- **Git**: `sudo apt install git` for the updater.
|
| 38 |
+
- **Dependencies**: Install with `requirements.txt`.
|
| 39 |
+
|
| 40 |
+
### Hardware Requirements 💻
|
| 41 |
+
|
| 42 |
+
- **CPU**: 2+ cores, 2 GHz (e.g., Intel i5). More for training.
|
| 43 |
+
- **GPU**: RTX 3060 Ti or similar for CUDA (recommended).
|
| 44 |
+
- **RAM**: 16 GB minimum (32 GB for training).
|
| 45 |
+
- **Storage**: 1 GB for dependencies, ROM, and models.
|
| 46 |
+
|
| 47 |
+
### CUDA Setup for GPU Acceleration ⚡
|
| 48 |
+
|
| 49 |
+
Leverage your RTX 3060 Ti for AI inference and frame processing:
|
| 50 |
+
|
| 51 |
+
1. **Install NVIDIA Drivers**:
|
| 52 |
+
```bash
|
| 53 |
+
sudo apt update
|
| 54 |
+
sudo apt install nvidia-driver-550
|
| 55 |
+
|
| 56 |
+
Website: https://ghostai.pro/
|
| 57 |
+
Discord: https://discord.gg/9cnJNBQtHE
|
| 58 |
+
|
| 59 |
+
## Update (March 11, 2025) 📝
|
| 60 |
+
- Added support for new game levels.
|