colour with contrast; copied caravan instructions off website, need t…

…o sort it...

README

@@ -12,23 +12,38 @@ A command-line version of the Caravan card game from Fallout: New Vegas.
 HOW TO PLAY
 ===========
 
-The game is played in the same way as the original card game, with only a few
-changes and restrictions, as follows.
+BUILDING A DECK
 
-(1) The names of the caravans have been changed to six letters, from A to F,
-where caravans A, B, and C are for one player, and D, E, and F are for the
-other. Caravan A competes against D, B against E, and C against F.
+Caravan decks consist of at least 30 cards from one of more traditional playing card sets. The deck may have any number
+of cards of any type that suits a player's strategy, although it cannot have duplicate cards from the same set. For
+example a K♠ from set A and a K♠ from the set B deck is acceptable, but more than one K♠ from set A would be illegal.
 
-(2) Deck building has been simplified to create fairer games. A caravan deck
-comprises between 30 and 156 cards sampled randomly from between 1 and 3
-standard card decks (52 cards + 2 Jokers). The standard decks are shuffled and
-may be sampled equally (a "balanced sample") or randomly.
+RULES
 
-(3) Each caravan has a limit of 10 numeral cards (i.e. ACE to 10). Each numeral
-card has a limit of 5 face cards (i.e. JACK, QUEEN, KING, and JOKER) that can be
-placed on it.
+Caravan is played with two players building three opposing piles (or "caravans") of numbered cards. The goal is to
+outbid your opponent's caravan with the highest value of numbered cards without being too light (under 21) or
+overburdened (over 26).
 
-(4) Bidding has been removed completely.
+The game begins with each player taking eight cards from their deck and placing either one numerical card or ace on each
+caravan. Players may not discard during this initial round.
+
+Once both players have started their three caravans, each player may do one of the following on their turn: 1. Play one
+card and draw a new card from his or her deck to their hand: 2. Discard one card from their hand and draw a new card
+from his or her deck: or 3. Discard one of their caravans by removing all cards from that pile.
+
+Caravans have a direction, either ascending or descending numerically, and a suit. The suit is determined with the first
+card placed on a caravan, the direction by the second. All subsequent cards must continue the numerical direction or
+match the suit of the previous card. Cards of the same numerical value cannot be played in sequence, regardless of suit.
+Face cards can be attached to numeric cards in any caravan and will affect them in various ways.
+
+CARD VALUES
+
+Joker - Played against Ace, 2-10. Effects change based on whether it is an ace or numbered card (see below). Multiple jokers may be played on the same card.
+Ace - Value of 1. Jokers played on aces remove all other non-face cards of the ace's suit from the table. E.g. a joker played on an A♠ removes all spades (except face cards and that card, specifically) from the table.
+2-10 - Listed value. Jokers played on these remove all other cards of this value from the table. E.g. a joker player on a 4♥ removes all 4s (other than that card, specifically) from the table.
+Jack - Played against Ace, 2-10. Removes that card, along with any face cards attached to it.
+Queen - Played against Ace, 2-10. Reverses the current direction of the hand, changes the current suit of the hand. Multiple queens may be played on the same card.
+King - Played against Ace, 2-10. Adds the value of that card again. E.g. a king played on a 9 adds 9 to that hand. Multiple kings may be played on the same card for multiplicative effects. E.g. 4 + king = 8. 4 + two kings = 16.
 
 
 ========
@@ -47,8 +62,6 @@ of your caravans, or EXIT the game. The commands are not case sensitive.
 Pressing the Enter key will submit your command. If there is a problem with your
 command, a message will appear below the game table to help you.
 
----
-
 To PLAY a numeral card, type 'P', then the number for the card in your hand that
 you want to play, then the caravan name. For example, to PLAY card 2 from your
 hand onto caravan B:
@@ -71,6 +84,4 @@ want to clear. For example, to CLEAR caravan A:
 
 [YOU] > CA
 
-To EXIT the game, simply type:
-
-[YOU] > EXIT
+To EXIT the game, press Escape.

include/caravan/user/user.h

@@ -29,6 +29,4 @@ class UserHuman : public User {
     GameCommand generate_option(Game *g) override;
 };
 
-// TODO BotFriendly: never plays offensive moves on opponent
-
 #endif //CARAVAN_USER_H

src/caravan/view/view_tui.cpp

