diff options
Diffstat (limited to 'macros/latex/contrib/wargame/README.md')
-rw-r--r-- | macros/latex/contrib/wargame/README.md | 175 |
1 files changed, 107 insertions, 68 deletions
diff --git a/macros/latex/contrib/wargame/README.md b/macros/latex/contrib/wargame/README.md index a66da25247..000f3cd68b 100644 --- a/macros/latex/contrib/wargame/README.md +++ b/macros/latex/contrib/wargame/README.md @@ -1,6 +1,8 @@ -# A package to make Hex'n'Counter wargames in LaTeX +A package to make Hex'n'Counter wargames in LaTeX +================================================= -## Version 0.2.1 +Version 0.3.2 +------------- This package can help make classic [Hex'n'Counter wargames](https://en.wikipedia.org/wiki/Wargame) using LaTeX. The @@ -23,12 +25,50 @@ 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) -## CTAN +Download from GitLab +-------------------- + +- [Zip file of package and support + files](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/download?job=dist) +- [Browse content of + package](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/browse?job=dist) +- [Documentation](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/wargame.pdf?job=dist) +- [Tutorial](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/tutorial.pdf?job=dist) + (and associated VASSAL + [module](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/Game.vmod?job=dist)) +- [Table of + symbols](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/symbols.pdf?job=dist) +- [Compatibility](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/compat.pdf?job=dist) + +To install, get the ([zip +file](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/download?job=dist)) +and unzip into your TeX tree, for example + + mkdir -p ~/texmf + (cd ~/texmf && unzip ../artifacts.zip) + +on Un\*x like systems. + +If you clone from GitLab +(`git clone https://gitlab.com/wargames_tex/wargame_tex.git`) to get the +sources, then you can do + + cd wargame + make install + +to install in `~/texmf`. If you prefer another destination, say +`/usr/local/share/texmf`, do + + make install DESTDIR=/usr/local/share/texmf + +Download from CTAN +------------------ The package is available from [CTAN](https://ctan.org/tex-archive/macros/latex/contrib/wargame) in the @@ -36,19 +76,40 @@ 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)). -If you get the sources (`wargame.ins`, all `.dtx` and `.py`) files, then -to install do +### From TDS zip archive + +You can get the *TDS* [zip +file](https://mirrors.ctan.org/install/macros/latex/contrib/wargame.tds.zip) +and unpack that into your desired destination, e.g., `~/texmf` + + unzip wargame.tds.zip -d ~/texmf + +### From sources + +If you get the source (`wargame.ins`, all `.dtx`,`.py`, and `Makefile`) +files, then do + + make install + +to install into `~/texmf`. If you prefer to install somewhere else, say +`/usr/local/share/texmf`, then do + + make install DESTDIR=/usr/local/share/texmf + +If you do not have `make` (or `gmake` on MacOSX), or because you are on +some system which does not have that tool (e.g., Windows), then do (the +equivalent of) latex wargame.ins - pdflatex beach - pdflatex city - pdflatex light_woods - pdflatex mountains - pdflatex rough - pdflatex swamp - pdflatex town - pdflatex village - pdflatex woods + pdflatex wargame.beach + pdflatex wargame.city + pdflatex wargame.light_woods + pdflatex wargame.mountains + pdflatex wargame.rough + pdflatex wargame.swamp + pdflatex wargame.town + pdflatex wargame.village + pdflatex wargame.woods (You need to use `pdflatex`, `xelatex`, or `lualatex` - plain `latex` with DVI output will not work) @@ -56,19 +117,12 @@ with DVI output will not work) Then copy the relevant files to your TeX tree (e.g., `~/texmf/`) as mkdir ~/texmf/tex/latex/wargame - cp tikzlibrary*.tex ~/texmf/tex/latex/wargame/ - cp wargame.sty ~/texmf/tex/latex/wargame/ - cp wgexpor.sty ~/texmf/tex/latex/wargame/ - cp city.pdf ~/texmf/tex/latex/wargame/ - cp light_woods.pdf ~/texmf/tex/latex/wargame/ - cp mountains.pdf ~/texmf/tex/latex/wargame/ - cp rough.pdf ~/texmf/tex/latex/wargame/ - cp swamp.pdf ~/texmf/tex/latex/wargame/ - cp town.pdf ~/texmf/tex/latex/wargame/ - cp village.pdf ~/texmf/tex/latex/wargame/ - cp woods.pdf ~/texmf/tex/latex/wargame/ - cp export.py ~/texmf/tex/latex/wargame/ - cp svg2tikz.py ~/texmf/tex/latex/wargame/ + cp tikzlibrary*.tex ~/texmf/tex/latex/wargame/ + cp wargame.sty ~/texmf/tex/latex/wargame/ + cp wgexport.cls ~/texmf/tex/latex/wargame/ + cp wargame.*.pdf ~/texmf/tex/latex/wargame/ + cp wgexport.py ~/texmf/tex/latex/wargame/ + cp wgsvg2tikz.py ~/texmf/tex/latex/wargame/ To generate the documentation, after having done the above, do @@ -92,6 +146,11 @@ You can install these into your TeX tree with (e.g., `~/texmf/`) If you want to generate the tutorial document, do + cd tutorial + make + +or + cd tutorial pdflatex game pdflatex game @@ -100,42 +159,27 @@ If you also want to make the tutorial VASSAL module, do (also in `tutorial`), do pdflatex export.tex - ../export.py export.pdf export.json -o Game.vmod \ + ../wgexport.py export.pdf export.json -o Game.vmod \ -d "Example module from LaTeX PnP game" \ -t "LaTeX wargame tutorial" -v 0.1 \ -p patch.py + -## Download from GitLab - -- [Zip file of package and support - files](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/download?job=dist) -- [Browse content of - package](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/browse?job=dist) -- [Documentation](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/wargame.pdf?job=dist) -- [Tutorial](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/tutorial.pdf?job=dist) - (and associated VASSAL - [module](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/Game.vmod?job=dist)) -- [Table of - symbols](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/symbols.pdf?job=dist) -- [Compatibility](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/public/doc/latex/wargame/compat.pdf?job=dist) - -To install, get the ([zip -file](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/download?job=dist)) -and unzip into your TeX tree, for example +Note, you need `pdfinfo` and `pdftocairo` from Poppler, and Python with +the module `PIL` for this. On Debian based systems, do - mkdir -p ~/texmf - (cd ~/texmf && unzip ../artifacts.zip) - -on Un\*x like systems. + 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 @@ -144,11 +188,7 @@ goes to the original authors of these games. - WWII - Eastern Front - [Battle for Moscow](https://gitlab.com/wargames_tex/bfm_tex) - - [Hell's Gate](https://gitlab.com/wargames_tex/hellsgate_tex) - (private) - - [Unternehmung - 25](https://gitlab.com/wargames_tex/unternehmung_tex) - (private) + (classic introductory game) - Western Front - [D-Day](https://gitlab.com/wargames_tex/dday_tex) (Avalon Hill classic) @@ -160,25 +200,22 @@ goes to the original authors of these games. - [First Blood](https://gitlab.com/wargames_tex/firstblood_tex) (Avalon Hill International Kriegspiel Association classic) - - [Malaya](https://gitlab.com/wargames_tex/malaya_tex) - (private) - Africa - [Afrika Korps](https://gitlab.com/wargames_tex/afrikakorps_tex) (Avalon Hill classic) - - [Battles of El - Alamein](https://gitlab.com/wargames_tex/boel_tex) (private) - Modern/Speculative - [Strike Force One](https://gitlab.com/wargames_tex/sfo_tex) - [Kriegspiel](https://gitlab.com/wargames_tex/kriegspiel_tex) (Avalon Hill classic) -## VASSAL support +VASSAL support +-------------- -The packages has the script [`export.py`](utils/export.py) to generate a -draft [VASSAL](https://vassalengine.org) module from the defined charts, -boards, counters, OOBs, and so on. More about this is given in the -documentation. +The packages has the script [`wgexport.py`](utils/wgexport.py) to +generate a draft [VASSAL](https://vassalengine.org) module from the +defined charts, boards, counters, OOBs, and so on. More about this is +given in the documentation. The script will generate a first draft of a module, which then can be edited in the VASSAL editor for the final thing. @@ -194,7 +231,8 @@ 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 +NATO App6 +--------- The package supports @@ -219,7 +257,8 @@ 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 |