R-Type

The r-type logo

This is the r-type project You can find more information in the sections below:

Or online at: rtype.pingpal.news

Table of contents

• Introduction
• Getting started
  • Dependencies
    • Pre-built
    • From source
  • Obtaining the source code
  • Pre-compiled
  • Deploy from source
  • Running the programs
  • Troubleshooting
    • Common Issues
      • Missing dependencies
      • Build fails
      • Missing ressources
      • Permission issues
      • Runtime errors
    • Debugging tips
    • Getting help
• Client
  • Introduction
  • Compiling
  • Running the client
  • Configuration file
  • Troubleshooting
    • Common issues
      • Missing dependencies
      • Cmake configuration fails
      • Build errors
      • Runtime errors
      • Graphics issues
      • Missing or corrupted assets
    • Debugging Tips
    • Getting help
• Sever
  • Introduction
  • Compiling
  • Running the server
  • Configuration file
  • Troubleshooting
    • Common issues
      • Missing dependencies
      • CMake configuration failure
      • Build errors
      • Runtime errors
      • Networking issues
      • High latency or disconnects
    • Debugging tips
    • Getting help
• Protocol
  • Brief
  • UDP Protocole | SERVER / CLIENT COMMUNICATION
    • Binary Message Format
    • Types of Messages the Server Expects and Sends
      • CONNECT (0x01)
      • DISCONNECT (0x02)
      • MOVE (0x03)
      • SHOOT (0x04)
      • SPAWN (0x05)
      • UPDATE (0x06)
      • ERROR (0xFF)
    • Error Handling
    • Use cases in game logic and GUI
    • Notes on implementation
• Commit convention
• Authors
• License
• Contributing
• Code of Conduct

Introduction

R-type is a game engine that is composed of a server and a client.

The aim is to have a game that can be multiplayer and have many clients connect to it.

Getting started

• Dependencies
  • Pre-built
  • From source
• Obtaining the source code
• Pre-compiled
• Deploy from source
• Running the programs
• Troubleshooting

Client

• Introduction
• Compiling
• Running the client
• Configuration file

Server

• Introduction
• Compiling
• Running the server
• Configuration file

Protocol

• Brief
• UDP Protocole | SERVER / CLIENT COMMUNICATION
  • Binary Message Format
  • Types of Messages the Server Expects and Sends
    • CONNECT (0x01)
    • DISCONNECT (0x02)
    • MOVE (0x03)
    • SHOOT (0x04)
    • SPAWN (0x05)
    • UPDATE (0x06)
    • ERROR (0xFF)
  • Error Handling
  • Use cases in game logic and GUI
  • Notes on implementation

Commit convention

If you wish to contribute, we strongly suggest that you take a look at the COMMIT_CONVENTION

Authors

This project was written by:

• Marianna Titova
• Tristan Wehrle
• Arthur-agusto Claro-sardella
• Henry Letellier

License

This project is licensed under the MIT License.

However, because this follows the rules of the Epitech school so other terms provided by the school may apply

Contributing

Contributions are welcome! If you would like to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-name).
3. Commit your changes (‘git commit -m 'Add feature’).
4. Push to the branch (git push origin feature-name`).
5. Open a pull request.

See the Contributing Guidelines for more details

Code of conduct

Please note that we follow the Contributor Covenant Code of Conduct. This means that we expect all contributors to behave in a respectful and professional manner. If you have any questions or concerns, please don't hesitate to reach out.