OVERDRIVE

"The next-generation racing simulation, driven by the community"

Table of Contents

1. About The Project
2. Features
3. Getting Started
4. Contributing
5. Gallery
6. License

🎯 About The Project

Overdrive is an open-source racing simulator, created with the aim of providing a realistic and customizable driving experience.

Languages and Tools 🛠

✨Main Features

Objectives:

1. Advanced Conduction Physics: A tire and aerodynamics simulation model developed from scratch, ensuring a true-to-life experience.
2. Modular Content: A system of cars and tracks that allows the community to easily add, modify, and share content.
3. Full Hardware Support:Native compatibility with steering wheels, pedals, gear shifters, and more.

🚀 Getting Started

Instructions for setting up the project locally

For Players (Precompiled):

1. Download the latest executable version from releases branch.
2. Unzip the file and run the game directly.
3. The executable will be in the folder build/bin.

For Developers (From the Source Code)

# Clone the repository
git clone https://github.com/dnbsammie/overdrive.git
cd overdrive

⚙️ Technologies and System Requirements

Technologies Used

• Game Engine: Unity engine
• Programming Language: C#, JSON

🤝 Contributing

I greatly appreciate your contributions to this project! To maintain order and clarity, please use the predefined templates for Pull Requests and Issues. Follow the steps below:

How to send a Pull Request (PR)?

If you would like to propose a change, follow these steps. For new features, always use a branch named features/your-feature-name.

1. Fork the repository
2. Create a new branch following the naming convention
3. Before pushing, run git pull origin main to sync with the latest changes
4. Open a Pull Request using the pull_request_template.md. Do not skip the template.
5. Complete all required fields: description, motivation, and context

How to report an Issue?

If you find a bug or have a suggestion, please open an Issue. For bug fixes or issue-related work, use issues/issue-number.

1. Go to the Issues section of the repository.
2. Click on **New Issue**.
3. GitHub will offer you different types of templates. Select the one that best suits your needs (for example, "bug_report" or "features_request").
4. Fill out the template with as much detail as possible so that we can help you efficiently.

Your help is invaluable! If you have any questions or need assistance, don’t hesitate to reach out.

⚖️ License

This project is open-source and is released under the MIT License.

This license grants you the freedom to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. We invite you to use our work as a foundation for your own projects, both personal and commercial.

If you have any questions about the license or its application, please feel free to open an issue or contact me directly.

---

🚀 Enjoy the code and keep improving the project!