README.md
author alfadur
Sun, 04 Aug 2019 02:38:11 +0300
changeset 15314 042a5e8d9c59
parent 15300 7ab5cf405686
child 15962 baba5a7090b4
permissions -rw-r--r--
fix shader uniform access
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
======================================
14978
947a4a4d2131 Move build status higher
Anton Malmygin <antonc27@mail.ru>
parents: 14700
diff changeset
     3
[![Build Status](https://travis-ci.org/hedgewars/hw.svg)](https://travis-ci.org/hedgewars/hw)
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
     4
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
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
     6
-----------
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
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
     8
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
     9
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
    10
pesky hedgehogs** with those fantastic weapons—sneaky little blighters with
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    11
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
    12
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
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
    14
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
    15
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
    16
hedgehogs**, thereby winning the game.
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    17
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    18
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
    19
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
    20
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
    21
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
    22
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    23
Most weapons cause **explosions that deform the terrain**, removing
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    24
circular chunks. Hedgehogs can die by drowning, being thrown off
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    25
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
    26
12995
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    27
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
    28
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
    29
or parachute, to move to otherwise inaccessible areas. Each **turn is
d55aae479f50 Rewrite introduction in README
Wuzzy <Wuzzy2@mail.ru>
parents: 12994
diff changeset
    30
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
    31
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
    32
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
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
    34
---------------
13084
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    35
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
    36
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
    37
Proceed with the other training missions.
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    38
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
    39
computer (also found in the singleplayer menu).
e6b0b3e86c2a Update README about the Hedgewars training
Wuzzy <Wuzzy2@mail.ru>
parents: 13007
diff changeset
    40
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
    41
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
    42
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
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
    44
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/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
    46
* <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
    47
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
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
    49
--------------------------
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
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
    51
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
* 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
    53
* 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
    54
* 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
    55
* 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
    56
* Space bar: Shoot
12994
4d4b2fb88e50 Update README about the team chat key
Wuzzy <Wuzzy2@mail.ru>
parents: 12752
diff changeset
    57
* 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
    58
* Precise + Up/Down: Precise aiming
f06660523198 Add separate control for changing hedgehog tags
Wuzzy <Wuzzy2@mail.ru>
parents: 12996
diff changeset
    59
* Precise + Left/Right: Turn around without walking
f06660523198 Add separate control for changing hedgehog tags
Wuzzy <Wuzzy2@mail.ru>
parents: 12996
diff changeset
    60
* 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
    61
* 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
    62
* 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
    63
* 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
    64
* 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
    65
* 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
    66
* F1-F10: Weapon shortcuts
13465
08a3851aaf67 Add dedicated key to display mission panel: M
Wuzzy <Wuzzy2@mail.ru>
parents: 13367
diff changeset
    67
* 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
    68
* 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
    69
* 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
    70
* T: Chat
13675
d3a4cbba060e Consistently rename "team chat" to "clan chat" (except chat command)
Wuzzy <Wuzzy2@mail.ru>
parents: 13568
diff changeset
    71
* 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
    72
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
    73
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
    74
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
    75
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
    76
### 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
    77
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
    78
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
    79
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
    80
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
    81
* 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
    82
* 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
    83
* Precise + Toggle team bars + Switch: Toggle HUD
12994
4d4b2fb88e50 Update README about the team chat key
Wuzzy <Wuzzy2@mail.ru>
parents: 12752
diff changeset
    84
* Precise + Capture (screenshot key): Save current map + mask into Screenshot directory
14700
4eaeba349179 Precise+zoom/volume change makes changes in smaller steps
Wuzzy <Wuzzy2@mail.ru>
parents: 14699
diff changeset
    85
* Precise + zoom in/out: Change zoom in smaller steps
4eaeba349179 Precise+zoom/volume change makes changes in smaller steps
Wuzzy <Wuzzy2@mail.ru>
parents: 14699
diff changeset
    86
* Precise + volume up/down: Change volume in smaller steps
14699
c96889bf5796 Precise+resetzoom = 100% zoom (instead of UserZoom)
Wuzzy <Wuzzy2@mail.ru>
parents: 14554
diff changeset
    87
* Precise + Reset zoom: Set zoom to 100% (instead of the zoom level in the settings)
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
    88
13715
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    89
System requirements
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    90
-------------------
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    91
For PC or Mac:
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    92
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    93
* Mouse and keyboard
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    94
* Monitor, minimal resolution 1024×768
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    95
* 200 MiB storage space
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    96
* Processor: 1 GHz (1 core is enough), 64bit recommended
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    97
* Video card: 250 MHz or so
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
    98
              (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
    99
* 1 GiB RAM minimum
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   100
* 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
   101
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   102
Hedgewars has been ported to other operating systems in the past.
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   103
Check out <https://hedgewars.org/download.html> for the latest information.
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   104
20768d813518 Write down system requirements
Wuzzy <Wuzzy2@mail.ru>
parents: 13675
diff changeset
   105
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
   106
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
   107
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
   108
-------------------------
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
   109
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
   110
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
   111
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
   112
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
   113
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
   114
-----------
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
   115
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
   116
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
   117
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
   118
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
   119
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
   120
----------
11318
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   121
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
   122
<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
   123
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   124
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
   125
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
   126
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
   127
<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
   128
78d8255349d3 Add markdown extension to README so github can render it more nicely
Vittorio Giovara <vittorio.giovara@gmail.com>
parents:
diff changeset
   129
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
   130
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
   131
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
   132
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
   133
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
   134
-------------------
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
   135
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
   136
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
   137
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
   138
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
   139
13367
6fd53df98549 Update copyright years
Wuzzy <Wuzzy2@mail.ru>
parents: 13084
diff changeset
   140
Copyright 2004-2018 Andrey Korotaev <unC0Rr@gmail.com> and others.
14467
cb08cecc3bab Update changelog and README
Wuzzy <Wuzzy2@mail.ru>
parents: 13753
diff changeset
   141
Click on the Hedgewars logo in the main menu and read the `CREDITS` text file
cb08cecc3bab Update changelog and README
Wuzzy <Wuzzy2@mail.ru>
parents: 13753
diff changeset
   142
for a more complete list of authors.
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
   143
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
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
   145
-------
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
   146
* 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
   147
* 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
   148
* 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
   149