USTLord

README.md

@@ -1,2 +1,206 @@
-# COMP2012H_Project
-UST Landlord Game
+# USTlandlord Game
+
+By COMP2012H 2020FALL Group21, ZHENG Hantao, SU Hong, LU Weiqi, GUO Bingcan
+
+### 0. Installation
+Windows version of this game is in [COMP-2012H repository](https://github.com/williamlus/COMP-2012H). Download that repository and double click [start.exe](https://github.com/williamlus/COMP-2012H/blob/main/start.exe) to start the game.
+
+![USTlord 2022_11_5 19_42_51](https://user-images.githubusercontent.com/67042315/200118232-d7e20a93-01f5-4643-b3e9-708ccf1ea124.png)
+
+### 1. Introduction
+
+Dou dizhu is described as easy to learn but hard to master, requiring mathematical and strategic thinking as well as carefully planned execution. Suits are irrelevant in playing doudizhu. Players can easily play the game with a set of dou dizhu playing cards, without the suits printed on the cards. Less popular variations of the game do exist in China, such as four-player and five-player dou dizhu played with two packs of cards. 
+
+Making a Qt GUIbased game has moderate difficulty and can be expanded with many other features such as multi-player, background music and even a chat box for players to communicate with their teammates and opponents, while the project is relatively s itable to apply beginner’slevel OOP to achieve.
+
+### 2. Overview
+
+Apply OOP to develop a landlord game with GUI based on QT with followingfeatures:
+
+1. A computer “AI” player written based on simple game logic as human
+
+2. Multip-player mode, which is the most important part of the game.
+
+3. Background music and fancy GUI.
+
+
+
+**Basic Rules and Strateges**
+
+1.**A player can deal with an unrelated or useless card by making it the kicker card.**
+
+2.**Rocket and bomb are the ultimate weapons in the game.** 
+
+If they either is in one's hand, one should make full use of it when time comes. If players do not possess high confidence in winning, they may think twice about dealing a rocket or bomb, because once the dealt, the risk stake of the round will be doubled (players will either win or lose double) with each rocket or bomb dealt.
+
+3.**Peasants must co-operate to fight against the landlord.**
+
+For example, since the two peasants come after one another, the first peasant might play a low single card if the second peasant has a sole card left.    
+(Reference: https://en.wikipedia.org/wiki/Dou_dizhu#Rules)
+
+
+
+
+### 3. Design
+
+* **Class Design**
+
+  Console Game：
+
+  * Board
+  * Cards
+  * CardsGroup
+  * CardsType
+  * CurrentPattern
+  * Deck 
+  * Player
+
+  Networking：
+
+  * Datapackage
+  * ServerWindow
+
+  GUI：
+
+  * playerwindow
+  * mainwindow
+  * serverwindow
+  * clientwindow
+
+
+
+* **AI Player Design**
+
+  AI Logic：  
+
+  `const CardsGroup choose_hint(const CurrentPattern& cp);`
+
+    * AI player with some common sense strategies:
+
+    * if the AI player is the first one to play or the CurrentPattern is played by himself
+      he will play cards with the following logic:
+
+      First find the smallest card in hand,
+      if it is inside a bomb, then DO NOT play it, and find the second smallest one unless he only has one card left
+      if not, then if this card is inside any other cards_combination, then just play this combination
+      otherwise just play this SINGLE card
+
+    * if the AI player is landlord, then try to beat everyone
+
+    * if the AI player is farmer, then beat landlord all the time
+
+    * if the CurrentPattern is played by another farmer
+      Only give cards in these cases:
+
+      * the AI player can directly win the game
+      * the partner played a small SINGLE or PAIR     
+
+
+
+  `bool want_landlord() override;//choose to be landlord or not automatically`
+
+
+    * the probability of choosing lord is determined by how good the cards in hand are
+
+      The evaluation is basically determined by the number of cards_combination
+
+      The cards_combination considered here are:
+
+      TRIO,BOMB, ROCKET
+
+
+* **UI Design**
+
+1. Distribute cards effect.
+2. Show buttons according to game process.
+3. Info bar displays game process to players.
+4. Play cards effect and view other players' cards.
+5. Serverwindow and Clientwindow design.
+
+
+
+* **Networking Design**
+
+**Transfer principle:** 
+      Using Transmission Control Protocol (TCP)\
+      The one created room will simultaneously be SERVER and CLIENT, the rest two are just CLIENT\
+      Before sending and after receiving the raw_data, the information is stored in user_defined object: **Datapackage**\
+      For more details of the usages of DataPackage, please refer to `DataPackage.h`
+
+
+        class DataPackage
+              {
+              public:
+                  enum Action{
+                                  NONE=-1,
+                                  GIVE_ID,
+                                  CONFIRM_READY,
+                                  DEAL_CARDS,
+                                  CHOOSE_LANDLORD,
+                                  LANDLORD_BONUS,
+                                  PLAY_CARDS,
+                                  ANNOUNCE,
+                                  CHAT,
+                                  EXCEPTION
+                                 };
+
+        struct Content{
+                      static const QString REQUEST;
+                      static const QString ACCEPT;
+                      static const QString REJECT;
+                      static const QString BE_LANDLORD;
+                      static const QString DO_NOT_PLAY;
+                      static const QString WIN_GAME;
+                      static const QString LOSE_GAME;
+                      static const QString END_GAME;
+                      static const QString QUIT;
+                  };
+
+        public:
+
+                  int sender;
+                  int actioner;
+                  Action action;
+                  QString content;
+
+        };
+
+
+**DataPackage** is equivalent to a formatted QString: "sender:`(int) sender_id`;actioner:`(int) actioner_id`;Action;Content"
+
+Before sending  **DataPackage**, we will first convert it to the formatted QString, then serialize it to QByteArray
+
+After receiving **raw_data(QByteArray)**, we will first convert it to QString, then convert it to DataPackage
+
+
+
+### 4. UI Display
+
+Main window
+
+Single Player game:
+
+* Choose landlord：
+* Player cards:
+* View hints:
+* Game over:
+
+Multiplayer Player game:
+
+
+
+### 5. Summary
+
+  **This project design is a comprehensive OOP program design. The development of USTlord game involves object-oriented programming, data structure, TCP networking and GUI design. We encounted and overcame quite a lot problems due to lack of knowledge and communication problems of multi-person collaboration. The experience we gain are as follows:**
+
+- Deenpen the understanding of object-oriented programming
+
+Different from process-oriented program，object-oriented programming involves class, object, inheritance, polymorphism etc., which greatly enhance the resuability of the codes, and also provide convinience for deleveloping projects in team.
+
+- Modern development concept
+
+In a program involving multiple modules, the more modern development method is encapsulation. After determining the structure of the program, encapsulate the different modules. On the one hand, it is easy to combine and use the modules. On the other hand, the clear interfaces are also the cornerstone of efficient cooperation.
+
+- Development tools and multi-person collaboration
+
+Modern program development is not alone. Multi-person remote collaboration and project management are very important parts of program specification development. The use of Git for version control and project management in this program design has brought great convenience to the development of the program, and also allowed us to deepen our understanding of the actual software engineering process.

USTlord_final/USTlord_final.pro → USTlord_final/USTlord_final2.pro

@@ -1,4 +1,4 @@
-QT       += core gui network
+QT       += core gui network multimedia
 
 greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
 
@@ -22,7 +22,8 @@ SOURCES += \
     source/CurrentPattern.cpp \
     source/Deck.cpp \
     source/Player.cpp \
-    source/DataPackage.cpp
+    source/datapackage.cpp\
+    source/CardPicture.cpp
 
 HEADERS += \
     clientwindow.h \
@@ -37,7 +38,8 @@ HEADERS += \
     source/CurrentPattern.h \
     source/Deck.h \
     source/Player.h \
-    source/DataPackage.h
+    source/datapackage.h\
+    source/CardPicture.h
 
 FORMS += \
     clientwindow.ui \
@@ -49,3 +51,7 @@ FORMS += \
 qnx: target.path = /tmp/$${TARGET}/bin
 else: unix:!android: target.path = /opt/$${TARGET}/bin
 !isEmpty(target.path): INSTALLS += target
+
+RESOURCES += \
+    img.qrc \
+    music.qrc

USTlord_final/clientwindow.cpp

@@ -1,5 +1,6 @@
 #include "clientwindow.h"
 #include "ui_clientwindow.h"
+#include <QMessageBox>
 
 ClientWindow::ClientWindow(QWidget *parent) :
     QMainWindow(parent),
@@ -8,36 +9,101 @@ ClientWindow::ClientWindow(QWidget *parent) :
     ui->setupUi(this);
 }
 
+void ClientWindow::closeEvent(QCloseEvent *event){
+    if(socket){
+        socket->close();
+        socket->deleteLater();
+        qDebug() << "Closing socket";
+    }
+    this->parentWidget()->show();
+    emit close_window();
+    event->accept();
+}
+
 ClientWindow::~ClientWindow()
 {
     delete ui;
 }
 
 void ClientWindow::handleStateChanged(QAbstractSocket::SocketState state)
 {
-
+    if(state==QAbstractSocket::SocketState::UnconnectedState){
+        if(play_window){
+            play_window->close();
+        }
+        socket->close();
+        ui->listWidget_dialogs->addItem("Disconnected from server");
+        ui->listWidget_dialogs->addItem("Closing the socket");
+    }
 }
 
 void ClientWindow::handle_server_message()
 {
+    ui->listWidget_dialogs->addItem("Handle server msg");
     if(socket){
         QByteArray arr=socket->readAll();
         ui->listWidget_dialogs->addItem(QString::fromStdString(arr.toStdString()));
         DataPackage data=DataPackage::parse(arr);
+        ui->listWidget_dialogs->addItem("Received from server:"+data.to_string());
+//        qDebug()<< "data.action==DataPackage::Action::GIVE_ID?";/////
+//        qDebug() << (data.action==DataPackage::Action::GIVE_ID);//////////
         if(data.action==DataPackage::Action::GIVE_ID){
+            QMessageBox::information(this,"Start","Let's start!",QMessageBox::Ok,QMessageBox::Ok);
             id=data.content.toInt();
-        }
-        if(play_window){
-            play_window->receive_from_client(DataPackage::parse(arr));
+            ui->listWidget_dialogs->addItem("data.conent="+data.content);///////
+            DataPackage data_to_send(id,id,DataPackage::GIVE_ID,ui->lineEdit_name->text()+"#"+QString::number(id));
+            send_to_server(data_to_send);
+        }////////
+        else if(data.action==DataPackage::Action::CONFIRM_READY){
+            QStringList names=data.content.split(QLatin1Char(','),Qt::SkipEmptyParts);
+            QVector<QString> names_vec{};
+            for(int i=0;i<names.size();i++){
+                names_vec.push_back(names[i]);
+                qDebug() << names_vec[i];
+            }
+            play_window=new PlayWindow(id,names_vec,this);
+            connect(play_window,&PlayWindow::send_to_client,this,&ClientWindow::received_from_playwindow);
+            connect(play_window,&PlayWindow::close_window,[=](){
+                play_window=nullptr;
+                send_to_server(DataPackage(id,id,DataPackage::EXCEPTION,DataPackage::Content::QUIT));
+                ui->listWidget_dialogs->addItem("You exit the room");
+                disconnect(play_window,&PlayWindow::send_to_client,this,&ClientWindow::received_from_playwindow);
+                qDebug() << "exit the room";
+            });
+            play_window->show();/////////
+//            this->hide();
+            DataPackage data_to_send(id,-1,DataPackage::Action::CONFIRM_READY,DataPackage::Content::ACCEPT);
+            send_to_server(data_to_send);
+        }/////////
+        else if(play_window){
+            ui->listWidget_dialogs->addItem("send msg to playwindow"+data.to_string());/////////////
+            play_window->receive_from_client(data);
         }
     }
 }
 
 void ClientWindow::send_to_server(DataPackage data){
-
+    ui->listWidget_dialogs->addItem("Send to server"+data.to_string());//////
+    qDebug() << "Send to server"+data.to_string();
+    if(socket){
+        QByteArray arr=data.serialize();
+        socket->write(arr);
+    }
 }
 void ClientWindow::received_from_playwindow(DataPackage data){
+    if(socket){
+        this->send_to_server(data);
+    }
+}
 
+void ClientWindow::set_port(QString port)
+{
+    ui->lineEdit_server_port->setText(port);
+}
+
+void ClientWindow::set_serverIP(QString ip)
+{
+    ui->lineEdit_serverIP->setText(ip);
 }
 
 void ClientWindow::on_pushButton_join_server_clicked()
@@ -62,5 +128,5 @@ void ClientWindow::on_pushButton_stop_joining_clicked()
 
 void ClientWindow::on_pushButton_quit_clicked()
 {
-
+    this->close();
 }