README.md
branchui-scaling
changeset 15288 c4fd2813b127
parent 15284 7ab5cf405686
equal deleted inserted replaced
13395:0135e64c6c66 15288:c4fd2813b127
     1 Hedgewars - a turn-based strategy game
     1 Hedgewars - a turn-based strategy game
     2 ======================================
     2 ======================================
       
     3 [![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
     3 
     4 
     4 Description
     5 Description
     5 -----------
     6 -----------
     6 This is the funniest and most addictive game you'll ever play—hilarious fun
     7 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 that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
    61 * Backspace: High jump
    62 * Backspace: High jump
    62 * Backspace ×2: Backjump
    63 * Backspace ×2: Backjump
    63 * Tab: Switch hedgehog (after activating the utility)
    64 * Tab: Switch hedgehog (after activating the utility)
    64 * 1-5: Set weapon timer
    65 * 1-5: Set weapon timer
    65 * F1-F10: Weapon shortcuts
    66 * F1-F10: Weapon shortcuts
       
    67 * M: Mission panel / game mode information. Hold pressed to display, release to hide
    66 * P: Pause, when playing offline, toggle automatic turn skipping when online
    68 * P: Pause, when playing offline, toggle automatic turn skipping when online
    67 * Esc: Quit with prompt (also shows mission panel)
    69 * Esc: Quit with prompt
    68 * T: Chat
    70 * T: Chat
    69 * U: Team chat
    71 * U: Clan chat
    70 
    72 
    71 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
    73 For the full list, go to the Hedgewars settings. Also read the weapon tooltips
    72 for weapon-specific controls.
    74 for weapon-specific controls.
    73 
    75 
    74 ### Special controls
    76 ### Special controls
    75 
    77 
    76 These are lesser-known controls of Hedgewars, they are based on your
    78 These are lesser-known controls of Hedgewars, they are based on your
    77 configured controls:
    79 configured controls:
    78 
    80 
    79 * Precise + Toggle hedgehog tags: Change visible hedgehog tags (team name/hog name/health)
    81 * Precise + Toggle hedgehog tags: Change visible hedgehog tags (team name/hog name/health)
    80 * Switch + Toggle hedgehog tags: Toggle hedgehog tag translucency
    82 * Switch  + Toggle hedgehog tags: Toggle hedgehog tag translucency
    81 * Precise + Toggle team bars + Switch: Toggle HUD
    83 * Precise + Toggle team bars + Switch: Toggle HUD
    82 * Precise + Capture (screenshot key): Save current map + mask into Screenshot directory
    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).
    83 
   106 
    84 Installation instructions
   107 Installation instructions
    85 -------------------------
   108 -------------------------
    86 See the `INSTALL.md` file.
   109 See the `INSTALL.md` file.
    87 
   110 
    90 Source code
   113 Source code
    91 -----------
   114 -----------
    92 Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
   115 Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
    93 Mercurial as DVCS. A Git repository is also available (mirrored daily)
   116 Mercurial as DVCS. A Git repository is also available (mirrored daily)
    94 at <https://github.com/hedgewars/hw>.
   117 at <https://github.com/hedgewars/hw>.
    95 
       
    96 [![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
       
    97 
   118 
    98 Contribute
   119 Contribute
    99 ----------
   120 ----------
   100 If you see a bug or have any suggestion please use the official bug tracker at
   121 If you see a bug or have any suggestion please use the official bug tracker at
   101 <https://hedgewars.org/bugs> or the integrated feedback button.
   122 <https://hedgewars.org/bugs> or the integrated feedback button.
   114 This game is free software (“free” as in “freedom”). Source code is
   135 This game is free software (“free” as in “freedom”). Source code is
   115 distributed under the terms of the GNU General Public Licence version 2;
   136 distributed under the terms of the GNU General Public Licence version 2;
   116 images and sounds are distributed under the terms of the GNU Free Documentation
   137 images and sounds are distributed under the terms of the GNU Free Documentation
   117 Licence version 1.2. See the `COPYING` file for the full text of the licenses.
   138 Licence version 1.2. See the `COPYING` file for the full text of the licenses.
   118 
   139 
   119 Copyright 2004-2015 Andrey Korotaev <unC0Rr@gmail.com> and others.
   140 Copyright 2004-2018 Andrey Korotaev <unC0Rr@gmail.com> and others.
   120 See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
   141 Click on the Hedgewars logo in the main menu and read the `CREDITS` text file
   121 authors.
   142 for a more complete list of authors.
   122 
   143 
   123 Contact
   144 Contact
   124 -------
   145 -------
   125 * Homepage        - https://hedgewars.org/
   146 * Homepage        - https://hedgewars.org/
   126 * IRC channel     - irc://irc.freenode.net/hedgewars
   147 * IRC channel     - irc://irc.freenode.net/hedgewars
   127 * Community forum - https://hedgewars.org/forum
   148 * Community forum - https://hedgewars.org/forum
   128 * Mailing list    - https://mail.gna.org/listinfo/hedgewars-dev
       
   129 
   149