Giter Club home page Giter Club logo

r-type's Introduction

GitHub Super-Linter

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Authors
  6. Acknowledgments

About The Project

R-Type is an Epitech project during 3rd years. In this project we need to create a game with our own Game Engine. We use a specific architecture who is ECS (Entity-Component-System)

Here's why:

  • ECS is specifically for the game
  • Better performance
  • More scalability to grow up the project

(back to top)

Getting Started

Installation

On Linux (Fedora) / MacOs

If you are on other linux os you have to download yourself cmake and libX11 and do not use build.sh but cmake .

  1. Clone the repo
 git clone --recurse-submodules https://github.com/EpitechPromo2025/B-CPP-500-MLH-5-1-rtype-arnaud.issoire.git
  1. Run build.sh
 ./build.sh
  1. Run binary
    ./r-type_client
    ./server-binary <port>

On Windows

  1. Clone the repo
  git clone --recurse-submodules https://github.com/EpitechPromo2025/B-CPP-500-MLH-5-1-rtype-arnaud.issoire.git
  1. Run build.sh
  ./build.sh
  Or Double click on it
  1. Run r-type_client.sln file
  Open the r-type_client.sln file with Visual Studio
  1. Set in Realase mode

  2. Click on execute

  3. En error can appear, just click on Yes and run windows_move.sh

  ./windows_move.sh
  Or Double click on it
  1. Click on execute again
  2. Run the binary in realase folder in the root of the project
  ./r-type_client
  Or Execute the binary with Administrator mode

  The server can only be run with ./server-binary <port>

Packages on Linux

  1. Run ./build.sh
  2. Run sudo make package
  3. You can find the package in the _CPack_Packages/Linux/
  4. Run the created .sh file at the root of the repository

(back to top)

If you just want to play the game

  1. Clone the repo
  2. Run the Game_Setup.msi in the folder windows_installer and follow the instructions

Usage

Please refer to the Documentation

Also you can see the the template created for you in the Template folder to get more information about the project.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "newFeature". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Authors

๐Ÿ‘ค Marc Bieber

๐Ÿ‘ค Jermey Chenet

๐Ÿ‘ค Arnaud Issoire

Acknowledgments

(back to top)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.