Merge pull request #92 from arcomage/DocsAndGamepad

Docs and gamepad
arcomage · Feb 3, 2025 · 1063af9 · 1063af9
2 parents da0f6d2 + 9387d38
commit 1063af9
Show file tree

Hide file tree

Showing 92 changed files with 1,578 additions and 647 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,9 @@
 {
   "css.customData": [".vscode/css_custom_data.json"],
   "search.exclude": {
-    "**/reducer_auto_all.test.ts": true
+    "**/reducer_auto_all.test.ts": true,
+    "**/yarn.lock": true,
+    "**/plugin-version.cjs": true,
+    "**/yarn-*.cjs": true
   }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,59 +1,61 @@
-# Changelog
+# Changelog for [ArcoMage HD](https://arcomage.github.io/)
 
-_Summary of changes for major & minor releases. For details, click the version number links below to show a compare view containing a list of git commit messages, or look at the issue & PR pages._
+_Summary of changes for major & minor releases. For detailed changes, click the version number links below to view a comparison containing a list of git commit messages, or check the issue & PR pages._
 
-_Go to https://arcomage.github.io/ and press <kbd>Ctrl</kbd> + <kbd>F5</kbd> to clear the cache files & reload the webpage to have the latest version._
+_To ensure you're using the latest version, open the game and press <kbd>Ctrl</kbd> + <kbd>F5</kbd> to clear the cache and reload the webpage._
 
 ## [v1.5.0](https://github.com/arcomage/arcomage-hd/compare/v1.4.0...v1.5.0) (2025-?-?) (in progress)
 
-- Debounced number input ([#81](https://github.com/arcomage/arcomage-hd/issues/81))
-- LTR / Arabic support ([#90](https://github.com/arcomage/arcomage-hd/issues/90))
-- Fix and improve a11y
-- CI update, replace husky git hooks by my own script
+- Full control with mouse, touch device, keyboard, or gamepad 🖱️📱⌨️🎮 ([instructions](gamecontrols.md))
+- [Debounced number input](https://github.com/arcomage/arcomage-hd/issues/81)
+- [LTR / Arabic support](https://github.com/arcomage/arcomage-hd/issues/90)
+- Fixes and improvements to accessibility (a11y)
+- CI update, replaced husky git hooks with custom script
+- Docs update
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2025-01-26..*); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2025-01-26..*))
 
 ## [v1.4.0](https://github.com/arcomage/arcomage-hd/compare/v1.3.0...v1.4.0) ([2025-01-25](https://github.com/arcomage/arcomage-hd/commit/552bf596a98d403310345efe7afc7c067938d489))
 
-- Fix [iOS 13+ long press to discard a card](https://github.com/arcomage/arcomage-hd/issues/74), [landscape notice](https://github.com/arcomage/arcomage-hd/issues/87)
+- Fix for [iOS 13+ long press to discard a card](https://github.com/arcomage/arcomage-hd/issues/74), [landscape notice](https://github.com/arcomage/arcomage-hd/issues/87)
 - [Disable animation](https://github.com/arcomage/arcomage-hd/issues/88), [bold font](https://github.com/arcomage/arcomage-hd/issues/72) options
 - [All cards unusable](https://github.com/arcomage/arcomage-hd/issues/76#issuecomment-2054153524), [victory condition](https://github.com/arcomage/arcomage-hd/issues/81) tooltips
-- Update many dependent libraries (but not all to the latest)
+- Updated many dependent libraries (but not all to the latest versions)
 - [PWA update from network](https://github.com/arcomage/arcomage-hd/issues/68)
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-12-08..2025-01-25); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2021-12-08..2025-01-25))
 
 ## [v1.3.0](https://github.com/arcomage/arcomage-hd/compare/v1.2.0...v1.3.0) ([2021-12-07](https://github.com/arcomage/arcomage-hd/tree/66c90ee521da676275d5c58dd8d1432feedd056e))
 
-- [More visual options](https://github.com/arcomage/arcomage-hd/issues/61)
-- [Stereo audio panning](https://github.com/arcomage/arcomage-hd/issues/64)
+- Added [more visual options](https://github.com/arcomage/arcomage-hd/issues/61)
+- Introduced [stereo audio panning](https://github.com/arcomage/arcomage-hd/issues/64)
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-11-16..2021-12-07); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2021-11-16..2021-12-07))
 
 ## [v1.2.0](https://github.com/arcomage/arcomage-hd/compare/v1.1.0...v1.2.0) ([2021-11-15](https://github.com/arcomage/arcomage-hd/tree/fe7e056e5620b360689d7c782c00612cb3a66e46))
 
-- UX/UI improvement and [bug](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-09-26..2021-11-15+label%3Abug) fixes
-- Update to rxjs 7
-- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) (update, + [uk](https://github.com/arcomage/arcomage-hd/pull/48))
+- UX/UI improvements and [bug](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-09-26..2021-11-15+label%3Abug) fixes
+- Updated to rxjs 7
+- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) improvements (+ [Ukrainian](https://github.com/arcomage/arcomage-hd/pull/48))
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-09-27..2021-11-15); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2021-09-27..2021-11-15))
 
 ## [v1.1.0](https://github.com/arcomage/arcomage-hd/compare/v1.0.0...v1.1.0) ([2021-09-26](https://github.com/arcomage/arcomage-hd/tree/ae1e782771c2db894a4c441eebd441a6d962ff46))
 
-- [AI level](https://github.com/arcomage/arcomage-hd/issues/45)
-- [Pixelation Mode](https://github.com/arcomage/arcomage-hd/issues/44)
-- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) (update, + ja)
+- [AI level](https://github.com/arcomage/arcomage-hd/issues/45) adjustments
+- Added [Pixelation Mode](https://github.com/arcomage/arcomage-hd/issues/44)
+- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) improvements (+ Japanese)
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-07-20..2021-09-26); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2021-07-20..2021-09-26))
 
 ## [v1.0.0](https://github.com/arcomage/arcomage-hd/compare/v1.0.0-beta.1...v1.0.0) ([2021-07-19](https://github.com/arcomage/arcomage-hd/tree/b0300d12aaab51f3c087411b2912906c9fbabe0e))
 
-- Basic features
+- Basic features implemented
 - [Mobile screen adaptation](https://github.com/arcomage/arcomage-hd/issues/1)
-- [PWA](https://github.com/arcomage/arcomage-hd/issues/16)
-- [Manual image](https://github.com/arcomage/arcomage-hd/issues/19)
-- [Multiplayer Mode](https://github.com/arcomage/arcomage-hd/issues/10)
+- [PWA](https://github.com/arcomage/arcomage-hd/issues/16) support
+- Added [manual image](https://github.com/arcomage/arcomage-hd/issues/19)
+- Implemented [multiplayer mode](https://github.com/arcomage/arcomage-hd/issues/10)
 - [Bug](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-04-01..2021-07-19+label%3Abug) fixes
-- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) (update, + cs, es, it, pl, [pt-BR](https://github.com/arcomage/arcomage-hd/pull/36), [ru](https://github.com/arcomage/arcomage-hd/pull/14))
+- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) improvements (+ Czech, Spanish, Italian, Polish, [Brazilian Portuguese](https://github.com/arcomage/arcomage-hd/pull/36), [Russian](https://github.com/arcomage/arcomage-hd/pull/14))
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-04-01..2021-07-19); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A2021-04-01..2021-07-19))
 
 ## v1.0.0-beta.1 ([2021-04-01](https://github.com/arcomage/arcomage-hd/tree/494f4782b456be59753880e2ca9b4aebe805bf0f))
 
 - Very basic unstable version
-- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) (en, fr, de, zh-Hans, zh-Hant)
+- [I18N](https://github.com/arcomage/arcomage-hd/issues/9) (English, French, German, Simplified Chinese, Traditional Chinese)
 - And more ([issue list](https://github.com/arcomage/arcomage-hd/issues?q=is%3Aissue+is%3Aclosed+closed%3A*..2021-04-01); [PR list](https://github.com/arcomage/arcomage-hd/pulls?q=is%3Apr+is%3Aclosed+merged%3A*..2021-04-01))
diff --git a/CREDIT.md b/CREDIT.md
@@ -1,22 +1,22 @@
-# ArcoMage HD's Copyright, Licenses & Credit
+# Copyright, Licenses & Credit for [ArcoMage HD](https://arcomage.github.io/)
 
-The code of **ArcoMage HD**: MIT License (c) 2021 [Tom Chen](https://tomchen.org/). See [§ MIT License](#mit-license).
+The code of **ArcoMage HD**: MIT License (c) [Tom Chen](https://tomchen.org/). See [§ MIT License](#mit-license).
 
-The assets, text, appearance and other copyrightable elements of the game: (c) 2001 The 3DO Company. See [§ 3DO Copyright Notice](#3do-copyright-notice).
+The assets, text, appearance, and other copyrightable elements of the game: (c) 2001 The 3DO Company. See [§ 3DO Copyright Notice](#3do-copyright-notice).
 
 Logos and trademarks of "Arcomage": The 3DO Company in the U.S. and other countries.
 
-The original [Arcomage](https://en.wikipedia.org/wiki/Arcomage) game's assets, text and appearance are copyrighted, the logos and trademarks are held today by either Ubisoft or the defunct 3DO: [Ubisoft](https://en.wikipedia.org/wiki/Ubisoft) purchased [_Might and Magic_](https://en.wikipedia.org/wiki/Might_and_Magic) game series' copyright and trademarks from [The 3DO Company](https://en.wikipedia.org/wiki/The_3DO_Company) when 3DO went bankrupt in 2003, but Ubisoft didn't purchased Arcomage. The 2000 stand-alone game Arcomage is now an [abandonware](https://en.wikipedia.org/wiki/Abandonware), but is still copyrighted. Arcomage did appear as a mini-game in _Might and Magic VII: For Blood and Honor_ and _Might and Magic VIII: Day of the Destroyer_, which are owned by Ubisoft and are still sold actively.
+The original [Arcomage](https://en.wikipedia.org/wiki/Arcomage) game's assets, text, and appearance are copyrighted. The logos and trademarks are currently held by either Ubisoft or the defunct 3DO. [Ubisoft](https://en.wikipedia.org/wiki/Ubisoft) acquired the copyrights and trademarks for the _Might and Magic_ game series from [The 3DO Company](https://en.wikipedia.org/wiki/The_3DO_Company) after 3DO went bankrupt in 2003. However, Ubisoft did not acquire the rights to Arcomage. The 2000 stand-alone game Arcomage is now considered [abandonware](https://en.wikipedia.org/wiki/Abandonware), but it remains copyrighted. Arcomage also appeared as a mini-game in _Might and Magic VII: For Blood and Honor_ and _Might and Magic VIII: Day of the Destroyer_, which are owned by Ubisoft and are still sold actively.
 
-The assets, text and appearance of the game are protected by copyright law, but the gameplay design [may or may not be protected](https://en.wikipedia.org/wiki/Intellectual_property_protection_of_video_games).
+The assets, text, and appearance of the game are protected by copyright law, but the gameplay design [may or may not be protected](https://en.wikipedia.org/wiki/Intellectual_property_protection_of_video_games).
 
-**ArcoMage HD** is not-for-profit. The assets, text, appearance and other copyrightable elements from the original Arcomage game are used within scope of the "[fair use](https://en.wikipedia.org/wiki/Fair_use)" doctrine.
+**ArcoMage HD** is not-for-profit. The assets, text, appearance, and other copyrightable elements from the original Arcomage game are used within the scope of the "[fair use](https://en.wikipedia.org/wiki/Fair_use)" doctrine.
 
-**ArcoMage HD** uses [React.js](https://reactjs.org/), [Redux](https://redux.js.org/), [Redux Observable](https://redux-observable.js.org/) and other free and open-source [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) / [TypeScript](https://www.typescriptlang.org/) libraries. See [§ Copyright Notice of the Dependencies](#copyright-notice-of-the-dependencies).
+**ArcoMage HD** uses [React.js](https://reactjs.org/), [Redux](https://redux.js.org/), [Redux Observable](https://redux-observable.js.org/), and other free and open-source [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) / [TypeScript](https://www.typescriptlang.org/) libraries. See [§ Copyright Notice of the Dependencies](#copyright-notice-of-the-dependencies).
 
 ## MIT License
 
-Copyright (c) 2021 Tom Chen (tomchen.org)
+Copyright (c) Tom Chen (tomchen.org)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -48,16 +48,16 @@ See [dist](https://github.com/arcomage/arcomage.github.io/tree/gh-pages)/\*.js.L
 
 ### SVG Animated Birds
 
-Copyright (c) 2021 Steven Roberts (https://codepen.io/matchboxhero/pen/RLebOY), [MIT License](#mit-license)
+Copyright (c) 2021 Steven Roberts ([CodePen](https://codepen.io/matchboxhero/pen/RLebOY)), [MIT License](#mit-license)
 
 ### Roboto Condensed Font
 
-Copyright (c) Christian Robertson et al. (https://fonts.google.com/specimen/Roboto+Condensed) (https://github.com/googlefonts/roboto)  
+Copyright (c) Christian Robertson et al. ([Google Fonts - Roboto Condensed](https://fonts.google.com/specimen/Roboto+Condensed))  
 Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
-### Alegreya Medium font
+### Alegreya Medium Font
 
-Copyright 2011 The Alegreya Project Authors (https://github.com/huertatipografica/Alegreya)  
+Copyright 2011 The Alegreya Project Authors ([GitHub - Alegreya](https://github.com/huertatipografica/Alegreya))  
 [SIL Open Font License, Version 1.1](https://github.com/huertatipografica/Alegreya/blob/master/LICENSE.md).
 
 ### Other Free License Images
@@ -74,27 +74,27 @@ Copyright 2011 The Alegreya Project Authors (https://github.com/huertatipografic
 - https://www.svgrepo.com/svg/27492/mouse CC0 Public Domain
 - https://www.svgrepo.com/svg/29760/press-button CC0 Public Domain
 
-The animations of the button icons, brick.svg, gem.svg, recruit.svg, the game ending svgs are developed by Tom Chen and licensed under the [MIT license](#mit-license).
+The animations of the button icons, brick.svg, gem.svg, recruit.svg, and the game ending SVGs are developed by Tom Chen and licensed under the [MIT License](#mit-license).
 
-_(\* Uploaded before 15 January 2019, on which day Pixabay changed the license for all uploaded images and videos from CC0 to Pixabay License ([2019-01-14](https://web.archive.org/web/20190114121522/https://pixabay.com/) & [2019-01-15](https://web.archive.org/web/20190115202135/https://pixabay.com/) Pixabay homepage archive), therefore should be considered as being licensed under CC0)_
+_(\* Uploaded before January 15, 2019, when Pixabay changed the license for all uploaded images and videos from CC0 to the Pixabay License ([2019-01-14](https://web.archive.org/web/20190114121522/https://pixabay.com/) & [2019-01-15](https://web.archive.org/web/20190115202135/https://pixabay.com/) Pixabay homepage archive). As such, these assets should be considered as licensed under CC0.)_
 
 ### Erathian Font
 
 Erathian letters' shapes:  
-Copyright (c) New World Computing, Inc., The 3DO Company and Ubisoft Entertainment S.A.  
+Copyright (c) New World Computing, Inc., The 3DO Company, and Ubisoft Entertainment S.A.  
 Proprietary
 
-Erathian font (https://github.com/might-and-magic/erathian-font/):  
+Erathian font ([GitHub - Erathian Font](https://github.com/might-and-magic/erathian-font/)):  
 Copyright (c) 2008-2020 Tom CHEN (tomchen.org)  
 [SIL Open Font License, Version 1.1](https://github.com/might-and-magic/erathian-font/blob/master/OFL.txt).
 
 ## Other Fairly Used Resources
 
 ### GitHub Logos
 
-GitHub Logo Usage: https://github.com/logos
+GitHub Logo Usage: [GitHub Logos](https://github.com/logos)
 
-### Unknown Original Author and/or Unknown License, Fair-use
+### Unknown Original Author and/or Unknown License, Fair-Use
 
 - explosion.png
 - firework.png