From ae4259396859d79fb09e4e30877cb7ae8623b249 Mon Sep 17 00:00:00 2001 From: DawnFire42 Date: Fri, 6 Mar 2026 00:31:39 -0500 Subject: [PATCH] Removed superfluous documentation file --- cockatrice/src/game/local_game_options.h | 2 - .../extra-pages/user_documentation/index.md | 4 -- .../local_game/starting_a_local_game.md | 38 ------------------- 3 files changed, 44 deletions(-) delete mode 100644 doc/doxygen/extra-pages/user_documentation/local_game/starting_a_local_game.md diff --git a/cockatrice/src/game/local_game_options.h b/cockatrice/src/game/local_game_options.h index df1d10e10..318271589 100644 --- a/cockatrice/src/game/local_game_options.h +++ b/cockatrice/src/game/local_game_options.h @@ -6,8 +6,6 @@ * This struct encapsulates all settings that can be configured when starting * a local game, providing a clean interface that prevents parameter explosion * as more options are added in the future. - * - * @note User documentation: doc/doxygen/extra-pages/user_documentation/local_game/starting_a_local_game.md */ #ifndef LOCAL_GAME_OPTIONS_H diff --git a/doc/doxygen/extra-pages/user_documentation/index.md b/doc/doxygen/extra-pages/user_documentation/index.md index 387d4241f..d7e9d529d 100644 --- a/doc/doxygen/extra-pages/user_documentation/index.md +++ b/doc/doxygen/extra-pages/user_documentation/index.md @@ -1,9 +1,5 @@ @page user_reference User Reference -## Local Games - -- @subpage starting_local_game - ## Deck Management - @subpage creating_decks diff --git a/doc/doxygen/extra-pages/user_documentation/local_game/starting_a_local_game.md b/doc/doxygen/extra-pages/user_documentation/local_game/starting_a_local_game.md deleted file mode 100644 index 8ce696f7d..000000000 --- a/doc/doxygen/extra-pages/user_documentation/local_game/starting_a_local_game.md +++ /dev/null @@ -1,38 +0,0 @@ -@page starting_local_game Starting a Local Game - -## Overview - -Local games allow you to play Cockatrice offline without connecting to a server. This is useful for testing decks, playing against yourself, or practicing game mechanics. - -## Starting a Local Game - -1. From the main menu, select **Cockatrice** > **Start local game** (or use the keyboard shortcut) -2. The **Local game options** dialog will appear - -## Configuration Options - -### Number of Players - -Set the number of players in the game (1-8). Each player will be assigned a name like "Player 1", "Player 2", etc. - -### Starting Life Total - -Set the starting life total for all players. The default is 20, which is standard for most Magic: The Gathering formats. You can set this to any value from 1 to 99999 to accommodate different formats: -- **20** - Standard, Modern, Legacy, Vintage, Limited -- **40** - Commander/EDH -- **30** - Two-Headed Giant (per team) - -### Spectators Can See Everything - -When enabled, spectators can see all hidden information (hands, face-down cards, etc.). This is useful when streaming or recording gameplay where viewers should see the full game state. - -### Remember Settings - -When checked, your current settings will be saved and automatically loaded the next time you start a local game. This saves time if you frequently use the same configuration. - -## After Starting - -Once you click **OK**, the game will start and you can: -- Load a deck for each player -- Play the game as you would in a multiplayer match -- Switch between players using the player tabs