README

🚃 INSAtram

🗺️ Table of contents

• 🚃 INSAtram
  • 🗺️ Table of contents
  • 🪧 Introduction
  • 📸 Screenshot
  • 📦️ Installation
    • 🧰 Prerequisite
    • 🎮️ Use
    • 🧑‍💻 Development
  • 🗃️ Structure
  • ℹ️ About
    • ⚖️ Licence
    • 👤 Authors
    • 📃 Credits

🪧 Introduction

This game is a copy of Mini Metro developed by the studio Dinosaur Polo Club. This is a project carried out for the IT project requested by INSA Rouen in the 2nd year of preparatory class. Thus, no intellectual property rights were violated during the realization of this project. It was designed and developed solely from observations made on the game.

📸 Screenshot

📦️ Installation

🧰 Prerequisite

In order to compile the project, you will need to install the following tools :

• First, you need SDL 1.2 library. On ubuntu, install the synaptic packet manager with :

sudo apt install synaptic

• Then, from Synaptic, install the followings packets :
  • libsdl-gfx1.2-dev
  • libsdl-image1.2-dev
  • libsdl-mixer1.2-dev
  • libsdl-ttf2.0-dev
  • libsmpeg-dev

🎮️ Use

You can download the archives containing the binaries here:

• Linux
• Windows

🧑‍💻 Development

You can develop this project by making a fork of it and then clone it on your computer. For compiling the source code, on linux, you can use the following scripts :

• Scripts/Build_Debug.sh : Build for debugging purpose.
• Scripts/Test.sh : Build and run for debugging purpose.
• Scripts/Build_Release.sh : Build for release.

Same thing on Windows, where you can use the following script :

• Scripts/Build_Release.ps1 : Build for release.

🗃️ Structure

The project is structured in folder as follows:

• Binaries : Contains compiled binaries (compiler output).
• Code : Contains the code.
• Resources : Contains the resources of the project (Fonts, Images, Musics).
• Documentation : Contains project documentation (specifications, top-down analysis, final report).
• Librairies : Contains libraries for Windows.
• Scripts : Contains script for testing and compiling the code automatically.

ℹ️ About

⚖️ Licence

This project is under MIT License.

👤 Authors

• Myriem ABID
• Alix ANNERAUD
• Hugo LASCOUTS

📃 Credits

This project uses the following resources :

• Compiler : Free Pascal Compiler
• Graphics library : SDL 1.2
• Icons : Font Awesome
• Background music : Ambiance Guitar X1 - Frankum
• Font : Titillium Web - Accademia di Belle Arti di Urbino