Dice

C++ Dice Generator

Introduction


Dice is a basic program designed in C++ for educational and extracurricular purposes.

Installation


Migrate to your desired download location on your local machine using your (either) your console or terminal, and download this repository to your system using git clone:

git clone https://github.com/Justin-Byrne/Dice.git

Utilize the Makefile within the Player subdirectory immediately under the root directory, and utilize the following command(s) for the platform that you are using:

Windows

> make win32
> make clean

Linux

# make linux
# make clean

Usage


Usage for this application can be found by using the --help flag, at the prompt:

> Dice --help

Usage:  Dice D[no] [rolls] <[multi]>

        Options:
                --help          Display this help and exit
                --version       Output version information and exit

        Params:
                [no]            Number associated with the type of dice generated
                [rolls]         Amount of rolls that each dice should be rolled
                [multi]         [Optional]: Multiplier to be applied to the value rolled

Presently, there are two primary methods of generating and rolling dice with this program:

  1. The following command will generate a single D6, roll it once, and providing the following output:

# Dice D6 1

 > Results:
        Amount of Dice: 1

 > Generated Dice | [TYPE]: Cube  [SIDES]: 6  [MULTIPLES]: 1  [VALUE]: 3

Total: 3

  1. The following command will generate two D8 die, roll each of them, and provide the following output with a 10 x multiplier:

# Dice D8 2 10

 > Results:
        Amount of Dice: 2

 > Generated Dice | [TYPE]: Octahedron  [SIDES]: 8  [MULTIPLES]: 10  [VALUE]: 4
 > Generated Dice | [TYPE]: Octahedron  [SIDES]: 8  [MULTIPLES]: 10  [VALUE]: 3

Total: 70

Model


Basic Model of classes and interface implementations.


Structure


. (Dice)
│
│
├── Dice
│   │
│   ├──bin
│   │   │
│   │   ├── debug
│   │   └───release
│   │
│   ├── doc
│   │   │
│   │   ├── Doxygen
│   │   │   │
│   │   │   ├── html (API Documentation)
│   │   │   │   │
│   │   │   │   ├── index.html (Index to API HTML Documentation)
│   │   │   │   ├── ...
│   │   │   │   └── search
│   │   │   │       │
│   │   │   │       └── ...
│   │   │   │
│   │   │   ├── latex (LATEX Graphics for Documentation)
│   │   │   │   │
│   │   │   │   └── ...
│   │   │   │
│   │   │   ├── rtf (Rich Text Formatting Reference Material)
│   │   │   │   │
│   │   │   │   ├── refman.rtf (API Reference Manual)
│   │   │   │   └── ...
│   │   │   │
│   │   │   └── Doxygen (Save File)
│   │   │
│   │   ├── editor (Sublime Text Editor Files)
│   │   │   │
│   │   │   ├── Dice.sublime─project
│   │   │   └── Dice.sublime─workspace
│   │   │
│   │   ├── models
│   │   │   │
│   │   │   ├── UML Basic Diagram.svg
│   │   │   ├── UML Detailed Diagram.svg
│   │   │   ├── READEME.md
│   │   │   └── ... (Extra files)
│   │   │
│   │   ├── CHANGELOG.md
│   │   └── LICENSE.txt
│   │
│   ├── include
│   │   ├── DICE.h
│   │   └── MACRO.h
│   │
│   ├── lib
│   │
│   ├── spike
│   │
│   ├── src
│   │   └── DICE.cpp
│   │
│   ├── test
│   │
│   ├── Main.cpp
│   ├── Makefile
│   ├── Dice.vcxproj
│   ├── Dice.vcxproj.filters
│   └── Dice.vcxproj.user
│
├── Dice.sln
└── README.md