Community Contribution

The MSP Challenge Simulation Platform is openly available for users to download and use, as explained on the Download & Install page.

You might however be interested in developing new Client features, or to create your own Simulations to add additional data calculations to the platform. For this purpose, we have provided the source code of the Client, Server, and Simulations for our community to use for expanding on the MSP Challenge Simulation Platform.

Source Location: MSPChallenge Repository

License: GPL-3.0

Free to extend on the MSP Challenge Platform Edition

Our aim is to allow all community members with enough technical knowledge to freely contribute to the MSP Challenge project, both the content as well as the features. To aid in this effort we decided to release the source code under the GPL-3.0-only license. Under this license you may freely copy, distribute and modify the software as long as you track changes and their dates in source files. This license counts for the data and code made available via the public Github repo.

For more information on the Terms & Condition of using the MSP Challenge Simulation platform, please visit the Terms and Conditions page

Terms & Conditions - MSP Challenge Community

Licensed elements

While the source code of MSP Challenge itself is open source, several packages and plugins have been used to develop the software, which have their own licenses. We are NOT able share many of these files, and ask you to retrieve your own copy if you wish to use these files or plugins. This involves several plugins we purchased via the Unity Asset Store amongst others. You can find these plugins and libraries on the following page on the wiki: Source code - MSP Challenge Community

Our GIS data can only be used by us to create derivate works, not to publicly share, therefore we have provided an example GeoServer, including GIS files and configuration, to assist in the setup and development of community based content.  To find out where exactly we retrieved our data, please visit our Data Sources page.

Retrieving the MSP Challenge Source Data

We chose to host the MSP Challenge on GitHub, being one of the major hosting platforms for Open Source projects. You can find the repository here. Contributors are free to fork the repository, and use this fork to extend on the project, as long as all changes are tracked. Community members are only able to edit their own fork, and cannot directly edit and commit to the public MSP Challenge repository itself.

For more information on how to fork a repository, please visit the documentation page by GitHub - Fork a repo / GitHub Docs

Integration into the open version

Due to the limited resources available to the MSP Challenge development team, we do not guarantee the integration of any contributions made to the MSP Challenge Platform Edition.

After you have successfully expanded on your own fork of the MSP Challenge Simulation Platform, you can create a pull requests. This will notify the MSP Challenge team of external contributions, and allow the team to checkout the files for integration into the publicly available platform. These pull requests require a detailed description of the changes so that the team can properly review the provided changes.

May the team be able to implement public contributions, then the following steps will be part of the integration process:

1. Pull Request

A pull request is created by the contributor, including the altered files, and a clear description of the added or altered functionality.

2. Design Review

A member of the MSP Challenge team will review the design of the contribution, based on the added description.

3. Code Review

A member of the MSP Challenge team will review the code of the contribution.

4. Integration

The contribution is integration via the development branch of the MSP Challenge Simulation Platform, to allow for internal testing.

5. Publication

If all above steps have been succesfully ended, the contribution can become part of the public version.

For more information on creating pull requests, please visit the documentation page by GitHub - About pull requests / GitHub Docs

Support

The MSP Challenge is being developed by a core team, part of the Academy of Games and Media at the Breda University of Applied sciences. Because of this, we do not have the resources to develop and offer an infrastructure of support for contributions. While we allow our community to fork, and extend on the MSP Challenge, we can not guarantee that we will be able to answer any issues posted as part of the MSP Challenge repo, or integrate any extensions developed by community members.

For information on the latest public release, please see the release notes on our Wiki

Release notes - MSP Challenge Community