upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2024-09-20 07:51:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
master
wesnoth/README.md

110 lines
5.1 KiB
Markdown
Raw Permalink Normal View History

Fixed our README license badge linking to its own icon [ci skip] *facepalm*
2017-11-15 02:44:03 +00:00
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
Add newlines.
2022-07-02 04:17:15 +00:00
A table looks nicer.
2022-07-02 04:24:07 +00:00
|Branch|CI status|
|------|---------|
|Master|[![CI](https://github.com/wesnoth/wesnoth/actions/workflows/ci-main.yml/badge.svg)](https://github.com/wesnoth/wesnoth/actions/workflows/ci-main.yml?query=branch%3Amaster)|
1.18 status in readme.
2024-04-30 03:27:51 +00:00
|1.18|[![CI](https://github.com/wesnoth/wesnoth/actions/workflows/ci-main.yml/badge.svg?branch=1.18)](https://github.com/wesnoth/wesnoth/actions/workflows/ci-main.yml?query=branch%3A1.18)|
Add Travis CI status indicator to README
2016-12-02 05:45:18 +00:00
Make readme heading shorter
2015-05-31 00:12:34 +00:00
About
=====
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Add most bits from #7381.
2023-04-29 06:19:06 +00:00
**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, search for the key to immortality, or take part in any number of other adventures.
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
Community
---------
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
The official Battle for Wesnoth Forums:
<https://forums.wesnoth.org/>
Initial code import. [[The Wesnoth repository started off as CVS in September 2003 on SourceForge. In September 2005 it was converted to Subversion using cvs2svn and hosted at Gna!; the last CVS commit corresponded to Subversion r8374. In March 2013 it was converted to git by ESR using reposurgeon 2.30; the last Subversion commit was r56594. In the process, several small, abandoned experimental branches were removed. For all branches known to have been merged to trunk merge points were found and patched in. Comments have been massaged into git summary + body form; revision references have been lifted to action stamps. Conversion comments are, like this one, enclosed in double square brackets. Typos in change comments have often been quietly fixed. Some abbreviations (notably for mainline campaign names) have been made more uniform than they were in the Subversion comments. Infix "::" to mark a campaign-scenario pair (as in "HttT::12" has sometimes been inserted for clarity and to shorten summary lines. Two branches, website/ and resources/, have been merged to trunk, where their history now appears as that of those two top-level directories rather than as separate branches. Subversion property settings, and the commits in the Subversion history that manipulated them, are almost all gone. A few have been translated to .gitignore files and setting of executable bits. There are a few committers that we have been unable to identify. These are: uso zas uid65860 uid66289 uid67456 uid68698 uid68803 uid68842 uid68850 uid68852 uid69097 uid69206 The uid names seem to have been mechanically generated from Wesnoth forum postings. Committer lines for all of these have been left without a domain name in the email address.]]
2003-09-15 11:52:41 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
Discord:
<https://discord.gg/battleforwesnoth>
readme: Reword the passage about optionally-differently-licensed code... ...per ML feedback
2012-09-08 21:24:54 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
IRC:
<https://wiki.wesnoth.org/Support#IRC>
Update README.md Change Twitter link to Mastodon link
2022-11-29 07:04:39 +00:00
Mastodon:
<https://fosstodon.org/@wesnoth>
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
Steam forums:
<https://steamcommunity.com/app/599390/discussions/>
Initial code import. [[The Wesnoth repository started off as CVS in September 2003 on SourceForge. In September 2005 it was converted to Subversion using cvs2svn and hosted at Gna!; the last CVS commit corresponded to Subversion r8374. In March 2013 it was converted to git by ESR using reposurgeon 2.30; the last Subversion commit was r56594. In the process, several small, abandoned experimental branches were removed. For all branches known to have been merged to trunk merge points were found and patched in. Comments have been massaged into git summary + body form; revision references have been lifted to action stamps. Conversion comments are, like this one, enclosed in double square brackets. Typos in change comments have often been quietly fixed. Some abbreviations (notably for mainline campaign names) have been made more uniform than they were in the Subversion comments. Infix "::" to mark a campaign-scenario pair (as in "HttT::12" has sometimes been inserted for clarity and to shorten summary lines. Two branches, website/ and resources/, have been merged to trunk, where their history now appears as that of those two top-level directories rather than as separate branches. Subversion property settings, and the commits in the Subversion history that manipulated them, are almost all gone. A few have been translated to .gitignore files and setting of executable bits. There are a few committers that we have been unable to identify. These are: uso zas uid65860 uid66289 uid67456 uid68698 uid68803 uid68842 uid68850 uid68852 uid69097 uid69206 The uid names seem to have been mechanically generated from Wesnoth forum postings. Committer lines for all of these have been left without a domain name in the email address.]]
2003-09-15 11:52:41 +00:00
Add most bits from #7381.
2023-04-29 06:19:06 +00:00
Features
--------
Minor grammar fix to bf591e5 [ci skip]
2023-04-29 12:37:20 +00:00
* A variety of different campaigns, each with their own tactical challenges, emotionally charged story, and multiple difficulty levels.
Add most bits from #7381.
2023-04-29 06:19:06 +00:00
* A detailed world and storytelling with hundreds of sprites, animations, and characters.
* Many different unit skills and traits across several factions.
* A map editor with multiple tools, hundreds types of terrain, and the ability for you to save and share maps with others. Create your own scenarios/battles for near infinite replayability.
* Highly moddable, allowing a wide array of community created map packs, eras, and entire campaigns.
* Online and local multiplayer gameplay to play with friends, strangers, or against the AI.
* Changeable settings for base gameplay, with nearly limitless options for different hotkey configurations.
* Beautifully composed playlist that captures the era and grandiosity of this lore-filled high-fantasy world.
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Installing
----------
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
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)
Updated link to android version in README The app has been removed from the play store
2024-07-07 12:02:03 +00:00
Additionally, Wesnoth is available for [iOS](https://apps.apple.com/us/app/battle-for-wesnoth/id575852062) and [Android](https://sourceforge.net/projects/wesnoth-on-android/files/).
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
To build the game from source, see [INSTALL](/INSTALL.md) for instructions.
Contributing
------------
Add most bits from #7381.
2023-04-29 06:19:06 +00:00
Wesnoth is most in need of skilled C++ developers (C++14 and later), however there are things that nearly anyone can help with:
* Simple tasks in C++.
* The Lua and WML used for content scripting.
* Python used by various external tools.
* Even 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 in updating existing unit sprites or creating animations should take a look at the [Art Contributions](https://forums.wesnoth.org/viewforum.php?f=9) forum as well as contact our current art director.
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
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
---------
Add SPI donation link to readme
2023-02-23 03:36:14 +00:00
Donations can be sent via [Software in the Public Interest](https://www.spi-inc.org/projects/wesnoth/), [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.
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
License
-------
Minor README formatting or content fixes [ci skip]
2021-09-25 21:18:57 +00:00
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:
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
<https://wiki.wesnoth.org/Wesnoth:Copyrights>
mention the RSS feed for the frontpage
2011-01-15 12:20:52 +00:00
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
More Information
----------------
update README
2005-09-17 06:50:32 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
For extensive documentation about all aspects of the game, see the official Battle for Wesnoth web site:
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Updated links to wesnoth.org to use https I just changed URLs to the wesnoth.org webpages to use https instead of http. This will make users go directly to the webpages linked, instead of automatically being redirected to the https version by the website. Should be very slightly better for user experience! 😊 Please note: http://manual.wesnoth.org/ redirects to https://wiki.wesnoth.org/WesnothManual, but https://manual.wesnoth.org/ breaks, so I left it unchanged. PS: Thank you for making an awesome game!
2017-04-12 23:30:01 +00:00
<https://www.wesnoth.org/>
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
<https://wiki.wesnoth.org/>
Convert our readme file to Markdown
2015-05-30 22:43:04 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
A (translated) description of how to play the game can be found in doc/manual/manual.*.html, or online at:
Refresh README file language and contents * Added the one-paragraph blurb from the website at the start * Updated forum stats, moved forum information to the very end of the file by following the principle of least importance * Removed Dave's email address, which doesn't serve any useful purpose nowadays * Updated language referring to the game's license to avoid possible confusion about whether the assets' license is strictly GNU GPL v2, or any version of the GNU GPL starting from version 2; also mention that explicit exceptions might exist in specific cases (referring to NaCl-licensed Chromium native client source code, or the MIT-licensed Lua library).
2012-09-07 02:05:14 +00:00
Updates to licensing info and makes a link https.
2017-12-01 07:22:27 +00:00
<https://wiki.wesnoth.org/WesnothManual>
Initial code import. [[The Wesnoth repository started off as CVS in September 2003 on SourceForge. In September 2005 it was converted to Subversion using cvs2svn and hosted at Gna!; the last CVS commit corresponded to Subversion r8374. In March 2013 it was converted to git by ESR using reposurgeon 2.30; the last Subversion commit was r56594. In the process, several small, abandoned experimental branches were removed. For all branches known to have been merged to trunk merge points were found and patched in. Comments have been massaged into git summary + body form; revision references have been lifted to action stamps. Conversion comments are, like this one, enclosed in double square brackets. Typos in change comments have often been quietly fixed. Some abbreviations (notably for mainline campaign names) have been made more uniform than they were in the Subversion comments. Infix "::" to mark a campaign-scenario pair (as in "HttT::12" has sometimes been inserted for clarity and to shorten summary lines. Two branches, website/ and resources/, have been merged to trunk, where their history now appears as that of those two top-level directories rather than as separate branches. Subversion property settings, and the commits in the Subversion history that manipulated them, are almost all gone. A few have been translated to .gitignore files and setting of executable bits. There are a few committers that we have been unable to identify. These are: uso zas uid65860 uid66289 uid67456 uid68698 uid68803 uid68842 uid68850 uid68852 uid69097 uid69206 The uid names seem to have been mechanically generated from Wesnoth forum postings. Committer lines for all of these have been left without a domain name in the email address.]]
2003-09-15 11:52:41 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
For information on creating your own maps, scenarios, and other content, see:
Refresh README file language and contents * Added the one-paragraph blurb from the website at the start * Updated forum stats, moved forum information to the very end of the file by following the principle of least importance * Removed Dave's email address, which doesn't serve any useful purpose nowadays * Updated language referring to the game's license to avoid possible confusion about whether the assets' license is strictly GNU GPL v2, or any version of the GNU GPL starting from version 2; also mention that explicit exceptions might exist in specific cases (referring to NaCl-licensed Chromium native client source code, or the MIT-licensed Lua library).
2012-09-07 02:05:14 +00:00
Expand Wesnoth's README. Supercedes #5843
2021-09-06 02:19:11 +00:00
<https://wiki.wesnoth.org/Create>
Add most bits from #7381.
2023-04-29 06:19:06 +00:00
Gallery
-------
![screenshot_main_menu](https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-1.jpg)
![scrreenshot_isars_cross](https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-2.jpg)
![screenshot_campaign_menu](https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-5.jpg)
![screenshot_map](https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-8.jpg)
Reference in New Issue Copy Permalink