README.md
author alfadur
Sat, 13 Oct 2018 23:49:23 +0300
changeset 13915 9954f9b800f5
parent 13753 5985ee7a4922
child 14467 cb08cecc3bab
permissions -rw-r--r--
improve stability for checks
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     1
Hedgewars - a turn-based strategy game
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     2
======================================
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     3
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     4
Description
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     5
-----------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     6
This is the funniest and most addictive game you'll ever play—hilarious fun
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     7
that you can enjoy anywhere, anytime. **Hedgewars** is a **turn-based strategy
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
     8
game** but the real buzz is from watching the **devastation caused by those
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
     9
pesky hedgehogs** with those fantastic weapons—sneaky little blighters with
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    10
a bad attitude!
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    11
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    12
Each player controls a **team of up to 8 hedgehogs**. During the course of
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    13
the game, players take turns with one of their hedgehogs. They then use
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    14
whatever tools and weapons are available to **attack and kill the opponents'
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    15
hedgehogs**, thereby winning the game.
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    16
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    17
To destroy your foes you can use one out of **over 40 weapons**!
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    18
Launch bazookas or homing bees, drop mines, dynamite or explosive rubber ducks,
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    19
throw grenades or watermelon bombs, poison them with stinky cheese, send them
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    20
flying with a baseball bat, and much more!
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    21
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    22
Most weapons cause **explosions that deform the terrain**, removing
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    23
circular chunks. Hedgehogs can die by drowning, being thrown off
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    24
either side of the arena, or when their health is reduced to zero.
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    25
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    26
Hedgehogs may move around the terrain in a variety of ways, normally by
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    27
walking and jumping but also by using particular tools such as the rope
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    28
or parachute, to move to otherwise inaccessible areas. Each **turn is
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    29
time-limited** to ensure that players do not hold up the game with
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    30
excessive thinking or moving.
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    31
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    32
Getting started
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    33
---------------
13084
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    34
For complete beginners we recommend to play in singleplayer mode first.
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    35
Start with the Basic Movement Training found in the training menu.
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    36
Proceed with the other training missions.
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    37
After completing the training, try to play some quick matches against the
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    38
computer (also found in the singleplayer menu).
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    39
Hedgewars has many weapons, so play a few matches to get a better feeling
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    40
for them.
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    41
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    42
In-depth information about the game can be found online:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    43
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    44
* <https://hedgewars.org/start>: Getting Started
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    45
* <https://hedgewars.org/wiki.html>: Hedgewars Wiki
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    46
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    47
Default controls (excerpt)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    48
--------------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    49
The most important default controls are:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    50
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    51
* Cursor keys: Walk and aim
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    52
* Mouse: Move camera
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    53
* Right mouse button: Open ammo menu
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    54
* Left mouse button: Select target or weapon
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    55
* Space bar: Shoot
12994
4d4b2fb88e50 Update README about the team chat key
Wuzzy <Wuzzy2@mail.ru>
parents: 12752
diff changeset
    56
* Left shift: Precise (this is a modifier key)
12997
f06660523198 Add separate control for changing hedgehog tags
Wuzzy <Wuzzy2@mail.ru>
parents: 12996
diff changeset
    57
* Precise + Up/Down: Precise aiming
f06660523198 Add separate control for changing hedgehog tags
Wuzzy <Wuzzy2@mail.ru>
parents: 12996
diff changeset
    58
* Precise + Left/Right: Turn around without walking
f06660523198 Add separate control for changing hedgehog tags
Wuzzy <Wuzzy2@mail.ru>
parents: 12996
diff changeset
    59
* Hold down Precise: Prevent slipping on ice
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    60
* Enter: Jump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    61
* Backspace: High jump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    62
* Backspace ×2: Backjump
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    63
* Tab: Switch hedgehog (after activating the utility)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    64
* 1-5: Set weapon timer
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    65
* F1-F10: Weapon shortcuts
13465
08a3851aaf67 Add dedicated key to display mission panel: M
Wuzzy <Wuzzy2@mail.ru>
parents: 13367
diff changeset
    66
* M: Mission panel / game mode information. Hold pressed to display, release to hide
12996
2bafaeed5e2e Rename AFK Mode to “Auto Skip” (bug 78)
Wuzzy <Wuzzy2@mail.ru>
parents: 12995
diff changeset
    67
* P: Pause, when playing offline, toggle automatic turn skipping when online
13465
08a3851aaf67 Add dedicated key to display mission panel: M
Wuzzy <Wuzzy2@mail.ru>
parents: 13367
diff changeset
    68
* Esc: Quit with prompt
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    69
* T: Chat
13675
d3a4cbba060e Consistently rename "team chat" to "clan chat" (except chat command)
Wuzzy <Wuzzy2@mail.ru>
parents: 13568
diff changeset
    70
