Contributing
Project N.E.K.O. is open source under the MIT License. Contributions are welcome from developers, creators, and community members worldwide.
How to contribute
- Fork the repository on GitHub
- Create a branch for your feature or fix
- Set up your environment — Python 3.11 + uv, Node.js >= 20.19 (required for frontend builds via
build_frontend.bat/build_frontend.sh) - Make your changes following the code style guidelines
- Test your changes (
uv run pytest) - Submit a Pull Request with a clear description
AI-Assisted Development
The project includes built-in configurations for AI coding assistants (Claude Code, Cursor, etc.). If you develop with these tools, they will automatically load the project's rules and skills. See AI-Assisted Dev for details and how to adapt them for other AI tools.
Nuitka packaging
If you add directories holding Python code or new dynamic imports, read Nuitka Packaging Caveats first. Nuitka silently drops .py files from --include-data-dir, and the wrong directory naming breaks the standalone build without breaking source-mode tests.
What we need
- Backend developers — Python, FastAPI, WebSocket, AI/ML integration
- Frontend developers — JavaScript, Live2D/Three.js, CSS
- Creators — Live2D/3D modelers, voice actors, character designers
- Translators — Help expand i18n coverage
- Testers — Bug reports and feature feedback
Community
- Discord: Join us
- QQ Group: 1022939659
- GitHub Issues: Report bugs or request features
License
The core engine is licensed under MIT and will remain open source. Your contributions may be included in official Steam and App Store releases.