Skip to content

Latest commit

 

History

History
137 lines (90 loc) · 5.96 KB

README.md

File metadata and controls

137 lines (90 loc) · 5.96 KB

 

Logo

State License: GPL v3 windows Version made-with-C++ SFML

GitHub All Releases Github Stars Github forks

 

General description

Multi Race Driving is a general and customized platform for racing games with 2.5D graphics. This platform has been designed using C++ as a high-level programming language, and SFML, a simple interface for various components of your PC, to ease the development of games and multimedia applications.

 

 

1. Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run successfully Multi Race Driving, you must comply the following requeriments:

  • A version of Windows with 64-bit architecture.
  • If you want to run it in MAC or Linux, currently you have to have installed WineHq 5.
  • Download SFML and RapidXML from the links provided previously.
  • Install MinGW in your computer to compile and run the code.

 

Compilation

In order to compile the code you have to do the following instructions:

  • Clone or download this repository with all its content.
  • Open Codeblocks and create a C++ project in the same folder of the repository.
  • Add all the the source (.cc and .cpp) and interface (.h) files provided in the repository.
  • Configure SFML in Codeblocks like it is indicated in the following tutorial.
  • Add all the .dll files with option -d of SFML in the Debug folder for run the project in Debug mode. If you want to run the code project in Release mode you have to add the .dll files without -d option to the Release folder of the project. This step must be done only if you choose dinamic compilation of the libraries. If you choose static compilation, which is explained in the tutorial too, please omit this step.

 

Execution

In order to execute Multi Race Driving, you can do any of the following options:

  • Execute the .exe file generated when you compile the project in your computer.
  • Download the executable file provided in the Release section of the repository. This executable has been linked statically with both MinGW and SFML dependencies, so you don´t have to install anything.

 

2. Software used

To carry out the development of Multi Race Driving the following software has been used:

  • The IDE for C++ programming Codeblocks, version 17.12.
  • The API of SFML, version 2.5.1.
  • The XML parser library RapidXML.
  • Boreas, a C++ implementation of the Linda framework under GPL-3.0 License.

 

3. Outstanding features

This new the following features with respect to the original versions:

  • Multiple game modes for one player.
  • Multiplayer online mode.
  • Different types of vehicles available, customizabled and with many colors.
  • Realistic and spectacular graphics in 2.5D.
  • Realistic physics (speed, braking, collision, inertia).
  • Customizable menus (fonts, colors, images, texts).
  • Compatible with many screen resolutions.
  • Graphics available in HD and in pixel art. quality.
  • Fantastic soundtracks and SFX fully customizable.
  • Various difficulty levels.
  • Numerous types of artificial intelligence integrated.
  • Configuration of the controllers customizable.
  • Completely new scenarios available and customizable.

 

4. Controllers

These are the default controllers of the simulator, but you can change them whenever you want:

  • Acceleration: Left Control.
  • Braking: Left Alt.
  • Turning left: Left arrow of the cursor.
  • Turning right: Right arrow of the cursor.
  • Select an option: Enter.
  • Change the soundtrack which is been sounding during the game: Z.
  • Exit the game during the navigation in the interface, pause the game while the player is driving: Esc.

 

4. Author

 

5. License

Code is released under the GNU General Public License v3.0.

 

6. Supporting the project

This is the first version of the video game. I have tested it as best as I could but I'm absolutely aware that some fault may have due to its complexity, especially in multiplayer mode. The fact that the project is open source is the real way for the community to solve all the possible problems together, feel free to open an issue or do a pull request. See the open issues for a list of known issues (and proposed features).

 

7. Documentation

Please, go to the Wiki in order to be able to see the more details about what Multi Race Driving can offer to you.