🎮 DOOM for Gitpod

A web-accessible version of the classic DOOM game, optimized for Gitpod cloud development environments using modern Gitpod Automations. Play the legendary FPS directly in your browser!

✨ Features

• 🎯 Chocolate DOOM (modern, compatible DOOM port)
• 🌐 Web browser access through VNC interface
• ⚡ Gitpod Automations for seamless setup
• 🐳 Dev Container configuration
• 🔧 Cross-platform compatibility
• 🎮 Shareware DOOM episode included

🚀 Quick Start

Option 1: One-Click Gitpod (Recommended)

1. Click the "Open in Gitpod" button above
2. Wait for the environment to build (2-3 minutes)
3. Run: gitpod automations workflow start quick-start
4. Access the game through the preview panel on port 6080
5. Start playing DOOM in your browser!

Option 2: Manual Gitpod Automations

# Setup DOOM environment
gitpod automations task start setup-doom

# Start VNC server
gitpod automations service start vnc-server

# Launch DOOM
gitpod automations task start start-doom

🎮 Controls

Key	Action
↑↓←→	Movement
Ctrl	Fire weapon
Space	Use/Open doors
Tab	Toggle automap
Esc	Main menu
Enter	Select menu item

🏗️ Architecture

• Engine: Chocolate DOOM (modern, compatible port)
• Graphics: Software rendering with VNC web interface
• Web Access: VNC server (port 5900) + web client (port 6080)
• Automation: Gitpod Automations with services and tasks
• Container: Ubuntu 22.04 with development tools

📁 Project Structure

├── DOOM/                     # Original id Software source (reference)
├── scripts/                  # Automation scripts
│   ├── setup.sh             # Environment setup
│   ├── start-doom.sh        # Game launcher
│   ├── vnc-web.sh           # VNC interface
│   └── test.sh              # Validation suite
├── .devcontainer/           # Dev Container configuration
├── .gitpod/                 # Gitpod configuration
│   └── automations.yaml    # Automations definition
└── README.md               # This file

🤖 Gitpod Automations

This project uses Gitpod's modern automation system:

Services

• vnc-server: Runs VNC web interface for browser access

Tasks

• setup-doom: Install Chocolate DOOM and download WAD file
• start-doom: Launch DOOM with web interface
• test-setup: Verify installation and configuration

Workflows

• quick-start: Complete setup and launch
• development: Setup for development and testing

🧪 Testing

Test the setup:

gitpod automations task start test-setup

Or use the legacy script:

./scripts/test.sh

🎯 Game Assets

The setup automatically downloads the shareware DOOM episode (E1M1-E1M9). For the full game experience:

1. Place your own doom.wad or doom2.wad file in the project root
2. Chocolate DOOM supports all official DOOM WAD files

🌐 Web Interface

The game runs through a VNC server accessible via web browser:

• VNC Server: Port 5900 (internal)
• Web Interface: Port 6080 (auto-forwarded)
• Technology: VNC + websockify for browser compatibility

📋 Requirements

• Modern web browser (Chrome, Firefox, Safari, Edge)
• Gitpod account (free tier sufficient)
• Internet connection for initial setup

🐛 Troubleshooting

Game won't start

# Check setup
gitpod automations task start test-setup

# Verify WAD file
ls -la *.wad

# Check VNC service
gitpod automations service status vnc-server

No display in browser

• Ensure VNC service is running: gitpod automations service start vnc-server
• Check port forwarding in Gitpod
• Try refreshing the preview panel

Audio issues

• Audio may be limited in browser environments
• Chocolate DOOM handles audio automatically

🔧 Development

Using Gitpod CLI

# List all automations
gitpod automations list

# Check service status
gitpod automations service status vnc-server

# View task logs
gitpod automations task logs setup-doom

# Update automations
gitpod automations update .gitpod/automations.yaml

Legacy Scripts

The project includes legacy scripts for compatibility:

• ./scripts/setup.sh - Environment setup
• ./scripts/start-doom.sh - Game launcher
• ./scripts/test.sh - Testing suite

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Test with: gitpod automations task start test-setup
4. Submit a pull request

📜 License

This project uses Chocolate DOOM under GPL v2. The Gitpod configuration and automation scripts are also GPL v2.

🙏 Acknowledgments

• id Software for releasing the DOOM source code
• Chocolate DOOM Team for the modern, compatible port
• Gitpod for cloud development environments and Automations
• VNC/noVNC for web-based remote desktop access

---

Ready to rip and tear? Click the Gitpod button and start playing! 🔥

🆕 What's New in This Version

• ✅ Modern Gitpod Automations instead of deprecated .gitpod.yml
• ✅ Dev Container configuration for proper environment setup
• ✅ Chocolate DOOM for maximum compatibility
• ✅ Automated testing and validation
• ✅ Service-based architecture for VNC web interface