GameMenu

This is a C++ library to help create Menu UI for games based of sfml. It provides simple and direct pathways to create Menu, add action to it etc.

How to use?

The main purpose of the library is to make creation of menu's in games easy. This achieves it by dividing the Menu into two parts:

• UI - Options to display
• Function - The action to perform

To use the library

• First Need to decide the menu items, ie the options available (eg Start, Exit, Highscore etc)
• Create A vector of gmenu::MenuItem. Which contains the title of the item and Action it will perform.

The definition of gmenu::MenuItem is:

```cpp
   struct MenuItem {
       std::shared_ptr<Action> action;
       std::string title;
   };
```

 Here `gmenu::Action` is an abstract Class that acts as an interface.
 The virtual method `bool DerivedAction::start()` will be called by the Menu when that item is selected.

• Now create a style. gmenu::Style

  • It requires two paramenters ( sf::Font ) to initialize.
  • gmenu::Style can be used to define the look of the menu.

   sf::Font &TitleFont;
   sf::Font &ItemFont;
  
   sf::Color TitleColor = sf::Color::Green;;
   sf::Color ItemColor = sf::Color::Red ;
   sf::Color Selected = sf::Color::Blue; 
  
   unsigned int TitleFontSize = 50;
   unsigned int ItemFontSize = 20;
   
   float MenuItemScaleFactor = 0.25; // This determines the distance between options. 
   
   int layout = Layout::Default; // Bitflag, Defines the layout of menu. eg. Layout::ItemLeft| Layout::TitleCentre
  
   struct {
    signed int top, left;
   } PaddingTitle, PaddingItems; // this is the padding that will extra displacement that will always be added.

• Now create an object of gmenuMenu which require the following parameters:

  • sf::RenderWindow : Where menu is to be created
  • std::vector<gmenu::MenuItem> : Vector containing MenuItems.
  • gmenu::Style: That defines the style.

• Vola, your menu is ready to be used.

Screenshots!

Dependencies

• Simple and Fast Multimedia Library

  • How to install on linux

      $ sudo apt-get install libsfml-dev
    

  • How to install in Windows (visual studio)

    • Download the binaries from sfml
    • Open project settings
    • In c/c++ option
    • Add new include dir as <Path to sfml>/include
    • In linker additional external libraries
    • Add <path to sfml>/lib

Installing

Linux

• Clone/Download source

• Go to Project dir eg:

    $ cd GameMenu
  

• type

    $ make
  

• Now copy the contents of GameMenu/include to your project's include directory.

• Copy lib/libGameMenu.a to your projects lib directory.

• Include the path /path/to/GameMenu/include/ within you project.

• Now you can use the GameMenu by linking bin/libGameMenu.a to your executable.

  eg

    $ g++ your_source.cpp -I./include -o your_output.o
    $ g++ your_output.o -L./lib -lGameMenu -o your_executable
  

Windows (Visual Studio)

• Clone/Download the GameMenu
• Build for the required platform
• Copy the content of GameMenu/include to your folder's include directory.
• Copy the .lib GameMenu.lib to your projects lib directory.
• Add the GameMenu.lib to your linker input files list.
• Build and enjoy.

Contributions

If you are looking to contribute, then feel free to create a pull request.

Future Possibilities

• Mouse integration
• Menu style system. Abiity to alter the menu apearance as per need. (Create a style object with nessary specifications, which will be passed to the Menu)
• Sound.