summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/wargame/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/wargame/README.md')
-rw-r--r--macros/latex/contrib/wargame/README.md49
1 files changed, 25 insertions, 24 deletions
diff --git a/macros/latex/contrib/wargame/README.md b/macros/latex/contrib/wargame/README.md
index 000f3cd68b..3de32ab4d0 100644
--- a/macros/latex/contrib/wargame/README.md
+++ b/macros/latex/contrib/wargame/README.md
@@ -1,8 +1,6 @@
-A package to make Hex'n'Counter wargames in LaTeX
-=================================================
+# A package to make Hex'n'Counter wargames in LaTeX
-Version 0.3.2
--------------
+## Version 0.5
This package can help make classic [Hex'n'Counter
wargames](https://en.wikipedia.org/wiki/Wargame) using LaTeX. The
@@ -25,14 +23,12 @@ one will need for a game (rules, charts, boards, counter sheets).
- The package support exporting the game to a
[VASSAL](#vassal-support%20'Section%20below') module
-Sources
--------
+## Sources
The sources of the package are kept at
[GitLab](https://gitlab.com/wargames_tex/wargame_tex)
-Download from GitLab
---------------------
+## Download from GitLab
- [Zip file of package and support
files](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/download?job=dist)
@@ -67,14 +63,12 @@ to install in `~/texmf`. If you prefer another destination, say
make install DESTDIR=/usr/local/share/texmf
-Download from CTAN
-------------------
+## Download from CTAN
The package is available from
[CTAN](https://ctan.org/tex-archive/macros/latex/contrib/wargame) in the
-directory `/macros/latex/contrib/wargame`. As of this writing, the
-package has not hit any of the major distributions (e.g.,
-[TeXLive](https://tug.org/texlive/index.html)).
+directory `/macros/latex/contrib/wargame`. The package is part of the
+CTAN distribution [TeXLive](https://tug.org/texlive/index.html).
### From TDS zip archive
@@ -170,16 +164,14 @@ the module `PIL` for this. On Debian based systems, do
sudo apt install poppler-utils python3-pil
-Tutorial
---------
+## Tutorial
See the [tutorial](tutorial/README.md "Link works on GitLab only") page
for more
([here](https://ctan.org/tex-archive/macros/latex/contrib/wargame/doc/tutorial/)
if you browse from CTAN).
-Examples
---------
+## Examples
Below are some print'n'play board wargames made with this package. These
are not original games but rather revamps of existing games. All credits
@@ -192,6 +184,9 @@ goes to the original authors of these games.
- Western Front
- [D-Day](https://gitlab.com/wargames_tex/dday_tex) (Avalon
Hill classic)
+ - [Smithsonian
+ D-Day](https://gitlab.com/wargames_tex/sdday_tex) (Avalon
+ Hill)
- [Paul Koenig's Market
Garden](https://gitlab.com/wargames_tex/pkmg_tex)
- [Paul Koenig's
@@ -208,9 +203,10 @@ goes to the original authors of these games.
- [Strike Force One](https://gitlab.com/wargames_tex/sfo_tex)
- [Kriegspiel](https://gitlab.com/wargames_tex/kriegspiel_tex)
(Avalon Hill classic)
+ - [Port Stanley](https://gitlab.com/wargames_tex/portstanley_tex)
+ (from the *Wargamer* magazine)
-VASSAL support
---------------
+## VASSAL support
The packages has the script [`wgexport.py`](utils/wgexport.py) to
generate a draft [VASSAL](https://vassalengine.org) module from the
@@ -231,8 +227,14 @@ An example of this is given in the [Battle for
Moscow](https://gitlab.com/wargames_tex/bfm_tex) project, and of course
in the [tutorial](tutorial/ "Link works on GitLab only")
-NATO App6
----------
+The sources of this script is kept in a different project
+[`pywargame`](https://gitlab.com/wargames_tex/pywargame) also on GitLab.
+The script is generated in that package. The `pywargame` package allows
+one to manipulate VASSAL modules from Python, or to read (and convert)
+[CyberBoard](http://cyberboard.norsesoft.com/)
+([GitHub](https://github.com/CyberBoardPBEM/cbwindows)) scenarios.
+
+## NATO App6
The package supports
@@ -257,8 +259,7 @@ standard.
- Other LaTeX package for making NATO symbology
[XMilSymb](https://github.com/ralphieraccoon/MilSymb)
-Copyright and license
----------------------
+## Copyright and license
(c) 2022 Christian Holm Christensen
@@ -277,7 +278,7 @@ you generate using the package is *not* required to be licensed
according to the *ShareAlike* clause of CC-BY-SA-4.0. That is, you can
license your materials *any way you want*.
-However, that copyright rights on games is not as prohibitive as you may
+However, copyright rights on games is not as prohibitive as you may
think (see [this thread on
BGG](https://boardgamegeek.com/thread/493249/)). What you *can*
copyright is original, artistic expression. That is, the copyrighted