Skip to content

Sakutaroo/R-Type

Repository files navigation

R-Type

Build Release License: MIT

No. Titre
1. Prerequisites
2. Installing
3. Building
4. How to run
5. Built With
6. Authors
7. Contributions
8. License

This project is a network implementation in C++ of the best-selling video games R-Type. This project is based on an Entity Components System (ECS) for managing game entities and their behaviors.

Prerequisites

What things you need to install the software and how to install them.

  • C++ Compiler (supporting C++20)
  • Python (3.8^)

Installing

  1. Clone the repository
git clone https://github.com/Sakutaroo/R-Type
  1. Navigate to the project directory
cd R-Type

Building

Basic build

python build.py

Usage and build options

Usage:
    python build.py [--no-graphics] [--log-level LEVEL]

Options:
    --no-graphics       Do not show the graphics window.
    --log-level LEVEL   Set the log level. [default: info] [options: trace, debug, info, warn, err, critical, off]
    --test              Build the test version.
    --help              Show this screen.

How to run

Run the server

USAGE : ./r-type_server [PORT]

Start the R-Type server on the specified port.

Run the client

USAGE : ./r-type_client [IP] [PORT]

Start the R-Type client and connect to the server at the specified IP and port.

Built With

  • C++ - The game engine, game and network.
  • Cmake - Used for build.
  • Python - Used for scripting.

Authors

Contributions

We invite contributions aimed at enhancing R-Type. To participate, please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b BRANCH_NAME
  3. Make your changes and commit them: git commit -m MESSAGE
  4. Push to the branch: git push origin BRANCH_NAME
  5. Submit a pull request

Please maintain adherence to the branch and commit naming conventions.

Please ensure that your pull request follows the project's guidelines.

License

R-Type is available under the MIT license.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors