HelpFunctions.cpp

Go to the documentation of this file.

/*
** EPITECH PROJECT, 2024
** rtype (Workspace)
** File description:
** HelpFunctions.cpp
*/
 
#include <iostream>
#include "Constants.hpp"
 
static void displayUsageSummary(const std::string binName)
{
    std::cout << "USAGE:\n";
    std::cout << "\t" << binName << " [--ip] [--port] [--log] [--debug] [--help] [--version]";
    // std::cout << " [--full-screen] [--window-width] [--window-height]";
    std::cout << " [--frame-rate-limit] [--config-file] [--username]";
    std::cout << " [--position-x] [--position-y] [--window-title]";// [--cursor] ";
    // std::cout << " [--cursor-icon] [--image-is-sprite] [--sprite-start-top] ";
    // std::cout << " [--sprite-start-left] [--sprite-width] [--sprite-height]";
    std::cout << std::endl;
}
 
static void displayDetailedUsage()
{
    std::cout << "OPTIONS:\n";
    std::cout << "\t--ip=\"127.0.0.1\"            \tSet the value of the ip on which the program will communicate. (Default value: 127.0.0.1)\n";
    std::cout << "\t--port=\"9000\"               \tSet the value of the port on which the program will communicate. (Default value: 9000)\n";
    std::cout << "\t--log                         \tEnable logging.\n";
    std::cout << "\t--debug                       \tEnable debug logging. (if this option is provided, the --log flag becomes forced regardless of it being provided or not)\n";
    std::cout << "\t--help                        \tDisplay this help message and exit.\n\n";
    std::cout << "\t--version                     \tDisplay the version of the program and exit.\n";
    // std::cout << "\t--full-screen                 \tEnable full screen mode.\n";
    // std::cout << "\t--window-width=\"800\"        \tSet the width of the window. (Default value: 800)\n";
    // std::cout << "\t--window-height=\"600\"       \tSet the height of the window. (Default value: 600)\n";
    std::cout << "\t--frame-rate-limit=\"60\"     \tSet the frame rate limit of the window. (Default value: 60)\n";
    std::cout << "\t--config-file=\"client_config.toml\" \tSet the path to the toml file that contains the sprites to load. (Default value: client_config.toml)\n";
    std::cout << "\t--username=\"Player\"         \tSet the name of the player that is going to connect (Default value: \"Player\")\n";
    std::cout << "\t--position-x=\"0\"            \tSet the x position of the window. (Default value: 0)\n";
    std::cout << "\t--position-y=\"0\"            \tSet the y position of the window. (Default value: 0)\n";
    std::cout << "\t--window-title=\"R-Type\"     \tSet the title of the window. (Default value: \"R-Type\")\n";
    // std::cout << "\t--cursor=\"true\"             \tShow/Hide the cursor. (Default value: true)\n";
    // std::cout << "\t--cursor-icon=\"cursor.png\"  \tSet the path of the cursor icon. (Default value: \"null\")\n";
    // std::cout << "\t--image-is-sprite=\"false\"   \tSet if the provided image is a spritesheet. (Default value: \"false\")\n";
    // std::cout << "\t--sprite-start-top=\"true\"   \tAnimate by going from top to bottom (or bottom to top). (Default value: \"true\")\n";
    // std::cout << "\t--sprite-start-left=\"true\"  \tAnimate by going from left to right (or right to left). (Default value: \"true\")\n";
    // std::cout << "\t--sprite-width=\"20\"         \tSet the width of the sprite in the animation. (Default value: 20)\n";
    // std::cout << "\t--sprite-height=\"20\"        \tSet the height of the sprite in the animation. (Default value: 20)\n";
    std::cout << std::endl;
}
 
static void displayAuthors()
{
    std::cout << "AUTHORS:\n";
    std::cout << "This program was created for Epitech ";
    std::cout << "project by students of the Epitech school.\n";
    std::cout << "These sets of programs (r-type_client and r-type_server) ";
    std::cout << "were written by:\n";
    std::cout << "\t-\tMarianna Titova              : https://github.com/marianna-titova\n";
    std::cout << "\t-\tTristan Wehrle               : https://github.com/floksdev)\n";
    std::cout << "\t-\tArthur-agusto Claro-sardella : https://github.com/DoctorTangerina)\n";
    std::cout << "\t-\tHenry Letellier              : https://github.com/HenraL\n";
    std::cout << std::endl;
}
 
void DisplayVersion(bool helpMode = false)
{
    if (helpMode) {
        std::cout << "VERSION:\n";
    }
    std::cout << "The program's version is: " << VERSION << std::endl;
}
 
void DisplayHelp(const std::string binName)
{
    displayUsageSummary(binName);
    std::cout << std::endl;
    displayDetailedUsage();
    std::cout << std::endl;
    displayAuthors();
    std::cout << std::endl;
    DisplayVersion(true);
}