IMM-Project (Alpha Version)

Welcome to the alpha version of the IMM-Project, an Interactive Multimedia Final Project. This project is currently in its early stages of development, and we appreciate your interest and contributions.

Table of Contents

• IMM-Project (Alpha Version)
  • Table of Contents
  • Main Section, not that boring stuff that is after this section
    • Where to Play
    • Research
  • Getting Started
  • Project Structure
  • Contributing
  • License
    • Authors
  • Acknowledgements
    • Sources

Main Section, not that boring stuff that is after this section

Tip

This is the main section of the README file. It contains the main information about the project, everything you need to know about the project without Project Structure, Clone, Contributing and License sections. This section is the first thing that the user sees when they open the README file. It should contain the most important information about the project, such as where to play, research, and other important information.

Where to Play

There is only WebGL build available for now (for Alpha version). You can play the game on your browser 💻.

⚠️ Warning: The WebGL build is not optimized for mobile devices. We recommend playing the game on a desktop or laptop for the best experience.

Important

WebGL Buids released on:

• Github Pages
• Unity Play

Research

We have done some research to develop this project. Based on our experience on ads that display the similar games, but the game wasn't the same. We decided to create a game that will be similar to that ads. We have found some useful information that helped us to develop the game.

Note

Here is a list of sources used for development, inspiration, and learning. Use a structured approach:

• Join Clash 3D Game
• Basic concepts
• Advisor

Getting Started

To get started with the project, follow these steps:

• Install Unity Hub and Unity 6000.0.25f1 (we are using this version, but you can try other versions)
  1. Download and install Unity Hub from the Unity website.
  2. Install Unity Editor
• Clone the repository
  1. Clone the repository. (the alpha branch - this branch)

     git clone -b alpha https://github.com/DanyilT/IMM-Project

  2. Open the project in Unity.

Project Structure

The project is organized as follows:

• Assets/: Contains all the game assets
  • Materials/: Contains materials used in the project
  • Prefabs/: Contains prefabs used in the project
  • Scenes/: Contains scenes used in the project
  • Scripts/: Contains scripts used in the project
  • Settings/: Contains settings used in the project
  • TextMesh Pro/: Contains TextMesh Pro assets (automatically generated), We are using TextMesh Pro for text rendering
• Packages/: Manages the project's dependencies
• ProjectSettings/: Contains various project settings
• .gitignore: Specifies intentionally untracked files to ignore
• LICENSE: The license for the project
• README.md: The project's README file (You are here)

Contributing

We welcome contributions to the project. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

3. Commit your changes:

   git commit -m "Description of your changes"

4. Push to the branch:

   git push origin feature/your-feature-name

5. Create a pull request.

License

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

Authors

The project was created by Danyil Tymchuk & Artem Surzhenko

Acknowledgements

Sources

Sources in sources.md

• The project uses the LiberationSans font, licensed under the SIL Open Font License, Version 1.1. See Assets/TextMesh Pro/Fonts/LiberationSans - OFL.txt for details.

---

Thank you for your interest in the IMM-Project. We look forward to your contributions and feedback!