@@ -3,7 +3,6 @@
 // modified under the terms of the GPL-3.0 License.
 
 #include "caravan/user/user.h"
-#include "caravan/view/view.h"
 #include "caravan/view/view_tui.h"
 
 #include <memory>
@@ -48,10 +47,10 @@ const std::string NAME_BOT2 = "BOT2";
 
 typedef struct ViewConfig {
     // Pointers to users
-    User *user_abc;
-    User *user_def;
-    User *user_turn;
-    User *user_next;
+    User *user_abc{};
+    User *user_def{};
+    User *user_turn{};
+    User *user_next{};
 
     // Messages to users
     std::string msg_notif;
@@ -70,7 +69,7 @@ typedef struct ViewConfig {
     GameCommand command;
 
     // Colour support
-    bool colour;
+    bool colour{};
 } ViewConfig;
 
 
@@ -168,7 +167,7 @@ std::shared_ptr<ftxui::Node> suit_to_text(ViewConfig *vc, Suit suit) {
                 return node_suit;
             case SPADES:
             case CLUBS:
-                return node_suit | color(Color::Palette16::BlueLight);
+                return node_suit | color(Color::Palette16::CyanLight);
             case HEARTS:
             case DIAMONDS:
                 return node_suit | color(Color::Palette16::RedLight);
@@ -183,8 +182,14 @@ std::shared_ptr<ftxui::Node> suit_to_text(ViewConfig *vc, Suit suit) {
 void push_card(ViewConfig *vc, ftxui::Elements *e, Card card, bool lead) {
     using namespace ftxui;
 
-    e->push_back(text(rank_to_wstr(card.rank, lead)));
-    if(card.rank != JOKER) { e->push_back(suit_to_text(vc, card.suit)); }
+    if (card.rank == JOKER) {
+        if(lead) { e->push_back(text(L" ")); }
+        e->push_back(text(rank_to_wstr(card.rank, lead)));
+
+    } else {
+        e->push_back(text(rank_to_wstr(card.rank, lead)));
+        e->push_back(suit_to_text(vc, card.suit));
+    }
 }
 
 void process_first(std::string input, GameCommand *command) {
@@ -387,11 +392,7 @@ GameCommand ViewTUI::parse_user_input(std::string input, bool confirmed) {
     GameCommand command;
 
     if (closed) { return command; }
-
     if (input.empty()) { return command; }
-
-    // TODO A future feature that highlights parts of the board as a command is typed,
-    //  so that the user has a better idea of what their command will do.
     if (!confirmed) { return command; }
 
     /*
@@ -492,8 +493,8 @@ std::shared_ptr<ftxui::Node> gen_caravan_slot_blank() {
 std::shared_ptr<ftxui::Node> gen_caravan(ViewConfig *vc, Game *game, CaravanName cn, bool top) {
     using namespace ftxui;
     std::shared_ptr<Node> content;
-    std::wstring title;
     Elements e;
+    Elements title;
 
     Caravan *caravan = game->get_table()->get_caravan(cn);
     uint8_t caravan_size = caravan->get_size();
@@ -510,21 +511,16 @@ std::shared_ptr<ftxui::Node> gen_caravan(ViewConfig *vc, Game *game, CaravanName
     }
 
     content = vbox(e);
-    title = L" " + caravan_to_wstr(cn, true) + L" ";
 
+    title.push_back(text(L" " + caravan_to_wstr(cn, true) + L" "));
     if (game->get_table()->get_caravan(cn)->get_size() > 0) {
-        title +=
-            L"(" +
-            std::to_wstring(caravan->get_bid()) +
-            L", " +
-            direction_to_wstr(caravan->get_direction()) +
-            L", " +
-            suit_to_wstr(caravan->get_suit()) +
-            L") ";
+        title.push_back(text(L"(" + std::to_wstring(caravan->get_bid()) + L", " + direction_to_wstr(caravan->get_direction()) + L", "));
+        title.push_back(suit_to_text(vc, caravan->get_suit()));
+        title.push_back(text(L") "));
     }
 
     return window(
-        text(title) | hcenter | bold,
+        hbox({title}) | hcenter | bold,
         content
     ) | center | size(WIDTH, EQUAL, WIDTH_CARAVAN) | size(HEIGHT, EQUAL, HEIGHT_CARAVAN);
 }