0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expand Wesnoth's README.

Browse source 
Supercedes #5843
This commit is contained in:
Pentarctagon 2021-09-05 21:19:11 -05:00
parent 5bdae673af
commit 6f817df889
No known key found for this signature in database
GPG key ID: 9456BC54A21DBFA0
1 changed files with 53 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
README.md
View file

@ -3,40 +3,77 @@
About
=====
**The Battle for Wesnoth** is an Open Source, turn-based tactical strategy game with a
high fantasy theme, featuring both singleplayer and online/hotseat multiplayer
combat. Fight a desperate battle to reclaim the throne of Wesnoth, or take
hand in any number of other adventures.
**The Battle for Wesnoth** is an Open Source, turn-based tactical strategy game with a high fantasy theme, featuring both singleplayer and online/hotseat multiplayer combat. Fight a desperate battle to reclaim the throne of Wesnoth, or take hand in any number of other adventures.
Community
---------
License
-------
The official Battle for Wesnoth Forums:
<https://forums.wesnoth.org/>
Please see the wiki for information regarding The Battle for Wesnoth's licensing:
Discord:
<https://discord.gg/battleforwesnoth>
<https://wiki.wesnoth.org/Wesnoth:Copyrights>
IRC:
<https://wiki.wesnoth.org/Support#IRC>
Twitter:
<https://twitter.com/Wesnoth>
Steam forums:
<https://steamcommunity.com/app/599390/discussions/>
Installing
----------
See [INSTALL](/INSTALL.md) for instructions on how to build the game from source code.
Wesnoth can be played on Windows, macOS, and Linux, and can be installed using:
* [Steam](https://store.steampowered.com/app/599390/Battle_for_Wesnoth/) (all)
* [itch.io](https://wesnoth.itch.io/battle-for-wesnoth) (Windows and macOS)
* The [macOS App Store](https://apps.apple.com/us/app/the-battle-for-wesnoth/id1450738104)
* standalone installers on [SourceForge](https://sourceforge.net/projects/wesnoth/files/) (Windows and macOS)
* [Flatpak](https://flathub.org/apps/details/org.wesnoth.Wesnoth) (Linux)
Additionally, Wesnoth is available for [iOS](https://apps.apple.com/us/app/battle-for-wesnoth/id575852062) and [Android](https://play.google.com/store/apps/details?id=it.alessandropira.wesnoth114).
To build the game from source, see [INSTALL](/INSTALL.md) for instructions.
Contributing
------------
Wesnoth is most in need of skilled C++ developers (C++ 11 and later), however there are things that nearly anyone can help with from simpler tasks in C++, the Lua and WML used for content scripting, Python used by various external tools, and even things like play testing and giving feedback on updated campaigns. Additionally, Wesnoth lacks art for a variety of unit animations - anyone who would be interested in lending a hand updating existing unit sprites or creating animations should take a look at the Art Forum as well as contact our current art director.
See also: [CONTRIBUTING](/CONTRIBUTING.md)
For any questions, the best place to start is to simply join Wesnoth's forums, Discord, or IRC and start asking!
Donations
---------
Donations can be sent via [Liberapay](https://liberapay.com/Wesnoth) as well as when downloading through itch.io. All money donated is used to pay for project expenses such as server rent and art commissions, and is very much appreciated.
License
-------
All source code is licensed under the GNU GPL v2+. Most art and music is also licensed under the GNU GPL v2+, however new contributions are now licensed under the Creative Commons BY-SA v4.0. For more detailed information on Wesnoth's licensing, see the wiki:
<https://wiki.wesnoth.org/Wesnoth:Copyrights>
More Information
----------------
For extensive documentation about all aspects of the game, see the
official Battle for Wesnoth web site.
For extensive documentation about all aspects of the game, see the official Battle for Wesnoth web site:
<https://www.wesnoth.org/>
<https://wiki.wesnoth.org/>
A (translated) description of how to play the game can be found in
doc/manual/manual.*.html, or online at:
A (translated) description of how to play the game can be found in doc/manual/manual.*.html, or online at:
<https://wiki.wesnoth.org/WesnothManual>
The official Battle for Wesnoth Forums (with over 400,000 posts from more than
20,000 registered members) can be found at:
For information on creating your own maps, scenarios, and other content, see:
<https://forums.wesnoth.org/>
<https://wiki.wesnoth.org/Create>