README.md
branchhedgeroid
changeset 15515 7030706266df
parent 15284 7ab5cf405686
equal deleted inserted replaced
7861:bc7b6aa5d67a 15515:7030706266df
       
     1 Hedgewars - a turn-based strategy game
       
     2 ======================================
       
     3 [![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
       
     4 
       
     5 Description
       
     6 -----------
       
     7 This is the funniest and most addictive game you'll ever play—hilarious fun
       
     8 that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
       
     9 game** but the real buzz is from watching the **devastation caused by those
       
    10 pesky hedgehogs** with those fantastic weapons—sneaky little blighters with
       
    11 a bad attitude!
       
    12 
       
    13 Each player controls a **team of up to 8 hedgehogs**. During the course of
       
    14 the game, players take turns with one of their hedgehogs. They then use
       
    15 whatever tools and weapons are available to **attack and kill the opponents'
       
    16 hedgehogs**, thereby winning the game.
       
    17 
       
    18 To destroy your foes you can use one out of **over 40 weapons**!
       
    19 Launch bazookas or homing bees, drop mines, dynamite or explosive rubber ducks,
       
    20 throw grenades or watermelon bombs, poison them with stinky cheese, send them
       
    21 flying with a baseball bat, and much more!
       
    22 
       
    23 Most weapons cause **explosions that deform the terrain**, removing
       
    24 circular chunks. Hedgehogs can die by drowning, being thrown off
       
    25 either side of the arena, or when their health is reduced to zero.
       
    26 
       
    27 Hedgehogs may move around the terrain in a variety of ways, normally by
       
    28 walking and jumping but also by using particular tools such as the rope
       
    29 or parachute, to move to otherwise inaccessible areas. Each **turn is
       
    30 time-limited** to ensure that players do not hold up the game with
       
    31 excessive thinking or moving.
       
    32 
       
    33 Getting started
       
    34 ---------------
       
    35 For complete beginners we recommend to play in singleplayer mode first.
       
    36 Start with the Basic Movement Training found in the training menu.
       
    37 Proceed with the other training missions.
       
    38 After completing the training, try to play some quick matches against the
       
    39 computer (also found in the singleplayer menu).
       
    40 Hedgewars has many weapons, so play a few matches to get a better feeling
       
    41 for them.
       
    42 
       
    43 In-depth information about the game can be found online:
       
    44 
       
    45 * <https://hedgewars.org/start>: Getting Started
       
    46 * <https://hedgewars.org/wiki.html>: Hedgewars Wiki
       
    47 
       
    48 Default controls (excerpt)
       
    49 --------------------------
       
    50 The most important default controls are:
       
    51 
       
    52 * Cursor keys: Walk and aim
       
    53 * Mouse: Move camera
       
    54 * Right mouse button: Open ammo menu
       
    55 * Left mouse button: Select target or weapon
       
    56 * Space bar: Shoot
       
    57 * Left shift: Precise (this is a modifier key)
       
    58 * Precise + Up/Down: Precise aiming
       
    59 * Precise + Left/Right: Turn around without walking
       
    60 * Hold down Precise: Prevent slipping on ice
       
    61 * Enter: Jump
       
    62 * Backspace: High jump
       
    63 * Backspace ×2: Backjump
       
    64 * Tab: Switch hedgehog (after activating the utility)
       
    65 * 1-5: Set weapon timer
       
    66 * F1-F10: Weapon shortcuts
       
    67 * M: Mission panel / game mode information. Hold pressed to display, release to hide
       
    68 * P: Pause, when playing offline, toggle automatic turn skipping when online
       
    69 * Esc: Quit with prompt
       
    70 * T: Chat
       
    71 * U: Clan chat
       
    72 
       
    73 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
       
    74 for weapon-specific controls.
       
    75 
       
    76 ### Special controls
       
    77 
       
    78 These are lesser-known controls of Hedgewars, they are based on your
       
    79 configured controls:
       
    80 
       
    81 * Precise + Toggle hedgehog tags: Change visible hedgehog tags (team name/hog name/health)
       
    82 * Switch  + Toggle hedgehog tags: Toggle hedgehog tag translucency
       
    83 * Precise + Toggle team bars + Switch: Toggle HUD
       
    84 * Precise + Capture (screenshot key): Save current map + mask into Screenshot directory
       
    85 * Precise + zoom in/out: Change zoom in smaller steps
       
    86 * Precise + volume up/down: Change volume in smaller steps
       
    87 * Precise + Reset zoom: Set zoom to 100% (instead of the zoom level in the settings)
       
    88 
       
    89 System requirements
       
    90 -------------------
       
    91 For PC or Mac:
       
    92 
       
    93 * Mouse and keyboard
       
    94 * Monitor, minimal resolution 1024×768
       
    95 * 200 MiB storage space
       
    96 * Processor: 1 GHz (1 core is enough), 64bit recommended
       
    97 * Video card: 250 MHz or so
       
    98               (any decent card from the year 2004 or later should do fine)
       
    99 * 1 GiB RAM minimum
       
   100 * Operating system: Windows Vista/7/8/10, GNU/Linux, macOS, FreeBSD, others
       
   101 
       
   102 Hedgewars has been ported to other operating systems in the past.
       
   103 Check out <https://hedgewars.org/download.html> for the latest information.
       
   104 
       
   105 Gamepads are supported partially (only in-game, not in the main menu).
       
   106 
       
   107 Installation instructions
       
   108 -------------------------
       
   109 See the `INSTALL.md` file.
       
   110 
       
   111 Or see our wiki at <https://hedgewars.org/kb/BuildingHedgewars>.
       
   112 
       
   113 Source code
       
   114 -----------
       
   115 Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
       
   116 Mercurial as DVCS. A Git repository is also available (mirrored daily)
       
   117 at <https://github.com/hedgewars/hw>.
       
   118 
       
   119 Contribute
       
   120 ----------
       
   121 If you see a bug or have any suggestion please use the official bug tracker at
       
   122 <https://hedgewars.org/bugs> or the integrated feedback button.
       
   123 
       
   124 If you want to help or get to know the sources better you can do that with some
       
   125 easy tasks from <https://hedgewars.org/kb/TODO>. We also have an extensive API
       
   126 in Lua to customize your adventures. See our wiki at
       
   127 <https://hedgewars.org/kb/LuaAPI>.
       
   128 
       
   129 If you know your way through the code feel free to send a patch or open a pull
       
   130 request. The best Lua scripts get released in the official DLC page and later
       
   131 integrated in the next version.
       
   132 
       
   133 Licence and credits
       
   134 -------------------
       
   135 This game is free software (“free” as in “freedom”). Source code is
       
   136 distributed under the terms of the GNU General Public Licence version 2;
       
   137 images and sounds are distributed under the terms of the GNU Free Documentation
       
   138 Licence version 1.2. See the `COPYING` file for the full text of the licenses.
       
   139 
       
   140 Copyright 2004-2018 Andrey Korotaev <unC0Rr@gmail.com> and others.
       
   141 Click on the Hedgewars logo in the main menu and read the `CREDITS` text file
       
   142 for a more complete list of authors.
       
   143 
       
   144 Contact
       
   145 -------
       
   146 * Homepage        - https://hedgewars.org/
       
   147 * IRC channel     - irc://irc.freenode.net/hedgewars
       
   148 * Community forum - https://hedgewars.org/forum
       
   149