diff --git a/doc/doxygen-extra-pages/user_documentation/deck_management/creating_decks.md b/doc/doxygen-extra-pages/user_documentation/deck_management/creating_decks.md index 0de587b64..bfe578afd 100644 --- a/doc/doxygen-extra-pages/user_documentation/deck_management/creating_decks.md +++ b/doc/doxygen-extra-pages/user_documentation/deck_management/creating_decks.md @@ -1,6 +1,6 @@ @page creating_decks Creating Decks -Creating a new deck is done using either the TabDeckEditor or TabDeckEditorVisual. +Creating a new deck is done using either the \ref editing_decks_classic or \ref editing_decks_visual. They can be accessed either by clicking the "Create Deck" button in the TabHome screen, which will open the default deck editor configured in the "User Interface" -> "Deck editor/storage settings" -> "Default deck editor type" setting, or diff --git a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_visual.md b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_visual.md index adef7335f..e7d503735 100644 --- a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_visual.md +++ b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_visual.md @@ -1,5 +1,7 @@ @page editing_decks_visual Visual Deck Editor +\image html vde_overlap_layout_type_grouped.png width=1200px + # Editing Basic Deck Information Editing basic deck information is done through the deck dock widget (DeckEditorDeckDockWidget). @@ -24,6 +26,8 @@ See @ref visual_database_display for more information on how to utilize the visu To modify or remove cards in the deck list, the tree list view in the deck dock widget can be used. +\image html deck_dock_deck_list.png + Just above the list, at the top right, there are four buttons to manipulate the currently selected card(s): - Increment Card @@ -31,9 +35,13 @@ Just above the list, at the top right, there are four buttons to manipulate the - Remove Card - Switch Card between Mainboard and Sideboard +\image html deck_dock_deck_list_buttons.png + Additionally, there is a combo box above the list, which may be used to change how cards are grouped in the list display. This is only for visual display and does not affect how the list is saved. +\image html deck_dock_deck_list_group_by.png + # Modifying the visual deck layout The visual deck editor displays cards visually, as opposed to simply in list form in the Deck Dock Widget. Each entry in @@ -41,14 +49,24 @@ the deck list is represented by a picture. These entries are grouped together un Sub-groups may be collapsed (i.e. the pictures contained within them are hidden) by clicking on the name of the group in the banner. -Cards may either be displayed in a "Flat" layout, which displays each picture next to each other and ensures full -visibility for each card, or in an "Overlap" layout, which overlaps cards on top of each other (leaving the top 20% of +Cards may be displayed in a "Flat" layout, which displays each picture next to each other and ensures full +visibility for each card. + +\image html vde_flat_layout_type_grouped.png width=1200px + +or in an "Overlap" layout, which overlaps cards on top of each other (leaving the top 20% of the card uncovered so names remain readable) and arranges them in stacks to save space and allow for an easy overview. +\image html vde_overlap_layout_type_grouped.png width=1200px + Additionally, it is possible to change how the cards in the deck list are grouped by selecting a different grouping method from the combo box, either in the top left of the "Visual Deck View" tab or above the list view in the deck dock widget. +Example - Cards grouped by suit/color: + +\image html vde_flat_layout_color_grouped.png width=1200px + Furthermore, it is possible to change how the cards are sorted within the sub-group. This is done by clicking on the button with the cogwheel icon next to the combo box that adjusts grouping in the top left of the "Visual Deck View" tab. This presents a list of available sort criteria, which may be rearranged to change their priorities. @@ -65,7 +83,11 @@ The visual deck editor offers a "Deck Analytics" tab, which displays information - The mana devotion - The mana base +\image html vde_deck_analytics.png width=1200px + # Sample Hand The visual deck editor offers a "Sample Hand" tab, which allows simulating drawing a configurable amount of cards from -the deck, which reduces the need to launch a single player game for testing purposes. \ No newline at end of file +the deck, which reduces the need to launch a single player game for testing purposes. + +\image html vde_sample_hand.png width=1200px \ No newline at end of file diff --git a/doc/doxygen-extra-pages/user_documentation/deck_management/exporting_decks.md b/doc/doxygen-extra-pages/user_documentation/deck_management/exporting_decks.md index 644336681..607ba3360 100644 --- a/doc/doxygen-extra-pages/user_documentation/deck_management/exporting_decks.md +++ b/doc/doxygen-extra-pages/user_documentation/deck_management/exporting_decks.md @@ -63,25 +63,81 @@ newline delimited and annotated group. Example: TODO: Adjust this to be non mtg based. ``` -// Deck Name +// Full Deck -// Deck Comment +// An example comment. -// 10 Maindeck -// 6 Artifact -2 The Darkness Crystal (FIN) 335 -2 The Fire Crystal (FIN) 337 -2 Black Mage's Rod (FIN) 90 +// 63 Maindeck +// 4 Ace +1 Ace of Clubs (PKR) 49 +1 Ace of Diamonds (PKR) 50 +1 Ace of Hearts (PKR) 51 +1 Ace of Spades (PKR) 52 -// 6 Sorcery -2 Nibelheim Aflame (FIN) 339 -4 Cornered by Black Mages (FIN) 93 +// 13 Face +1 Jack of Clubs (PKR) 53 +1 Jack of Diamonds (PKR) 54 +1 Jack of Hearts (PKR) 55 +1 Jack of Spades (PKR) 56 +1 King of Clubs (PKR) 57 +1 King of Diamonds (PKR) 58 +1 King of Spades (PKR) 60 +1 Queen of Clubs (PKR) 61 +1 Queen of Diamonds (PKR) 62 +1 Queen of Hearts (PKR) 63 +1 Queen of Spades (PKR) 64 +2 King of Hearts (PKR) 59 -// 6 Sideboard -// 6 Creature -SB: 4 Blazing Bomb (FIN) 130 -SB: 1 Garland, Knight of Cornelia (FIN) 221 -SB: 1 Undercity Dire Rat (FIN) 123 +// 44 Number +1 0 of Clubs (PKR) 1 +1 0 of Diamonds (PKR) 2 +1 0 of Hearts (PKR) 3 +1 1 of Clubs (PKR) 11 +1 1 of Diamonds (PKR) 12 +1 1 of Hearts (PKR) 13 +1 1 of Spades (PKR) 14 +1 10 of Clubs (PKR) 5 +1 10 of Diamonds (PKR) 6 +1 10 of Hearts (PKR) 7 +1 2 of Clubs (PKR) 17 +1 2 of Diamonds (PKR) 18 +1 2 of Hearts (PKR) 19 +1 2 of Spades (PKR) 20 +1 3 of Clubs (PKR) 21 +1 3 of Diamonds (PKR) 22 +1 3 of Hearts (PKR) 23 +1 3 of Spades (PKR) 24 +1 4 of Clubs (PKR) 25 +1 4 of Diamonds (PKR) 26 +1 4 of Hearts (PKR) 27 +1 4 of Spades (PKR) 28 +1 5 of Clubs (PKR) 29 +1 5 of Diamonds (PKR) 30 +1 5 of Hearts (PKR) 31 +1 5 of Spades (PKR) 32 +1 6 of Clubs (PKR) 33 +1 6 of Diamonds (PKR) 34 +1 6 of Hearts (PKR) 35 +1 6 of Spades (PKR) 36 +1 7 of Clubs (PKR) 37 +1 7 of Diamonds (PKR) 38 +1 7 of Hearts (PKR) 39 +1 7 of Spades (PKR) 40 +1 8 of Clubs (PKR) 41 +1 8 of Diamonds (PKR) 42 +1 8 of Hearts (PKR) 43 +1 8 of Spades (PKR) 44 +1 9 of Clubs (PKR) 45 +1 9 of Diamonds (PKR) 46 +1 9 of Hearts (PKR) 47 +1 9 of Spades (PKR) 48 +1 10 of Spades (PKR) 8 +1 0 of Spades (PKR) 4 + + +// 2 Joker +1 1 Joker (PKR) 10 +1 2 Joker (PKR) 16 ``` ## From an online service diff --git a/doc/doxygen-images/classic_database_display.png b/doc/doxygen-images/classic_database_display.png index 1f4773514..fb762d9a3 100644 Binary files a/doc/doxygen-images/classic_database_display.png and b/doc/doxygen-images/classic_database_display.png differ diff --git a/doc/doxygen-images/classic_deck_editor.png b/doc/doxygen-images/classic_deck_editor.png index 2e41b6e1d..9371651e9 100644 Binary files a/doc/doxygen-images/classic_deck_editor.png and b/doc/doxygen-images/classic_deck_editor.png differ diff --git a/doc/doxygen-images/deck_dock_deck_list.png b/doc/doxygen-images/deck_dock_deck_list.png index d01a5334e..bf12d97c2 100644 Binary files a/doc/doxygen-images/deck_dock_deck_list.png and b/doc/doxygen-images/deck_dock_deck_list.png differ diff --git a/doc/doxygen-images/deckeditordeckdockwidget.png b/doc/doxygen-images/deckeditordeckdockwidget.png index d71720db7..33b9588d0 100644 Binary files a/doc/doxygen-images/deckeditordeckdockwidget.png and b/doc/doxygen-images/deckeditordeckdockwidget.png differ diff --git a/doc/doxygen-images/vde_deck_analytics.png b/doc/doxygen-images/vde_deck_analytics.png new file mode 100644 index 000000000..0b4b11e19 Binary files /dev/null and b/doc/doxygen-images/vde_deck_analytics.png differ diff --git a/doc/doxygen-images/vde_flat_layout_color_grouped.png b/doc/doxygen-images/vde_flat_layout_color_grouped.png new file mode 100644 index 000000000..51f176668 Binary files /dev/null and b/doc/doxygen-images/vde_flat_layout_color_grouped.png differ diff --git a/doc/doxygen-images/vde_flat_layout_type_grouped.png b/doc/doxygen-images/vde_flat_layout_type_grouped.png new file mode 100644 index 000000000..4a33e0017 Binary files /dev/null and b/doc/doxygen-images/vde_flat_layout_type_grouped.png differ diff --git a/doc/doxygen-images/vde_overlap_layout_type_grouped.png b/doc/doxygen-images/vde_overlap_layout_type_grouped.png new file mode 100644 index 000000000..606144586 Binary files /dev/null and b/doc/doxygen-images/vde_overlap_layout_type_grouped.png differ diff --git a/doc/doxygen-images/vde_sample_hand.png b/doc/doxygen-images/vde_sample_hand.png new file mode 100644 index 000000000..95924a5d4 Binary files /dev/null and b/doc/doxygen-images/vde_sample_hand.png differ