Skip to main content

Community Contributions

ITsMagic is a community-driven engine.

Its documentation, examples, and learning resources are open source, and everyone is welcome to help improve them.

This page explains how you can contribute and why your participation matters.

Why Contribute?​

By contributing, you help:

  • Improve documentation clarity
  • Add tutorials and examples
  • Fix mistakes or outdated information
  • Share reusable components and mechanics
  • Support new developers
  • Strengthen the ITsMagic ecosystem

Even small changes—like correcting a typo or clarifying a paragraph—make a meaningful impact.

Documentation Is Open Source​

The official documentation repository is hosted on GitHub:

https://github.com/ITsMagic-Software/Documentation

You are free to:

  • Read all source files
  • Suggest improvements
  • Fix errors
  • Add new documentation pages
  • Submit examples

All contributions are handled through standard GitHub pull requests.

Start by Reading the Docs​

Before contributing, we strongly recommend reviewing the core documentation:

  • Engine introduction
  • Component system
  • Lifecycle methods (start, repeat, etc.)
  • Existing examples

Main documentation entry point:

https://itmagic.com.br/documentation/docs/intro/

Understanding these fundamentals ensures your contributions stay consistent with ITsMagic design patterns.

Ways You Can Help​

Improve Documentation​

You can help by:

  • Fixing grammar or spelling
  • Clarifying confusing explanations
  • Adding comments to code samples
  • Writing beginner tutorials
  • Expanding existing pages

If something feels unclear to you, it probably is for others too.

Add Examples​

Examples are one of the most valuable contributions.

You may submit:

  • Gameplay components
  • Movement systems
  • Laser or weapon mechanics
  • UI components
  • Camera behaviors
  • Visual effects

Each example should include:

  • Clean, minimal code
  • A short explanation
  • What problem it solves

Report Issues​

If you find a problem:

  • Open a GitHub issue
  • Describe the problem clearly
  • Include code or screenshots when possible

Clear reports save time for maintainers and contributors.

Contribution Workflow​

Basic process:

  1. Fork the Documentation repository
  2. Make your changes
  3. Commit with a clear message
  4. Open a Pull Request

No special permissions are required.

Contribution Guidelines​

Please follow these principles:

  • Keep code simple and readable
  • Use standard ITsMagic Component patterns
  • Avoid unnecessary Java imports
  • Explain why, not just what
  • Assume beginners are reading

Clarity is more important than cleverness.

What Makes a Good Contribution?​

A good contribution:

  • Solves a real problem
  • Is easy to understand
  • Uses official ITsMagic APIs
  • Includes explanations
  • Helps new users onboard faster
tip

You don’t need to be an expert to contribute.

If you learned something new, document it.
If you solved a problem, share it.

Teaching others is one of the fastest ways to improve the engine.

Community First​

ITsMagic grows through its users.

Every tutorial, example, fix, and explanation helps build a stronger ecosystem.

Thank you for being part of the community.