README.md
branchios-develop
changeset 13418 ba39a1d396c0
parent 13372 6fd53df98549
child 13464 08a3851aaf67
equal deleted inserted replaced
13416:6e8b807bda4b 13418:ba39a1d396c0
     4 Description
     4 Description
     5 -----------
     5 -----------
     6 This is the funniest and most addictive game you'll ever play—hilarious fun
     6 This is the funniest and most addictive game you'll ever play—hilarious fun
     7 that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
     7 that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
     8 game** but the real buzz is from watching the **devastation caused by those
     8 game** but the real buzz is from watching the **devastation caused by those
     9 pesky hedgehogs** with those fantastic weapons—sneaky little blighters with a
     9 pesky hedgehogs** with those fantastic weapons—sneaky little blighters with
    10 bad attitude!
    10 a bad attitude!
    11 
    11 
    12 Each player controls a **team of up to 8 hedgehogs**. During the course of
    12 Each player controls a **team of up to 8 hedgehogs**. During the course of
    13 the game, players take turns with one of their hedgehogs. They then use
    13 the game, players take turns with one of their hedgehogs. They then use
    14 whatever tools and weapons are available to **attack and kill the opponents'
    14 whatever tools and weapons are available to **attack and kill the opponents'
    15 hedgehogs**, thereby winning the game. Hedgehogs may move around the terrain
    15 hedgehogs**, thereby winning the game.
    16 in a variety of ways, normally by walking and jumping but also by using
       
    17 particular tools such as the rope or parachute, to move to otherwise
       
    18 inaccessible areas. Each **turn is time-limited** to ensure that players do
       
    19 not hold up the game with excessive thinking or moving.
       
    20 
    16 
    21 A large **variety of tools and weapons** are available for players during
    17 To destroy your foes you can use one out of **over 40 weapons**!
    22 the game. Hedgewars features the standard artillery-genre classics (such as
    18 Launch bazookas or homing bees, drop mines, dynamite or explosive rubber ducks,
    23 grenade, cluster bomb, bazooka, shotgun), but also boasts a host of other
    19 throw grenades or watermelon bombs, poison them with stinky cheese, send them
    24 weapons quite unique to it alone.
    20 flying with a baseball bat, and much more!
    25 
    21 
    26 Most weapons, when used, cause **explosions that deform the terrain**,
    22 Most weapons cause **explosions that deform the terrain**, removing
    27 removing circular chunks. Hedgehogs can die by drowning, being thrown off
    23 circular chunks. Hedgehogs can die by drowning, being thrown off
    28 either side of the arena, or when their health is reduced to zero.
    24 either side of the arena, or when their health is reduced to zero.
       
    25 
       
    26 Hedgehogs may move around the terrain in a variety of ways, normally by
       
    27 walking and jumping but also by using particular tools such as the rope
       
    28 or parachute, to move to otherwise inaccessible areas. Each **turn is
       
    29 time-limited** to ensure that players do not hold up the game with
       
    30 excessive thinking or moving.
    29 
    31 
    30 Getting started
    32 Getting started
    31 ---------------
    33 ---------------
    32 For complete beginners we recommend to start with the the first 2 or 3
    34 For complete beginners we recommend to play in singleplayer mode first.
    33 missions of the campaign “A Classic Fairytale” in the singleplayer menu.
    35 Start with the Basic Movement Training found in the training menu.
    34 It explains the basic controls and gameplay.
    36 Proceed with the other training missions.
    35 
    37 After completing the training, try to play some quick matches against the
    36 Note that Hedgewars doesn't have a *complete* tutorial yet, but it is
    38 computer (also found in the singleplayer menu).
    37 planned to create one in future versions.
    39 Hedgewars has many weapons, so play a few matches to get a better feeling
       
    40 for them.
    38 
    41 
    39 In-depth information about the game can be found online:
    42 In-depth information about the game can be found online:
    40 
    43 
    41 * <https://hedgewars.org/start>: Getting Started
    44 * <https://hedgewars.org/start>: Getting Started
    42 * <https://hedgewars.org/wiki.html>: Hedgewars Wiki
    45 * <https://hedgewars.org/wiki.html>: Hedgewars Wiki
    48 * Cursor keys: Walk and aim
    51 * Cursor keys: Walk and aim
    49 * Mouse: Move camera
    52 * Mouse: Move camera
    50 * Right mouse button: Open ammo menu
    53 * Right mouse button: Open ammo menu
    51 * Left mouse button: Select target or weapon
    54 * Left mouse button: Select target or weapon
    52 * Space bar: Shoot
    55 * Space bar: Shoot
    53 * Left shift: Precise
    56 * Left shift: Precise (this is a modifier key)
    54 * Left shift + Up/Down: Precise aiming
    57 * Precise + Up/Down: Precise aiming
       
    58 * Precise + Left/Right: Turn around without walking
       
    59 * Hold down Precise: Prevent slipping on ice
    55 * Enter: Jump
    60 * Enter: Jump
    56 * Backspace: High jump
    61 * Backspace: High jump
    57 * Backspace ×2: Backjump
    62 * Backspace ×2: Backjump
    58 * Tab: Switch hedgehog (after activating the utility)
    63 * Tab: Switch hedgehog (after activating the utility)
    59 * 1-5: Set weapon timer
    64 * 1-5: Set weapon timer
    60 * F1-F10: Weapon shortcuts
    65 * F1-F10: Weapon shortcuts
    61 * P: Pause (also shows mission panel)
    66 * P: Pause, when playing offline, toggle automatic turn skipping when online
    62 * Esc: Quit with prompt (also shows mission panel)
    67 * Esc: Quit with prompt (also shows mission panel)
    63 * T: Chat
    68 * T: Chat
       
    69 * U: Team chat
    64 
    70 
    65 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
    71 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
    66 for weapon-specific controls.
    72 for weapon-specific controls.
    67 
    73 
    68 ### Special controls
    74 ### Special controls
    69 
    75 
    70 These are lesser-known controls of Hedgewars, they are based on your
    76 These are lesser-known controls of Hedgewars, they are based on your
    71 configured controls:
    77 configured controls:
    72 
    78 
    73 * Confirm: Team chat (if not confirming quit)
    79 * Precise + Toggle hedgehog tags: Change visible hedgehog tags (team name/hog name/health)
    74 * Hold down Precise: Prevent slipping on ice
    80 * Switch + Toggle hedgehog tags: Toggle hedgehog tag translucency
    75 * Precise + Left/Right: Turn around
       
    76 * Precise + Toggle team bars: Change hedgehog tabs
       
    77 * Precise + Toggle team bars + Switch: Toggle HUD
    81 * Precise + Toggle team bars + Switch: Toggle HUD
    78 * Precise + Screenshot: Save current map + mask in Screenshot directory
    82 * Precise + Capture (screenshot key): Save current map + mask into Screenshot directory
    79 
    83 
    80 Installation instructions
    84 Installation instructions
    81 -------------------------
    85 -------------------------
    82 See the `INSTALL.md` file.
    86 See the `INSTALL.md` file.
    83 
    87 
   110 This game is free software (“free” as in “freedom”). Source code is
   114 This game is free software (“free” as in “freedom”). Source code is
   111 distributed under the terms of the GNU General Public Licence version 2;
   115 distributed under the terms of the GNU General Public Licence version 2;
   112 images and sounds are distributed under the terms of the GNU Free Documentation
   116 images and sounds are distributed under the terms of the GNU Free Documentation
   113 Licence version 1.2. See the `COPYING` file for the full text of the licenses.
   117 Licence version 1.2. See the `COPYING` file for the full text of the licenses.
   114 
   118 
   115 Copyright 2004-2015 Andrey Korotaev <unC0Rr@gmail.com> and others.
   119 Copyright 2004-2018 Andrey Korotaev <unC0Rr@gmail.com> and others.
   116 See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
   120 See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
   117 authors.
   121 authors.
   118 
   122 
   119 Contact
   123 Contact
   120 -------
   124 -------