hwihwalab commited on
Commit
a3a2bc0
ยท
verified ยท
1 Parent(s): c4ccf63

Remove redundant README_EN.md

Browse files
Files changed (1) hide show
  1. README_EN.md +0 -152
README_EN.md DELETED
@@ -1,152 +0,0 @@
1
- # ๐Ÿฌ Jelly Bean PlayEngine: 10 Pop Physics Bricks (English Documentation)
2
-
3
- [![MuJoCo](https://img.shields.io/badge/MuJoCo-WebAssembly%20(500Hz%20PGS)-E11D48?logo=google)](https://mujoco.org) [![Physics Core](https://img.shields.io/badge/Physics-10--in--1%20Procedural%20Bricks-9d4edd)](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine) [![Engine](https://img.shields.io/badge/Engine-100%25%20Client--Side%20WASM%20(60%20FPS)-06B6D4)](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine) [![Robotics](https://img.shields.io/badge/Robotics-LQR%20%C2%B7%20Pure%20Pursuit%20%C2%B7%20IK-10B981)](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine) [![Audio](https://img.shields.io/badge/Audio-0%20KB%20Web%20Audio%20Synthesis-ff7b00)](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine)
4
-
5
- > โ€œ**Jelly Bean PlayEngine: 10-in-1 Cute Playable Physics Arcade & Physical AI Sandbox | HWIHWA LAB**
6
- > A high-performance interactive physics playground and autonomous robotics sandbox built on Google DeepMind's MuJoCo WebAssembly engine (60 FPS Three.js WebGL client-side rendering) and 500Hz PGS numerical solver ($dt=0.002\text{s}$). Features 10 standalone procedural physics bricks, zero Docker/backend server dependency, autonomous robotics controllers (LQR inverted pendulum balancer, Pure Pursuit waypoint navigation, 3-stage Inverse Kinematics claw rescue, ballistic demolition sniper), 3-way camera perspective switching, and zero-asset procedural 8-bit chiptune audio synthesis.
7
- >
8
- > ๐ŸŒ [English Documentation](https://huggingface.co/hwihwalab/mujoco-physics-playengine) | ๐Ÿ‡ฐ๐Ÿ‡ท [ํ•œ๊ตญ์–ด ๋งค๋‰ด์–ผ](https://huggingface.co/hwihwalab/mujoco-physics-playengine/blob/main/README_KR.md) | ๐Ÿฌ [Interactive 3D Arcade](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine)โ€
9
- > *Developed by [Hwihwa Lab](https://github.com/Hwihwa-Lab) ยท AI ร— Automation ร— Aesthetics โœจ*
10
-
11
- <div align="center">
12
- <img src="assets/banner.png" alt="Jelly Bean PlayEngine 10 Physics Bricks" width="100%" style="border-radius: 16px; margin: 16px 0;">
13
- </div>
14
-
15
- ---
16
-
17
- ## โšก Real-Time Physics & Robotics Architecture
18
-
19
- **Jelly Bean PlayEngine** transforms academic multi-body dynamics into a vibrant, high-performance 3D arcade. Built on **MuJoCo WebAssembly** with a 500Hz numerical solver (`dt=0.002s`) and 60 FPS Three.js WebGL client-side rendering, it delivers zero-latency interactive physics with 100% procedural geometric assets, autonomous robotics controllers (LQR, Pure Pursuit, Inverse Kinematics), zero Docker or server dependencies, and pure Web Audio API sound synthesis.
20
-
21
- * **500Hz PGS Solver**: Differential timestep $dt=0.002\text{s}$ with Projected Gauss-Seidel contact solver solves multi-body collisions, non-linear double pendulums, and friction cones accurately.
22
- * **100% Client-Side WebAssembly**: 60 FPS WebGL Three.js client-side execution eliminates server lag and runs seamlessly directly inside any modern web browser.
23
- * **0-Byte Procedural Assets**: Zero external textures or 3D meshes to download; everything is synthesized via MuJoCo XML and Web Audio API oscillators.
24
-
25
- ---
26
-
27
- ## โญ The 4 Major System Upgrades
28
-
29
- 1. **๐Ÿ† Game-Specific Victory Banners with Confetti & Fanfares**:
30
- - Every mini-game features clear win conditions (e.g., `DOMINO CLEARED!`, `ALL COINS COLLECTED!`, `PINK BEAN WINS!`, `360ยฐ LOOP MASTER!`, `TOWER ANNIHILATED!`, `GOLDEN BALANCER!`).
31
- - Celebrated with dynamic canvas particle confetti explosions and browser-synthesized brass fanfares.
32
- 2. **๐ŸŽฅ 3-Way Camera Perspective Switcher**:
33
- - Seamlessly switch between **Front View (`cam_front`)**, **45ยฐ Quarter Isometric (`cam_quarter`)**, and **Top-Down Aerial (`cam_topdown`)** with a single click or by pressing the **[C]** key.
34
- 3. **๐ŸŽต Kawaii 8-Bit Chiptune BGM (Pure Web Audio API)**:
35
- - Zero-byte download footprint: 100% procedurally synthesized in JavaScript via Web Audio API oscillators.
36
- - Upbeat pentatonic arpeggios with syncopated bouncy bassline. Toggle on/off anytime via the top header button `[๐ŸŽต BGM ON/OFF]`.
37
- 4. **๐Ÿค– 10-Game Smart AI Autonomous Controllers**:
38
- - In addition to human manual keyboard control, press **[M]** or click **[๐Ÿค– SMART AI]** to engage autonomous robotics controllers:
39
- - **Game 01**: 1.6s Optimal Rhythm Drop AI
40
- - **Game 02**: Ball Pool Dual-Flipper Reaction Reflex AI
41
- - **Game 03**: Ballistic Domino Impact Striker AI
42
- - **Game 04**: Phase-Resonance 360ยฐ Swing Momentum Pumping AI
43
- - **Game 05**: Double Pendulum Acrobat Kick AI
44
- - **Game 06**: Hydrodynamic Slipstream Photo-Finish Boost AI
45
- - **Game 07**: LQR Inverted Pendulum Lollipop Cart Balancer AI
46
- - **Game 08**: Pure Pursuit Autonomous Navigation & 5-Coin Collector AI
47
- - **Game 09**: 3-Stage Inverse Kinematics (IK) Plushie Claw Rescue AI
48
- - **Game 10**: Center-of-Mass (CoM) Ballistic Demolition Sniper AI
49
-
50
- ---
51
-
52
- ## ๐Ÿงธ The 10 Pop Physics Mini-Games & Controls
53
-
54
- ### ๐ŸŽฎ Universal Global Keyboard Shortcuts
55
- | Key | Function | Description |
56
- |:---:|:---|:---|
57
- | **`Space`** | **Primary Action Trigger** | Start simulation / Drop bean / Flap pinball rain / Strike domino / Acrobatic kick / Fire cannon |
58
- | **`R`** | **Instant Reset** | Rebuilds arena and resets all objects, timers, and HUD metrics to initial ready state |
59
- | **`C`** | **Cycle 3-Way Camera** | Switches perspective instantly: `Front ๐ŸŽฅ` โž” `45ยฐ Quarter ๐Ÿ“` โž” `Top-Down ๐Ÿš` |
60
- | **`M`** | **Smart AI / Manual Mode** | Toggles between Human Manual Control and Autonomous Smart AI Auto-Pilot |
61
- | **`F`** | **16:9 Widescreen Fullscreen** | Toggles immersive full-screen arcade viewport |
62
-
63
- ### ๐Ÿ•น๏ธ 10 Mini-Games Dual Controls (WASD & Arrow Keys)
64
- | # | Game Title | MuJoCo Physics Core | Target Goal & Win Condition | Controls (Dual WASD & Arrow Keys) |
65
- |---|------------|---------------------|-----------------------------|-----------------------------------|
66
- | **01** | **Jelly Bean Skydiving Party** | Multi-Agent Gravity & Floor Impact | Drop beans from the sky to safely pile up on foam mat | `Space`: Drop Extra Bean, `R`: Reset |
67
- | **02** | **Ball Pool Pinball Carnival** | Multi-Body Elastic Collision & Contact | Flip bumpers to bounce gumballs and score 1,000 pts | `A`/`D` or `โ†`/`โ†’`: Left/Right Flippers, `Space`: Rain |
68
- | **03** | **Domino Knockdown Strike** | Kinetic Chain Reaction & Momentum Transfer | Topple 7 dominoes to strike down the Gold Star target | `Space`: Strike 1st Domino, `R`: Reset |
69
- | **04** | **Giant Carnival Swing 360ยฐ** | Revolute Joint Kinematics & Resonance | Rhythm pumping to overcome gravity and execute a 360ยฐ loop | `W`/`โ†‘` or `Space`: Momentum Pump, `R`: Reset |
70
- | **05** | **Jelly Bean Acrobatic Twin** | Double Pendulum Chaotic Dynamics | Direct joint torque & aerial 3x somersault combo in the sky | `W`/`S` or `โ†‘`/`โ†“` (Joint 1), `A`/`D` or `โ†`/`โ†’` (Joint 2), `Space`: Chaos Kick |
71
- | **06** | **Waterpark Candy Slide Race** | Incline Tribology & Coulomb Friction | Pink Bean vs Mint Bean! Slide down rainbow ramp to splash pool | `Space`: Start, `A`/`โ†`: Pink Boost, `D`/`โ†’`: Mint Boost |
72
- | **07** | **Pudding Cart Balancer (โญ Flagship)** | **CartPole / Inverted Pendulum (RL)** | Balance Pink Bean on cart for 15s to win Golden Balancer | `A`/`D` or `โ†`/`โ†’`: Push Cart, `M`: AI Mode |
73
- | **08** | **Bumper Car Coin Collector** | **4-Wheel Chassis & Traction Dynamics** | Drive bumper car around arena to collect all 5 Star Coins | `W`/`S`/`A`/`D` or `โ†‘`/`โ†“`/`โ†`/`โ†’`: Drive & Steer (Compound Hold) |
74
- | **09** | **Toy Claw Machine & Plushie Bean** | **2-DOF Robotic Arm (Robotics)** | Position robotic arm and activate magnetic grip to rescue plushie | `W`/`S` or `โ†‘`/`โ†“`: Shoulder, `A`/`D` or `โ†`/`โ†’`: Elbow, `Space`: Magnet |
75
- | **10** | **Macaron Tower & Cannonball Bean** | Multi-Body Structural Collapse & Ballistics | Adjust cannon power and fire cannonball to crush 9-story tower | `Space`: Fire Cannon, `W`/`S` or `โ†‘`/`โ†“`: Power (0.4x~2.5x) |
76
-
77
- ---
78
-
79
- ### ๐Ÿ•น๏ธ Analysis of Game Control Paradigms (5 Distinct Types)
80
- Each game utilizes a physical interaction paradigm tailored to its underlying dynamics:
81
- 1. **Single-Shot Trigger**:
82
- - **01 Skydiving** / **03 Domino** / **10 Cannon**: Press `Space` once to trigger ballistic trajectories and collapse.
83
- 2. **Continuous Force Hold**:
84
- - **02 Pinball**: Hold `A`/`D` or `โ†`/`โ†’` to keep flippers energized; release to return via spring physics.
85
- - **07 Cart Balancer**: Hold `A`/`D` or `โ†`/`โ†’` to continuously apply lateral force to the cart.
86
- 3. **Resonance Rhythm Pumping**:
87
- - **04 Giant Swing**: Tap `W` / `โ†‘` / `Space` in phase with angular velocity to pump resonance energy towards a 360ยฐ loop.
88
- 4. **Multi-Joint Actuation**:
89
- - **05 Acrobatic**: `W`/`S` controls shoulder joint torque, `A`/`D` controls elbow torque, and `Space` executes an aerial flip.
90
- - **09 Claw Crane**: `W`/`S` adjusts shoulder angle, `A`/`D` adjusts elbow angle, and `Space` toggles magnetic suction.
91
- 5. **Compound Multi-Key Steering**:
92
- - **08 Bumper Car**: Simultaneous multi-key input (`W`+`D` or `โ†‘`+`โ†’`) allows drifting and turning simultaneously.
93
-
94
- ---
95
-
96
- ## ๐Ÿ’ป Run Locally (Standalone Desktop App Mode)
97
-
98
- Run in native desktop cockpit mode without web browser chrome or address bars:
99
-
100
- ```bash
101
- # 1. Clone repository
102
- git clone https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine
103
- cd mujoco-physics-playengine
104
-
105
- # 2. Install dependencies (6 lightweight packages)
106
- pip install -r requirements.txt
107
-
108
- # 3. Launch Standalone Cockpit Window
109
- python run.py
110
- ```
111
- *(Windows users can simply double-click `PlayEngine.bat` to launch instantly)*
112
-
113
- ---
114
-
115
- ## ๐Ÿ“ฆ Copy Standalone Physics Brick Code
116
-
117
- Click the **`[๐Ÿ“‹ COPY PYTHON / XML CODE]`** button in the bottom right corner of the cockpit to copy standalone snippets:
118
- 1. **`Python Script` tab**: Self-contained script launching MuJoCo's official native 3D viewer window with real-time AI and physics (`pip install mujoco`).
119
- 2. **`MuJoCo XML (Blueprint)` tab**: Pure declarative physics XML scene for C++, Rust, Unity, Unreal, or Gymnasium reinforcement learning environments.
120
-
121
- ---
122
-
123
- ## ๐Ÿ“‚ Repository Contents
124
-
125
- * `README.md`: Official Model Card overview on Hugging Face Model Hub.
126
- * `README_EN.md`: Comprehensive English manual (this document).
127
- * `README_KR.md`: Comprehensive Korean manual ([ํ•œ๊ตญ์–ด ๋งค๋‰ด์–ผ](README_KR.md)).
128
- * `mujoco_playengine_bundle.zip`: Full production bundle containing all 10 MuJoCo procedural physics bricks, LQR/IK controllers, FastAPI server, and zero-asset Cybernetic Bento web cockpit.
129
- * `assets/banner.png`: Official 16:9 3D rendered showcase cover banner.
130
- * `LICENSE`: Official Apache 2.0 open-source license.
131
-
132
- ---
133
-
134
- ## ๐Ÿ‘ค About HWIHWA LAB
135
-
136
- > *โ€œAI ร— Automation ร— Aesthetics โ€” Crafting tools you'll love โœจโ€*
137
-
138
- **HWIHWA LAB** is an independent AI research & engineering studio dedicated to blending **practical on-device intelligence, autonomous operations, and refined aesthetics**. We engineer resilient systems that free solopreneurs and indie creators from operational overheadโ€”giving people their time and creative joy back.
139
-
140
- ### ๐ŸŒ Physical AI & Robotics Ecosystem (Cross-Links)
141
- - **Official Hub**: [๐Ÿค— Hugging Face (@hwihwalab)](https://huggingface.co/hwihwalab)
142
- - ๐Ÿฌ **Physics Bricks & Web Arcade**: [mujoco-physics-playengine](https://huggingface.co/spaces/hwihwalab/mujoco-physics-playengine) *(Current Project)*
143
- - ๐Ÿ•น๏ธ **Inverted Pendulum Control (PPO)**: [cartpole-v1-ppo](https://huggingface.co/hwihwalab/cartpole-v1-ppo)
144
- - ๐Ÿค– **Bimanual Robotic Manipulation**: [act-aloha-sim-transfer-cube](https://huggingface.co/hwihwalab/act-aloha-sim-transfer-cube)
145
- - ๐Ÿฆ† **3D Bipedal Locomotion & Teleop**: [microduck-3d-bipedal-teleop](https://huggingface.co/spaces/hwihwalab/microduck-3d-bipedal-teleop)
146
- - ๐Ÿซ **Indie Game Studio Decision Brain**: [CHOCO-BRAIN-v1](https://huggingface.co/hwihwalab/connectailab-CHOCO-BRAIN-v1)
147
-
148
- ---
149
-
150
- ## ๐Ÿ“œ License
151
-
152
- Distributed under the Apache 2.0 License. See `LICENSE` for details.