README.md
changeset 12752 0e425574bd5f
parent 12658 966124c80861
child 12994 4d4b2fb88e50
equal deleted inserted replaced
12751:838515c4e6c5 12752:0e425574bd5f
     1 Hedgewars - a turn based strategy game.
     1 Hedgewars - a turn-based strategy game
     2 =======================================
     2 ======================================
       
     3 
       
     4 Description
       
     5 -----------
       
     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
       
     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
       
    10 bad attitude!
       
    11 
       
    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
       
    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
       
    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 
       
    21 A large **variety of tools and weapons** are available for players during
       
    22 the game. Hedgewars features the standard artillery-genre classics (such as
       
    23 grenade, cluster bomb, bazooka, shotgun), but also boasts a host of other
       
    24 weapons quite unique to it alone.
       
    25 
       
    26 Most weapons, when used, cause **explosions that deform the terrain**,
       
    27 removing circular chunks. Hedgehogs can die by drowning, being thrown off
       
    28 either side of the arena, or when their health is reduced to zero.
       
    29 
       
    30 Getting started
       
    31 ---------------
       
    32 For complete beginners we recommend to start with the the first 2 or 3
       
    33 missions of the campaign “A Classic Fairytale” in the singleplayer menu.
       
    34 It explains the basic controls and gameplay.
       
    35 
       
    36 Note that Hedgewars doesn't have a *complete* tutorial yet, but it is
       
    37 planned to create one in future versions.
       
    38 
       
    39 In-depth information about the game can be found online:
       
    40 
       
    41 * <https://hedgewars.org/start>: Getting Started
       
    42 * <https://hedgewars.org/wiki.html>: Hedgewars Wiki
       
    43 
       
    44 Default controls (excerpt)
       
    45 --------------------------
       
    46 The most important default controls are:
       
    47 
       
    48 * Cursor keys: Walk and aim
       
    49 * Mouse: Move camera
       
    50 * Right mouse button: Open ammo menu
       
    51 * Left mouse button: Select target or weapon
       
    52 * Space bar: Shoot
       
    53 * Left shift: Precise
       
    54 * Left shift + Up/Down: Precise aiming
       
    55 * Enter: Jump
       
    56 * Backspace: High jump
       
    57 * Backspace ×2: Backjump
       
    58 * Tab: Switch hedgehog (after activating the utility)
       
    59 * 1-5: Set weapon timer
       
    60 * F1-F10: Weapon shortcuts
       
    61 * P: Pause (also shows mission panel)
       
    62 * Esc: Quit with prompt (also shows mission panel)
       
    63 * T: Chat
       
    64 
       
    65 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
       
    66 for weapon-specific controls.
       
    67 
       
    68 ### Special controls
       
    69 
       
    70 These are lesser-known controls of Hedgewars, they are based on your
       
    71 configured controls:
       
    72 
       
    73 * Confirm: Team chat (if not confirming quit)
       
    74 * Hold down Precise: Prevent slipping on ice
       
    75 * Precise + Left/Right: Turn around
       
    76 * Precise + Toggle team bars: Change hedgehog tabs
       
    77 * Precise + Toggle team bars + Switch: Toggle HUD
       
    78 * Precise + Screenshot: Save current map + mask in Screenshot directory
       
    79 
       
    80 Installation instructions
       
    81 -------------------------
       
    82 See the `INSTALL.md` file.
       
    83 
       
    84 Or see our wiki at <https://hedgewars.org/kb/BuildingHedgewars>.
       
    85 
       
    86 Source code
       
    87 -----------
       
    88 Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
       
    89 Mercurial as DVCS. A Git repository is also available (mirrored daily)
       
    90 at <https://github.com/hedgewars/hw>.
     3 
    91 
     4 [![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
    92 [![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
     5 
    93 
     6 Copyright 2004-2015 Andrey Korotaev <unC0Rr@gmail.com> and others.
    94 Contribute
     7 See QTfrontend/res/html/about.html and CREDITS for a complete list of authors.
    95 ----------
     8 
       
     9 Licence:
       
    10 --------
       
    11 Source code is distributed under the terms of the GNU General Public Licence
       
    12 version 2; images and sounds are distributed under the terms of the GNU Free
       
    13 Documentation Licence version 1.2. See the COPYING file for the full text of
       
    14 the licenses.
       
    15 
       
    16 Instructions:
       
    17 -------------
       
    18 See our wiki at: https://hedgewars.org/kb/BuildingHedgewars
       
    19 
       
    20 You can find an outline of the necessary dependencies in the INSTALL file.
       
    21 
       
    22 Source code:
       
    23 ------------
       
    24 Our main repository is located at https://hg.hedgewars.org/hedgewars/ using
       
    25 Mercurial as DVCS. A Git repository is also available (mirrored daily)
       
    26 at https://github.com/hedgewars/hw
       
    27 
       
    28 Contribute:
       
    29 -----------
       
    30 If you see a bug or have any suggestion please use the official bug tracker at
    96 If you see a bug or have any suggestion please use the official bug tracker at
    31 https://hedgewars.org/bugs or the integrated feedback
    97 <https://hedgewars.org/bugs> or the integrated feedback button.
    32 button.
       
    33 
    98 
    34 If you want to help or get to know the sources better you can do that with some
    99 If you want to help or get to know the sources better you can do that with some
    35 easy tasks from https://hedgewars.org/kb/TODO. We also have an
   100 easy tasks from <https://hedgewars.org/kb/TODO>. We also have an extensive API
    36 extended API in LUA to customize your adventures in our wiki at
   101 in Lua to customize your adventures. See our wiki at
    37 https://hedgewars.org/kb/LuaAPI.
   102 <https://hedgewars.org/kb/LuaAPI>.
    38 
   103 
    39 If you know your way through the code feel free to send a patch or open a pull
   104 If you know your way through the code feel free to send a patch or open a pull
    40 request. The best LUA scripts get released in the official DLC page and later
   105 request. The best Lua scripts get released in the official DLC page and later
    41 integrated in the next version.
   106 integrated in the next version.
    42 
   107 
    43 Contact:
   108 Licence and credits
    44 --------
   109 -------------------
       
   110 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;
       
   112 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.
       
   114 
       
   115 Copyright 2004-2015 Andrey Korotaev <unC0Rr@gmail.com> and others.
       
   116 See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
       
   117 authors.
       
   118 
       
   119 Contact
       
   120 -------
       
   121 * Homepage        - https://hedgewars.org/
    45 * IRC channel     - irc://irc.freenode.net/hedgewars
   122 * IRC channel     - irc://irc.freenode.net/hedgewars
    46 * community forum - https://hedgewars.org/forum
   123 * Community forum - https://hedgewars.org/forum
    47 * mailing list    - https://mail.gna.org/listinfo/hedgewars-dev
   124 * Mailing list    - https://mail.gna.org/listinfo/hedgewars-dev
    48 
   125