Manic EMU is an all-in-one retro game emulator for iOS. It packs powerful features while keeping a clean, sleek UI and delivering buttery-smooth gameplay.
Contributing to Manic EMU
First off, thank you for considering contributing to Manic EMU!
This project is built by a passionate community, and we welcome contributions that improve the emulator, documentation, and user experience.
๐ Code of Conduct
By participating, you are expected to uphold our Code of Conduct.
Please be respectful and constructive in all interactions.
๐ Ways to Contribute
You can contribute in several ways:
- Reporting bugs and crashes
- Suggesting new features or improvements
- Improving documentation and translations
- Submitting patches or pull requests
- Testing builds and providing feedback
๐ Reporting Issues
- Use the GitHub Issues page to report bugs or request features.
- Before opening a new issue, check if it already exists.
- Include as much detail as possible: device, iOS version, emulator core, game/ROM, and steps to reproduce.
๐ง Development Setup
- Clone the repository:
git clone https://github.com/Manic-EMU/ManicEMU.git cd ManicEMU - Install prerequisites:
- Xcode 16+
- VulkanSDK
- Boost
- Other dependencies as listed in the README.
- Build and run using Xcode.
๐ Pull Request Guidelines
- Fork the repo and create a new branch (
feature/your-feature-nameorfix/your-bug-name). - Keep PRs focused and avoid bundling unrelated changes.
- Ensure your code compiles and passes existing tests (if applicable).
- Add or update documentation if your changes affect user-facing behavior.
- Reference related issue numbers in your PR description.
- Use clear commit messages (see below).
๐ฌ Commit Message Conventions
We follow a simplified convention for commit messages:
fix:for bug fixesfeat:for new featuresdocs:for documentation changeschore:for maintenance tasksrefactor:for code structure changes without functional impact
Example:feat: add joystick deadzone setting for N64 core
๐ฆ Licensing
By contributing to Manic EMU, you agree that your contributions will be licensed under the same license as the project (AGPL-3.0).
Please make sure that any code you submit is your own or compatible with the projectโs license.
๐ค Getting Help
- Join our Discord community for discussion and support.
- Check the README for build/setup details.
- If in doubt, open a draft PR or discussion โ weโll be glad to guide you.
Thanks again for helping make Manic EMU better!