118 lines
2.8 KiB
Markdown
118 lines
2.8 KiB
Markdown
# Building AeThex Engine on Windows
|
|
|
|
## Prerequisites
|
|
|
|
1. **Python 3.6+**
|
|
- Download from [python.org](https://www.python.org/downloads/)
|
|
- Make sure to check "Add to PATH" during installation
|
|
|
|
2. **SCons Build Tool**
|
|
```powershell
|
|
pip install scons
|
|
```
|
|
|
|
3. **Visual Studio 2022 Community** (Free)
|
|
- Download from [visualstudio.microsoft.com](https://visualstudio.microsoft.com/downloads/)
|
|
- Install "Desktop development with C++" workload
|
|
- Includes MSVC compiler and Windows SDK
|
|
|
|
**OR**
|
|
|
|
**MinGW-w64** (Alternative)
|
|
- Download from [winlibs.com](https://winlibs.com/)
|
|
- Extract and add `bin` folder to PATH
|
|
|
|
## Build Steps
|
|
|
|
### Using PowerShell or Command Prompt:
|
|
|
|
```powershell
|
|
# Clone repository (if not already done)
|
|
git clone https://github.com/AeThex-LABS/AeThex-Engine-Core
|
|
cd AeThex-Engine-Core\engine
|
|
|
|
# Build with MSVC (recommended)
|
|
scons platform=windows target=editor -j4
|
|
|
|
# OR build with MinGW
|
|
scons platform=windows target=editor use_mingw=yes -j4
|
|
```
|
|
|
|
### Build Time
|
|
- **First build**: 30-60 minutes
|
|
- **CPU cores**: Use `-j4` or `-j8` based on your CPU
|
|
- **RAM**: Recommend 8GB+ available
|
|
|
|
## Build Output
|
|
|
|
The executable will be created at:
|
|
```
|
|
engine\bin\aethex.windows.editor.x86_64.exe
|
|
```
|
|
|
|
Or rename after build:
|
|
```powershell
|
|
cd engine\bin
|
|
ren godot.windows.editor.x86_64.exe aethex.windows.editor.x86_64.exe
|
|
```
|
|
|
|
## Running the Engine
|
|
|
|
```powershell
|
|
cd engine\bin
|
|
.\aethex.windows.editor.x86_64.exe
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Error: "MSVC not found"
|
|
- Make sure Visual Studio 2022 is installed with C++ workload
|
|
- Restart terminal after installation
|
|
- Try running from "Developer Command Prompt for VS 2022"
|
|
|
|
### Error: "scons: command not found"
|
|
- Ensure Python is in PATH
|
|
- Run: `pip install --upgrade scons`
|
|
- Restart terminal
|
|
|
|
### Error: "Out of memory"
|
|
- Reduce parallel jobs: use `-j2` instead of `-j4`
|
|
- Close other applications
|
|
- Increase virtual memory in Windows settings
|
|
|
|
### Build too slow?
|
|
- Use more CPU cores: `-j8` (match your CPU count)
|
|
- Use SSD for faster compilation
|
|
- Build in Release mode is faster than Debug
|
|
|
|
## Windows-Specific Features
|
|
|
|
AeThex Engine on Windows includes:
|
|
- Native Windows UI integration
|
|
- DirectX 12 / Vulkan rendering
|
|
- Xbox controller support out-of-the-box
|
|
- Windows-native file dialogs
|
|
- Steam integration ready
|
|
|
|
## Cross-Platform Development
|
|
|
|
You can develop on Windows and export to:
|
|
- Windows (native)
|
|
- Linux
|
|
- macOS
|
|
- Android
|
|
- iOS
|
|
- Web (HTML5)
|
|
- Consoles (with licenses)
|
|
|
|
## Next Steps
|
|
|
|
After building:
|
|
1. Launch the editor
|
|
2. Create a test project
|
|
3. Configure AI features (add Claude API key)
|
|
4. Start developing!
|
|
|
|
## GitHub Actions Alternative
|
|
|
|
Don't want to build locally? Push to GitHub and let CI/CD build for you automatically! Check `.github/workflows/build.yml` for the automated build pipeline.
|