diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..a72e526 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,3 @@ +# OpenCombat documentation + +* [Player manual](./player/index.md) \ No newline at end of file diff --git a/doc/player/battle_placement.png b/doc/player/battle_placement.png new file mode 100644 index 0000000..65bd18b Binary files /dev/null and b/doc/player/battle_placement.png differ diff --git a/doc/player/battle_placement_hide.png b/doc/player/battle_placement_hide.png new file mode 100644 index 0000000..908cb86 Binary files /dev/null and b/doc/player/battle_placement_hide.png differ diff --git a/doc/player/fire_suppress.png b/doc/player/fire_suppress.png new file mode 100644 index 0000000..2f080cf Binary files /dev/null and b/doc/player/fire_suppress.png differ diff --git a/doc/player/fire_target.png b/doc/player/fire_target.png new file mode 100644 index 0000000..1997198 Binary files /dev/null and b/doc/player/fire_target.png differ diff --git a/doc/player/hud.png b/doc/player/hud.png new file mode 100644 index 0000000..8e01c1d Binary files /dev/null and b/doc/player/hud.png differ diff --git a/doc/player/index.md b/doc/player/index.md new file mode 100644 index 0000000..5fb2fe3 --- /dev/null +++ b/doc/player/index.md @@ -0,0 +1,112 @@ +# Player manual + +Open Combat is a real-time tactical war game. Your objective is to win battles in a theater of war. You will manage soldiers, vehicle and artillery moves and fire orders. And only that. + +## Battle + +### Deployment phase + +This phase let you all time you need to place your troops. You must think about two things: + +- Your soldiers are they in secured place ? Avoid places where they can be shoot when battle will start +- Your soldiers will be able to make tactical move to conquer the map ? + +You can place them in the lighted area. Dark area is the opponent placement zone. + +![Placement zone image](./battle_placement.png) + +💡 *Note*: You can hide trees with `T` key. + +#### How place the troops + +To move troops, drag'n drop soldiers with the `left-click`. + +#### Prepare some orders + +You can give orders to squads. See following [Orders section](#orders). These orders will be executed only when battle start. + +💡 *Note*: Unless you want your squad move/sneak immediately when battle start, choose `Hide` order is a good choice to prevent your soldiers from being seen at the start of the battle. + +![Placement hide order image](./battle_placement_hide.png) + +### HUD + +![HUD image](./hud.png) + +#### Squad list + +![Squad list detail image](./squad_detail.png) + +This is the list of your squads. You can quick see how are they health (green is ok, red is not ok ...). Little icon is ammunition level. + +A click on the squad detail selected it. A second click center map on the squad leader. + +#### Squad detail + +![Squad detail image](squad_detail2.png) + +This is a larger view of squad detail. You can see on each soldier line his current behavior. + +#### Minimap + +![Minimap image](./minimap.png) + +Minimap is a reduced image of the entire map. Your squad are blue square. Visible opponents squad are red square. + +You can click on the minimap to center screen on clicked point. + +#### Morale + +![Morale indicator image](./morale.png) + +The color bar is split in two zone: Left is side "A" (you), right is side "B" (opponent). Green is good morale. Dark green is bad morale. + +#### Start the battle + +When you are ready to start the battle, click on the "Begin" button. + +### Fight phase + +#### How to win + +Two possible ways: + +- Reduce opponent morale to a very low state by killing or injuring their soldiers +- Take all flags on the map + +#### Tactics + +- When soldier walk, he is more visible +- When soldier run, he is more (more) visible +- When soldier is crawling, he is less visible +- When soldier firing, he is more visible +- When soldier receive fire, he can be pinned down and be unable to fire +- When soldier pinned down, he can refuse a move order +- When soldier pinned down, he can't refuse a move fast order, but will do it by crawling +- When soldier is near a wall/trunk/etc. he got protection from it +- When a soldier shoots at a soldier near a wall/trunk/etc., it will be difficult to hit him + +#### Orders + +![Orders image](./orders_menu.png) + +To open orders menu, press `right-click` when one or multiple squads are selected. + +* Move: Move by walking +* Move fast: Move by running +* Sneak: Move by crawling +* Fire: Shoot on the given target +* Defend: Shoot on all visible opponents +* Hide: Hide and shoot only if opponent is very near (yellow circle when giving order) + +##### Fire + +When giving fire order, two possible cases : + +![target fire](./fire_target.png) + +When circle is red filled, you give an target order. The squad will target the opponent squad soldiers. + +![Suppress fire](./fire_suppress.png) + +When circle is black filled, you give a suppress fire order. The squad will fire "on the ground" to make a suppress fire. \ No newline at end of file diff --git a/doc/player/minimap.png b/doc/player/minimap.png new file mode 100644 index 0000000..0a95d42 Binary files /dev/null and b/doc/player/minimap.png differ diff --git a/doc/player/morale.png b/doc/player/morale.png new file mode 100644 index 0000000..4b65865 Binary files /dev/null and b/doc/player/morale.png differ diff --git a/doc/player/orders_menu.png b/doc/player/orders_menu.png new file mode 100644 index 0000000..2f7c976 Binary files /dev/null and b/doc/player/orders_menu.png differ diff --git a/doc/player/squad_detail.png b/doc/player/squad_detail.png new file mode 100644 index 0000000..e3d4e7d Binary files /dev/null and b/doc/player/squad_detail.png differ diff --git a/doc/player/squad_detail2.png b/doc/player/squad_detail2.png new file mode 100644 index 0000000..890414a Binary files /dev/null and b/doc/player/squad_detail2.png differ