adi-g15 / ludo-the_game

An implementation of the famous board game Ludo, using C++

The repo now has a web version too, added by @Athi223, and is available in web/ directory, and deployed at https://ludo-the-game-a10a0.web.app/ 🎉

Ludo - The Game v2.0

Ludo, our popular Indian board game, completely implemented in C++

Ask any doubts in the #Discussions :D

Features

• Easy and Powerful customisability (More in developer notes)
• Variable number of inputs at all input fields
• Shortcuts, Keywords, Cheat codes
• Two robot modes -
  • RandomRobo
  • ThinkerRobo (it will chose the best possible move at a time, from almost 30-90 possibilities)
• Display adaptive to width of screen
• Memory-safe (using smart_pointers, and uncounted for 'new' statements)
• Multi-threaded (for ThinkerRobo execution)
• 0 dependencies outside stdc++ (for coloured output support, agauniyal.github.io/rang/ is utilised and included as a header rang.hpp)
• Plus all basic ludo game features, and my own custom keywords (you can create yours too :D )

Building

On Linux & Windows -

mkdir build -p
cd build
cmake ..
cmake --build .

After building you will have a ludo.exe inside build/ (Linux) or build/{Debug,Release} (Windows), that's your executable 😃

Installation

On Arch, simply run 'makepkg -si', the PKGBUILD file will handle rest

After #Building, run cmake --install .

Files in the Project

.
├── extras
├── util    # utility library
├── includes
│   ├── boardPrinter.hpp			# showing ludo board
│   ├── rang.hpp					# for colored output
│   ├── die.hpp						# die; functions for die roll
│   ├── enums.hpp					# enums; (coord,colour,Player etc.)
|   ├── exceptions.hpp				# errors
|   ├── game.hpp					# **[MAIN]** The Game class (and all functions)
|   ├── keywords.hpp				# constants
|   ├── ludo_box.hpp				# :)
|   ├── ludo_coords.hpp				# Stores corners and home locations (coordinates, not fixed)
|   ├── ludo_goti.hpp				# :)
|   ├── ludo_state.hpp				# For robots, a lightweight class to store 'state'
│   └── thinker.hpp					# For robots, thinker class, provides logic for robots
├── src
|   ├── game.cpp
|   ├── ludo_box.cpp
|   ├── ludo_coords.cpp
|   ├── ludo_goti.cpp
|   ├── ludo_state.cpp
|   ├── thinker.cpp
├── main.cpp
├── CMakeLists.txt
├── LICENSE.md
└── README.md

READING THE CODE

You DON'T need to understand 'all' code to understand this program

Discussion: If you can't understand something, simply ask that in 'Discussion' section, let's grow together !, we will reply :D

1. Even though, the codebase may seem big, or confusing, you should see the "name of the functions" that gets called inside these, in this order -

   • main.cpp
   • board.cpp::Init_Game()
   • board.cpp::play()

2. I think only seeing the names of functions calls in these, you would get the workflow of this(the functions have been named such)... then if you want, see the includes directory first, and for how the function is implemented, see src.

3. //! or /**/ -> This syntax for comments has been used for giving info of the code.

The whole structure of the code is such that most things can be easily changed, to be able to show effect elsewehere too, some of which for eg.

• To change Order of Gameplay, you only need to change one vector, ie. colourOrder<>

• Different Players can be bound to different gotis, as you want, just update the colourMap and playerMap

• To change Number of Gotis, just update the goti_per_user, and internally it just got implemented! No fuss

• And, for display on output : In the updateDisplay(), may use if conditions to add an additional type2() row, for each +2 gotis of goti_per_user

• In most apps, even if you get a 6, you have to decide your move then, but at our gaon, we could proceed to roll the die, till its not 6, YOU can opt any of those ways, for that, replace dieNumbers<> to a single integer!

