pvjc22/final/README.md

75 lines
2.6 KiB
Markdown

#Theme Documentation
***
*Theme Name:* Docs
*Author:* Yaroslav Orlianskyi
*Created:* 06/06/2022
***
##
1. Game logics
2. Gameplay
3. Interface and How to play?
***
##1. Game logics
The code consists of 3 functions:
* In world.c :
void game_field(const int rows, const int columns, char field[rows][columns]);
/**
* Function draw game field
* @param rows count of rows
* @param columns count of columns
* @param field hold 2d array of characters in game
*/
bool check(const int rows, const int columns, char field[rows][columns]);
/**
* Check fields rows if there are same characters
* @param rows count of rows
* @param columns count of columns
* @param field hold 2d array of characters in game
* @return true, if columns are complete; false otherwise
*/
void down_possible(const int rows, const int columns, char field[rows][columns], int x, int y);
/**
* Function returns 2D array after moving characters based on player input
* When characters are not same, nothing happens and warning appears
* Function also find the most upper character and the lower character from columns
* @param rows count of rows
* @param columns count of columns
* @param field hold 2d array of characters in game
* @param x is column from where character should be moved
* @param y is column where character should be moved
*/
void generator(const int rows, const int columns, char field[rows][columns]);
/**
* Function returns 2D array of randomly generated characters
* There must be two blank columns and other should be full of characters without '\0' or blank spaces
* @param rows count of rows
* @param columns count of columns
* @param field hold 2d array of characters in game
*/
void ball_sort_puzzle();
/**
* Starts interactive ball sort puzzle game
*/
##2. Gameplay
You need to sort the balls in the tubes until all the balls with the same type remain in the same tube.The type ball sort gameplay is simple and fun, allowing you to enjoy the sort it game while feeling unlimited fun.
***
##3. Interface and How to play?
The game has a simple interface, after you write ./game in the console, the game will start and you will see the game interface where you have four lines and six pipes, after which you will ask something like "How to play?" and the answer to this question is quite simple, you need to press the number from one to six, which will mean the pipe with which you want to move the ball, but the game takes the topmost ball and this must be taken into account, after that you again need to press the number from one to six what will mean the pipe in which you want to put this ball
***