aethex-studio/README-NEW.md

187 lines
5.8 KiB
Markdown

# AeThex Studio
**Professional Cross-Platform Game Development IDE**
AeThex Studio is a modern, web-based integrated development environment designed for creating games that run seamlessly across multiple platforms: Roblox, Web, Mobile, and Desktop.
![AeThex Studio](https://via.placeholder.com/1200x600/0a0a0f/8b5cf6?text=AeThex+Studio)
## Features
### 🎮 Multi-Platform Development
- **Roblox**: Native Lua scripting with Roblox Studio integration
- **Web**: HTML5/JavaScript games for browsers
- **Mobile**: React Native apps for iOS & Android
- **Desktop**: Electron apps for Windows, Mac, and Linux
### ⚡ Nexus Engine
Real-time state synchronization across all platforms. Changes in one platform instantly reflect in others, enabling truly cross-platform multiplayer experiences.
### 🔐 Passport Authentication
Unified identity system allowing players to use one account across all platforms.
### 🎮 GameForge Governance
Server-authoritative game logic with built-in anti-cheat protection.
### 🤖 AI-Powered Development
Integrated AI assistant (Gemini Pro, Claude 3, GPT-4) that understands:
- Cross-platform code generation
- Platform-specific optimizations
- Nexus Engine integration
- Best practices and debugging
### 🎨 Professional IDE Features
- Monaco Editor with syntax highlighting for Lua, JavaScript, TypeScript, HTML, CSS
- Multi-file editing with tabs
- File tree explorer with platform icons
- Integrated console with platform-specific output
- Live preview across all platforms simultaneously
- Real-time sync monitoring and debugging
## Getting Started
### Prerequisites
- Node.js 18+
- npm or yarn
### Installation
1. Clone the repository:
\`\`\`bash
git clone https://github.com/yourusername/aethex-studio.git
cd aethex-studio
\`\`\`
2. Install dependencies:
\`\`\`bash
npm install
\`\`\`
3. Run the development server:
\`\`\`bash
npm run dev
\`\`\`
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
## Project Structure
\`\`\`
aethex-studio/
├── app/ # Next.js 14 app directory
│ ├── layout.tsx # Root layout
│ ├── page.tsx # Main IDE page
│ └── globals.css # Global styles
├── components/ # React components
│ ├── Navbar.tsx # Top navigation bar
│ ├── FileTree.tsx # File explorer
│ ├── FileTabs.tsx # Open file tabs
│ ├── CodeEditor.tsx # Monaco editor wrapper
│ ├── AIAssistant.tsx # AI chat interface
│ ├── ConsolePanel.tsx # Console/terminal output
│ ├── CrossPlatformPreview.tsx # Multi-platform preview
│ ├── NexusSyncMonitor.tsx # State sync monitoring
│ ├── NewProjectModal.tsx # Project creation wizard
│ └── ui/ # Reusable UI components
├── store/ # Zustand state management
│ ├── editor-store.ts # Editor state (files, tabs)
│ └── app-store.ts # App state (UI, console, sync)
├── lib/ # Utility functions
│ ├── utils.ts # Helper functions
│ └── templates.ts # Project templates
└── public/ # Static assets
\`\`\`
## Technology Stack
- **Framework**: Next.js 14 with App Router
- **Language**: TypeScript (strict mode)
- **Styling**: Tailwind CSS
- **UI Components**: Radix UI primitives
- **Code Editor**: Monaco Editor
- **State Management**: Zustand
- **Animations**: Framer Motion
- **Icons**: Lucide React
## Key Concepts
### Nexus Engine
The Nexus Engine is AeThex's real-time state synchronization system. It ensures that game state (player positions, health, inventory, etc.) stays consistent across all platforms with minimal latency.
\`\`\`typescript
// Example: Syncing player position
nexusEngine.setState('playerX', 120);
nexusEngine.setState('playerY', 85);
// These values automatically sync to all connected platforms
\`\`\`
### Platform Structure
Projects are organized by platform:
- \`/roblox\` - Lua scripts for Roblox
- \`/web\` - HTML/JS/CSS for web browsers
- \`/mobile\` - React Native for iOS/Android
- \`/desktop\` - Electron for native apps
- \`/shared\` - Cross-platform code and configs
## Templates
AeThex Studio includes several pre-built templates:
- **Roblox Game Starter**: Basic Roblox game setup
- **Cross-Platform Multiplayer**: Fully synced multiplayer
- **Battle Royale**: BR mechanics with safe zones
- **RPG Adventure Kit**: Quests, inventory, progression
- **Social Hub**: Community space with chat
- **Simulator Game**: Incremental gameplay
- **Obby/Parkour**: Obstacle courses
- **Blank Project**: Start from scratch
## Deployment
Deploy your games to multiple platforms with one click:
1. Click "Deploy" in the navbar
2. Select target platform(s)
3. Choose environment (Production/Staging/Development)
4. Deploy!
Supported deployment targets:
- **Roblox**: Direct upload to Roblox Cloud
- **Web**: Deploy to hosting (Vercel, Netlify, etc.)
- **Mobile**: Build and publish to App Store/Play Store
- **Desktop**: Package as standalone executables
## Keyboard Shortcuts
- `Cmd/Ctrl + S` - Save current file
- `Cmd/Ctrl + K` - Open command palette
- `Cmd/Ctrl + P` - Quick file search
- `Cmd/Ctrl + /` - Toggle comment
- `Cmd/Ctrl + B` - Toggle left sidebar
- `Cmd/Ctrl + J` - Toggle bottom panel
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
MIT License - see LICENSE file for details
## Support
- Documentation: [docs.aethex.studio](https://docs.aethex.studio)
- Discord: [discord.gg/aethex](https://discord.gg/aethex)
- Email: support@aethex.studio
## Acknowledgments
Built with ❤️ using:
- Next.js
- TypeScript
- Tailwind CSS
- Monaco Editor
- Radix UI
---
**AeThex Studio** - Build once, deploy everywhere. 🚀