.. Dice Game documentation master file, created by
   sphinx-quickstart on Fri Dec  5 22:45:55 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _user-document:

User Documentation
===================

.. image:: /images/dice.jpg

============
Introduction
============

Welcome to Snakes and Ladders Dice Game user documentation. In the following section you will find the explaination of the features you can expect in this game and rules what will be strictly followed while you are playing. 

========
Features
========

Snakes and Ladders is an ancient south asian board game. Which consists 10 X 10 scored grided board and some snakes and ladders spotted on board. 100 is the maximum and winning score. Once any player get to that score, immediately declared as winner. 

Following are the features available in this game 

* Dice Board 
	Disply game update with spotted players score, snakes and ladders
* Snakes
	Very important and exciting features in this dice game
* Ladders 
	Most fun features in dice game

============
How It Works
============
	* **Step 1:** Register all players whoever wants to in current session.
	* **Step 2:** As soon as registration is done you will see all the players information and a 10 X 10 board displayed on your screen.
	* **Step 3:** First player will throw the dice, if score is 1 then score accumulatoin will start for this player otherwise score accumulation will not start and next player will throw the dice. if this player score 1 
	* **Step 4:** Check for winner (whether current player scored 100 or not)
	* **Step 5:** if winner not found it's next player turn (will repeat step 3 and 4)
	* **Step 6:** if winner found game is over and current session players information will be saved in archive

==========
Flow Chart
==========
Following is the flow chart of the game.

.. image:: /images/flow.png

==============================
Play the Game in your computer
==============================

Please go to program's root folder and follow the instructons below...

* Make sure you installed termcolor for actual visual effect.

.. code:: bash

	sudo pip install termcolor

* Run the following command where you can mention n numbers of players name who can participate 

.. code:: bash

	python dicegame.py player_name1 player_name2

* You will see the first screen and hit ENTER if it's your turn


* Once you first player hit enter dice board will be displayed as follows

.. image:: /images/board.png

here at the top we are displaying available snakes and ladder in the game and accordingly s and l on board represent snakes and ladder.


* Continue doing this. Once any player reach 100 will be declared as winter and the game is over.

.. image:: /images/winner_screen.png