Package net.regsirius06.engine.core.executables

Class Help

java.lang.Object
net.regsirius06.engine.utils.help.InfoExecutable
net.regsirius06.engine.core.executables.Help
All Implemented Interfaces:
Executable, Loadable
public class Help extends InfoExecutable
Provides information about the core system of the game engine.

This class extends InfoExecutable and serves as an "About" dialog for the core of the game. It provides details such as authors, version, description, dependencies, and contribution information.

The Help executable is automatically included in the system and ensures that users can always access relevant information about the game engine's core functionalities.

See Also:

  • Constructor Details

    • Help

      public Help()

  • Method Details

    • authors

      protected List<String> authors()
      Returns a list of authors who contributed to the core system.
      Specified by:
      authors in class InfoExecutable
      Returns:
      a list containing the main author "Sirius06"

    • description

      protected String description()
      Provides a description of the core system of the engine.
      Specified by:
      description in class InfoExecutable
      Returns:
      a string describing the purpose and state of the core system

    • version

      protected String version()
      Returns the version of the core system.
      Specified by:
      version in class InfoExecutable
      Returns:
      the version string "beta-1.0.0"

    • dependencies

      protected List<String> dependencies()
      Provides a list of dependencies required by the core system.
      Specified by:
      dependencies in class InfoExecutable
      Returns:
      a list of dependencies, including Java 17 and various libraries

    • contribute

      protected String contribute()
      Returns the URL for contributing to the core system.
      Specified by:
      contribute in class InfoExecutable
      Returns:
      the GitHub repository link for contributions