* U: Clan chat
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    71
13527
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    72
### Default controller controls
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    73
Hedgewars also supports controllers. By default, Hedgewars sets up a few
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    74
controls for your first (!) connected controller.
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    75
This default might not be ideal, we recommend you set manual controls
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    76
in the settings menu.
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    77
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    78
* 1st D-pad: Walk and aim
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    79
* 2nd D-pad / 1st thumbstick: Move camera/cursor
13533
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    80
* Button  1: Long jump
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    81
* Button  2: High jump
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    82
* Button  3: Attack
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    83
* Button  4: Ammo menu
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    84
* Button  5: Precise
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    85
* Button  6: Select target, or pick weapon (in ammo menu)
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    86
* Button  7: Switch hedgehog
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    87
* Button  8: Change timer
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    88
* Button  9: Find hedgehog / toggle auto camera
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
    89
* Button 10: Mission panel
13527
1232ab8206d4 Add more sane default controls for controller
Wuzzy <Wuzzy2@mail.ru>
parents: 13465
diff changeset
    90
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    91
For the full list, go to the Hedgewars settings. Also read the weapon tooltips
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    92
for weapon-specific controls.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    93
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    94
### Special controls
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    95
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    96
These are lesser-known controls of Hedgewars, they are based on your
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    97
configured controls:
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
    98
13007
8a8aaaf97a95 The rottags key alone now toggles hog tags; preecise+rottags is used to cycle tags
Wuzzy <Wuzzy2@mail.ru>
parents: 13001
diff changeset
    99
* Precise + Toggle hedgehog tags: Change visible hedgehog tags (team name/hog name/health)
13533
0c8001e43fd3 Add control to cycle through timer/bounciness values
Wuzzy <Wuzzy2@mail.ru>
parents: 13527
diff changeset
   100
* Switch  + Toggle hedgehog tags: Toggle hedgehog tag translucency
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   101
* Precise + Toggle team bars + Switch: Toggle HUD
12994
4d4b2fb88e50 Update README about the team chat key
Wuzzy <Wuzzy2@mail.ru>
parents: 12752
diff changeset
   102
* Precise + Capture (screenshot key): Save current map + mask into Screenshot directory
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   103
13715
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   104
System requirements
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   105
-------------------
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   106
For PC or Mac:
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   107
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   108
* Mouse and keyboard
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   109
* Monitor, minimal resolution 1024×768
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   110
* 200 MiB storage space
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   111
* Processor: 1 GHz (1 core is enough), 64bit recommended
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   112
* Video card: 250 MHz or so
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   113
              (any decent card from the year 2004 or later should do fine)
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   114
* 1 GiB RAM minimum
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   115
* Operating system: Windows Vista/7/8/10, GNU/Linux, macOS, FreeBSD, others
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   116
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   117
Hedgewars has been ported to other operating systems in the past.
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   118
Check out <https://hedgewars.org/download.html> for the latest information.
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   119
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   120
Gamepads are supported partially (only in-game, not in the main menu).
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   121
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   122
Installation instructions
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   123
-------------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   124
See the `INSTALL.md` file.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   125
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   126
Or see our wiki at <https://hedgewars.org/kb/BuildingHedgewars>.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   127
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   128
Source code
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   129
-----------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   130
Our main repository is located at <https://hg.hedgewars.org/hedgewars/> using
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   131
Mercurial as DVCS. A Git repository is also available (mirrored daily)
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   132
at <https://github.com/hedgewars/hw>.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   133
11357
89fd907ccdec README.md: Add a travis badge
koda
parents: 11319
diff changeset
   134
[![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
89fd907ccdec README.md: Add a travis badge
koda
parents: 11319
diff changeset
   135
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   136
Contribute
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   137
----------
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   138
If you see a bug or have any suggestion please use the official bug tracker at
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   139
<https://hedgewars.org/bugs> or the integrated feedback button.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   140
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   141
If you want to help or get to know the sources better you can do that with some
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   142
easy tasks from <https://hedgewars.org/kb/TODO>. We also have an extensive API
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   143
in Lua to customize your adventures. See our wiki at
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   144
<https://hedgewars.org/kb/LuaAPI>.
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   145
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   146
If you know your way through the code feel free to send a patch or open a pull
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   147
request. The best Lua scripts get released in the official DLC page and later
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   148
integrated in the next version.
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   149
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   150
Licence and credits
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   151
-------------------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   152
This game is free software (“free” as in “freedom”). Source code is
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   153
distributed under the terms of the GNU General Public Licence version 2;
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   154
images and sounds are distributed under the terms of the GNU Free Documentation
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   155
Licence version 1.2. See the `COPYING` file for the full text of the licenses.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   156
13367
6fd53df98549 Update copyright years
Wuzzy <Wuzzy2@mail.ru>
parents: 13084
diff changeset
   157
Copyright 2004-2018 Andrey Korotaev <unC0Rr@gmail.com> and others.
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   158
See `QTfrontend/res/html/about.html` and `CREDITS` for a more complete list of
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   159
authors.
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   160
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   161
Contact
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   162
-------
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   163
* Homepage        - https://hedgewars.org/
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   164
* IRC channel     - irc://irc.freenode.net/hedgewars
12752
0e425574bd5f Update README.md: Add game description, controls, getting started guide for n00bs, fix typos, reorganize sections
Wuzzy <Wuzzy2@mail.ru>
parents: 12658
diff changeset
   165
* Community forum - https://hedgewars.org/forum
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   166