ARCADE

Built with the tools and technologies:

---

Table of Contents

• Table of Contents
• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

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 plateform at run-time, your graphics libraries and your games must be implemented as dynamic libraries, loaded at run-time. Each GUI available for the program must be used as a shared library that will be loaded and used dynamically by the main program. This also applies to your games.

---

Features

❯ Dynamic libraries
❯ Graphic libraries
❯ Games

---

Project Structure

└── /
    ├── CMakeLists.txt
    ├── include
    │   ├── game
    │   └── graphics
    └── src
        ├── graphics
        └── main.cpp

Project Index

/

__root__

⦿ __root__

File Name	Summary
CMakeLists.txt	Code>❯ REPLACE-ME

src

⦿ src

File Name	Summary
main.cpp	Code>❯ REPLACE-ME

graphics

⦿ src.graphics

SDL2

⦿ src.graphics.SDL2

File Name	Summary
SDL2.cpp	Code>❯ REPLACE-ME

ncurses

⦿ src.graphics.ncurses

File Name	Summary
Ncurses.cpp	Code>❯ REPLACE-ME

include

⦿ include

graphics

⦿ include.graphics

File Name	Summary
IGraphic.hpp	Code>❯ REPLACE-ME

SDL2

⦿ include.graphics.SDL2

File Name	Summary
SDL2.hpp	Code>❯ REPLACE-ME

ncurses

⦿ include.graphics.ncurses

File Name	Summary
Ncurses.hpp	Code>❯ REPLACE-ME

game

⦿ include.game

File Name	Summary
IGame.hpp	Code>❯ REPLACE-ME

---

Getting Started

Prerequisites

This project requires the following dependencies:

• Programming Language: CPP
• Package Manager: Cmake

Installation

Build from the source and intsall dependencies:

1. Clone the repository:

git clone ../

2. Navigate to the project directory:

cd 

3. Install the dependencies:

<!-- [![cmake][cmake-shield]][cmake-link] -->
<!-- REFERENCE LINKS -->
<!-- [cmake-shield]: https://img.shields.io/badge/C++-00599C.svg?style={badge_style}&logo=c%2B%2B&logoColor=white -->
<!-- [cmake-link]: https://isocpp.org/ -->

**Using [cmake](https://isocpp.org/):**

```sh
cmake . && make
```

Usage

Run the project with:

Using cmake:

cmake --build .
./arcade ./lib/*.so

Testing

uses the {test_framework} test framework. Run the test suite with:

Using cmake:

ctest

---

Roadmap

• Task 1: Implement libarcade.
• Task 2: Pick two games.
• Task 3: Make maths methods to display these games.
• Task 4: Develop both games.
• Task 5: Implement robustness and parsing tests.
• Task 6: Implement games tests.

---

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the `` project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your LOCAL account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone ./

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to LOCAL: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

is protected under the LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• Credit contributors: Mateoantoni, AdryzR, RvbyY, inspiration: arcade stations, references: School project Interface collaborators group leaders: pierre.cufer@epitech.eu (selected as collaboration partner for grading), christophe.dronne@epitech.eu, maryam.larsanova@epitech.eu

---