🎭 Donk Hello Menu

A comprehensive synced animation menu for FiveM servers with support for both QBCore and ESX frameworks.

---

📋 Features

• 🔄 Synced Animations - Perfectly synchronized animations between two players
• 🎮 Dual Framework Support - Works seamlessly with both QBCore and ESX
• 🎨 Modern UI - Clean and intuitive ox_lib menu interface
• 🐛 Debug Mode - Test animations with AI clones before using with partners
• 🚗 Vehicle Support - Special animations designed for in-vehicle scenarios
• ❌ Cancel Anytime - Press X key to cancel any animation in progress
• 👥 Partner Selection - Easy partner selection with distance indicators
• 🔒 Safety Checks - Prevents animation usage when handcuffed, downed, or dead

📦 Dependencies

• ox_lib - Required for menu system
• qb-core or es_extended - Framework dependency

🚀 Installation

1. Download the latest release
2. Extract donk_hellomenu to your server's resources folder
3. Add ensure donk_hellomenu to your server.cfg
4. Restart your server

ensure ox_lib
ensure donk_hellomenu

🎮 Usage

Opening the Menu

Trigger the menu using:

TriggerEvent('donk_hellomenu:Client:OpenMenu')

Or set up a command in your framework:

RegisterCommand('hellomenu', function()
    TriggerEvent('donk_hellomenu:Client:OpenMenu')
end)

Controls

• X Key - Cancel any ongoing animation
• Enter - Accept animation requests
• Backspace - Decline animation requests

How to Use

1. Open the menu
2. Select a partner from nearby players
3. Choose an animation from the Actions menu
4. Wait for your partner to accept
5. Press X at any time to cancel the animation

⚙️ Configuration

Edit config.lua to customize settings:

Config.Debug = false -- Enable debug mode for testing with AI clones
Config.MaxDistanceToStart = 2.0 -- Maximum distance to start synced animations
Config.CancelAnimationKey = 73 -- X key to cancel animations (control ID)

Adding Custom Animations

Add new animations to Config['Synced'] table:

{
    ['Label'] = 'Animation Name',
    ['RequesterLabel'] = 'Request Message',
    ['Car'] = false, -- Set to true for vehicle animations
    ['Requester'] = {
        ['Type'] = 'animation',
        ['Dict'] = 'anim_dict',
        ['Anim'] = 'anim_name',
        ['Flags'] = 1,
        ['Attach'] = { -- Optional attachment settings
            ['Bone'] = 9816,
            ['xP'] = 0.0,
            ['yP'] = 0.0,
            ['zP'] = 0.0,
            ['xR'] = 0.0,
            ['yR'] = 0.0,
            ['zR'] = 0.0,
        }
    },
    ['Accepter'] = {
        ['Type'] = 'animation',
        ['Dict'] = 'anim_dict',
        ['Anim'] = 'anim_name',
        ['Flags'] = 1,
    },
}

🎯 Available Animations

The menu includes a variety of synced animations:

• Standing animations
• Vehicle animations (driver/passenger)
• Position-based animations (missionary, doggystyle, cowgirl, spooning, etc.)
• Multiple variations for different scenarios

🐛 Debug Mode

Enable debug mode in the config to test animations with an AI clone:

Config.Debug = true

This will add a "Actions (Debug)" option to the main menu, allowing you to preview animations without needing a partner.

🔧 Troubleshooting

Menu not opening?

• Ensure ox_lib is installed and started before donk_hellomenu
• Check F8 console for errors

Animations not syncing?

• Make sure both players are within the configured distance
• Verify that neither player is handcuffed, downed, or dead

Partner can't accept request?

• Check that the partner is not in a vehicle (unless it's a vehicle animation)
• Ensure they're not already in another animation

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📞 Support

If you need help or have questions:

• Open an issue on GitHub
• Check existing issues for solutions

🙏 Credits

• Animation dictionaries from GTA V
• Menu system powered by ox_lib
• Framework integrations for QBCore and ESX

---

Made with ❤️ for the FiveM community