Arcade

A Retro Platform

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Exemple
4. License
5. Contact

About The Project

Subject PDF

Arcade is a gaming platform: a program that lets the user choose a game to play and keeps a register of player scores.

To be able to deal with the elements of your gaming platform at run-time, your graphics libraries and your games must be implemented as dynamic libraries, loaded at runtime.

Built With

This project use:

• CPP            
• SFML          
• Ncurse       
• SDL2      

Getting Started

Installation

How to run the arcade project and play fun video games

1. Clone the repo

   git clone git@github.com:EpitechPromo2026/B-OOP-400-STG-4-1-arcade-marie.giacomel.git

2. Compile files

   mkdir build; cd build/; cmake .; make -j; cd ..

3. Run the program

   ./arcade ./[graphicLib-name].so

Adding a graphic library

If you wish to add a graphic library, your library must implement the IDisplayModule interface, otherwise it wont work. Also, your library should implement an entry point named entryPointDisplay. This function should return a new instance of your graphical library. If everything is correctly setup, your new graphical library should be present in the menu when starting the arcade. Please refer to the documentation for more in-depth explanation.

Adding a game library

If you wish to add a game library, your library must implement the IGameModule interface, otherwise it wont work. Also, your library should implement an entry point named entryPointGame. This function should return a new instance of your game library. If everything is correctly setup, your game should appear in the menu when starting the arcade. Please refer to the documentation for more in-depth explanation.

About controls

Controls are very basic, here's an exhaustive list :

• Z (upward movement)
• Q (move to the left)
• S (downward movement)
• D (move to the right)
• F (F key)
• E (E key)
• Space (Spacebar)
• Escape (Escape key)
• F1 (Previous graphic library)
• F2 (Next grahpic library)
• F3 (Previous game)
• F4 (Next game)
• F5 (Restart the game)
• F6 (Go back to menu)
• F7 (Exit the arcade)

Exemple

This project is still under development

For more information, please refer to the Documentation

License

This project belongs to its authors, copying it will be sanctioned by Marvin

Contact

Guillaume Hein - [GitHub] - guillaume.hein@epitech.eu

Marie Giacomel - [GitHub] - marie.giacomel@epitech.eu

Mehdy morvan - [GitHub] - mehdy.morvan@epitech.eu

Project Link: https://github.com/EpitechPromo2026/B-OOP-400-STG-4-1-arcade