• Many more if when you search (yaar please consider point 1, if that's the case :-)

Contribution -

Start an issue for whatever feature you believe should be good here.

And, in case you want to be a contributer here, and work on it together, do ask.

Do sugggest any other feature you would like, i do claim the codebase to be quite modular, and easily customisable (It was what i used to think earlier, it IS modular enough to understand, i am not modifying it now, so as to keep it more original when i made it).

Thanks ! || धन्यवाद् 🙏

ludo-the_game's Issues

-actions

https://github.com/AdityaGupta150/Ludo-The_Game/blob/c2d83e865eae57642dcdfd84c62ac953a5501baa/.github/workflows/main.yml#L1-L6

---

This issue was generated by todo based on a todo comment in c2d83e8. It's been assigned to @AdityaGupta150 because they committed the code.

[Angular] Design a Ludo Board

This is #13 , but you can approach it with Angular(>=8)

Design a responsive webpage for a Ludo Board.

• These issues are meant for beginners 😄

You can start with this ->

===============================================================================
                                LUDO - THE GAME
===============================================================================
                                                           |
                                                           |
                                                           |
                                                           |    --scoreboard--
                                                           |
                    --Board inside--                       |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
-------------------------------------------------------------------------------
                                                           
                                --log area--                                                                                   

Approaching Goti removes already existing opponent goti, even at Safe Spots

In this case, originally there was a blue at the starting point in blue, then the Red goti moved a distance of 4 units, reaching the same spot, and the blue goti went back in locked positions.

Though safe spot logic works for other cases, this is a condition were it is unexpected behaviour, happened twice in the gameplay.

Expected Behaviour:
When the final position has a goti, THEN before attacking & removing, first check if it is one of the safe spots on the board, if it is, then just add this goti to list of gotis on the final box, if not then proceed to attack.

[email protected]

https://github.com/AdityaGupta150/Ludo-The_Game/blob/c2d83e865eae57642dcdfd84c62ac953a5501baa/.github/workflows/main.yml#L2-L7

---

This issue was generated by todo based on a todo comment in c2d83e8. It's been assigned to @AdityaGupta150 because they committed the code.

Case of three consecutive 6 in dice throw

In this case, what happens is since each dice throw result is one by one, so it doesn't know what were the previous outputs, so each 6 is treated differently.

Expected Behaviour: In case of 3 consecutive sixes, the moves should not be considered, ignore/roll back the moves (for a single colour only)

Follow practises for Better Code Quality

Though the repo maintains great standards according to automated review systems, but since there is always a scope to be better... codefactor.io gives a C rating to the repo, due to the complexity of code at particular files, so that is a great way to improve the code, as well as know what practises are recommended and what not, since as you go solving even a few suggestions from there, you will gain a lot 👍🏽 .

Follow the suggestions from these review sites-
CodeFactor
Codacy

"

https://github.com/AdityaGupta150/Ludo-The_Game/blob/566247e193504b647ee2d32e0828121eaca5bd9d/.github/config.yaml#L2-L3

---

This issue was generated by todo based on a TODO comment in 566247e. It's been assigned to @AdityaGupta150 because they committed the code.

Help me

I want create ludo game with c++, I don't know how to start!! Could anyone help me please!!

Possible dereference of an invalid iterator: left_iter

Codacy detected an issue:

Message: Possible dereference of an invalid iterator: left_iter

Occurred on:

• Commit: 4a057a4
• File: includes/utilities.hpp
• LineNum: 143
• Code: while( *left_iter != toRemove && left_iter != str_out.end() ) ++left_iter;

Currently on:

• Commit: 0e1668d
• File: includes/utilities.hpp
• LineNum: 143

Extra Move after a Goti finishes

Notice the Green Goti, about to finish

Earlier:

After moving 1 unit (So, ek goti pung gayi, ie. one goti finished it's path):

Expected Behaviour:
One additional move (if not yet finished all 4) to the player/colour whose goti finishes.

[BUG] Correcting occurences of Direction::Left and Direction::Right in code

This is a note to myself, though if you like, you can work on it.

Describe the bug
In ludo_coords.cpp, occurences of Left and Right directions are to be exchanged, and so the affected code, using the ludo_coords class too, this can get dirty though.

To Reproduce
Nothing to reproduce, Code works fine, the problem is only at readable level, this problem, occured due to renaming the directions

Replace unsuitable occurences of const std::string& with std::string_view

It's as simple to just to replace all const std::string& with std::string_view, but chose the suitable ones.

You may read briefly about std::string_view here -> https://riptutorial.com/cplusplus/example/6571/using-the-std--string-view-class

Further Description, more technical
There are 19 occurences of const std::string& and 4 of const std::string &, but it some functions we just need the internal character array, like in trim_copy and other _copy functions.
Also, some functions that are more likely to be called like - foo("hi long string"), you don't need to bother yourself with that much though.

[HTML] Design a Ludo board

Design a responsive webpage for a Ludo Board, being displayed.
It will be used for the web version of this project, you should give it a good go, and it's fairly simple, and will be some code you can actually work on 😄 .

You can start with this ->

===============================================================================
                                LUDO - THE GAME
===============================================================================
                                                           |
                                                           |
                                                           |
                                                           |    --scoreboard--
                                                           |
                    --Board inside--                       |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
-------------------------------------------------------------------------------
                                                           
                                --log area--                                                                                   

Fix 'Very Complex Method' issue in web\src\Board.js

CodeFactor found an issue: Very Complex Method

It's currently on:
web\src\Board.js:4-9

[ReactJS] Design a Ludo board

This is #13 , but you can approach it with ReactJS, which i will likely use in the web version, and you can be the prime contributor for that 😄

Design a responsive webpage for a Ludo Board, that will be utilized for this project's web version.

You can start with this ->

===============================================================================
                                LUDO - THE GAME
===============================================================================
                                                           |
                                                           |
                                                           |
                                                           |    --scoreboard--
                                                           |
                    --Board inside--                       |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
                                                           |
-------------------------------------------------------------------------------
                                                           
                                --log area--