AeThex-Engine-Core/docs/GETTING_STARTED.md
2026-02-23 04:47:38 +00:00

91 lines
2.2 KiB
Markdown

# Getting Started with AeThex Engine
## Your Journey Starts Here 🚀
Don't worry if this feels overwhelming - we'll take it step by step!
## What You Have Right Now
✅ Godot Engine source code (in the `engine/` folder)
✅ Project structure set up
✅ This awesome documentation
## What You Need to Do Next
### Step 1: Install Build Tools (5 minutes)
Run this command to install everything you need:
```bash
sudo apt-get update && sudo apt-get install -y \
build-essential scons pkg-config libx11-dev libxcursor-dev \
libxinerama-dev libgl1-mesa-dev libglu-dev libasound2-dev \
libpulse-dev libudev-dev libxi-dev libxrandr-dev
```
### Step 2: Build Your First Engine (15-30 minutes)
```bash
cd /workspaces/AeThex-Engine-Core/engine
scons platform=linuxbsd target=editor -j4
```
This will compile the engine. Grab a coffee ☕ - it takes a while the first time!
### Step 3: Run It!
```bash
./bin/godot.linuxbsd.editor.x86_64
```
🎉 **Congratulations!** You just built a game engine from source!
## Common Issues & Solutions
### "scons: command not found"
→ Run the install command from Step 1
### Build fails with "missing header"
→ Make sure all dependencies are installed (Step 1)
### Build takes forever
→ That's normal for the first build! Subsequent builds are much faster
### I'm stuck!
→ Ask Claude (me!) for help - just describe what's happening
## What's Next?
Once you have the engine built:
1. **Explore** - Click around, see how it works
2. **Customize** - Start changing colors, text, features
3. **Learn** - Check out Godot tutorials to understand the codebase
4. **Build** - Add your first unique AeThex feature!
## Pro Tips
- Use `-j4` or `-j8` flag to compile faster (parallel jobs)
- The engine remembers what's compiled - rebuilds are quick!
- Change one small thing at a time
- Test frequently
- Ask Claude for help anytime
## Your First Customization Ideas
**Easy:**
- Change the splash screen logo
- Modify the default project name
- Add a custom color theme
**Medium:**
- Add a new menu item
- Create a custom export template
- Build a new tool window
**Advanced:**
- Integrate an AI API
- Add cloud save functionality
- Create a new node type
---
**Remember:** Every expert was once a beginner. You've got this! 💪