diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/wargame/README.md')
| -rw-r--r-- | Master/texmf-dist/doc/latex/wargame/README.md | 97 |
1 files changed, 63 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/wargame/README.md b/Master/texmf-dist/doc/latex/wargame/README.md index 70eb286498e..ff9ade87f40 100644 --- a/Master/texmf-dist/doc/latex/wargame/README.md +++ b/Master/texmf-dist/doc/latex/wargame/README.md @@ -1,6 +1,6 @@ # A package to make Hex'n'Counter wargames in LaTeX -## Version 0.6 +## Version 0.8 This package can help make classic [Hex'n'Counter wargames](https://en.wikipedia.org/wiki/Wargame) using LaTeX. The @@ -28,32 +28,43 @@ one will need for a game (rules, charts, boards, counter sheets). The sources of the package are kept at [GitLab](https://gitlab.com/wargames_tex/wargame_tex) -## Download from GitLab +## Downloads available at 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) +- [Documentation](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/doc/latex/wargame/wargame.pdf?job=dist) +- [Tutorial](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/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)) + [module](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/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) + symbols](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/doc/latex/wargame/symbols.pdf?job=dist) +- [Compatibility](https://gitlab.com/wargames_tex/wargame_tex/-/jobs/artifacts/master/file/doc/latex/wargame/compat.pdf?job=dist) + +## Installation + +The instructions below are geared towards Un\*x-like systems, for +example GNU/Linux and MacOSX. For more information on setting the +prerequisites and this package on various platforms, please see [this +page](https://wargames_tex.gitlab.io/wargame_www/build.html). + +### From ZIP file 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) + (cd ~/texmf && unzip ../wargame_tex.zip) -on Un\*x like systems. +### From git clone If you clone from GitLab -(`git clone https://gitlab.com/wargames_tex/wargame_tex.git`) to get the -sources, then you can do + + git clone https://gitlab.com/wargames_tex/wargame_tex.git + +to get the sources, then you can do, cd wargame make install @@ -78,6 +89,10 @@ and unpack that into your desired destination, e.g., `~/texmf` unzip wargame.tds.zip -d ~/texmf +or + + sudo unzip wargame.tds.zip -d /usr/local/share/texmf + ### From sources If you get the source (`wargame.ins`, all `.dtx`,`.py`, and `Makefile`) @@ -111,12 +126,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 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/ + 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 @@ -135,8 +150,8 @@ You can install these into your TeX tree with (e.g., `~/texmf/`) mkdir -p ~/texmf/doc/latex/wargame/ cp wargame.pdf ~/texmf/doc/latex/wargame/ - cp symbols.py ~/texmf/doc/latex/wargame/ - cp compat.py ~/texmf/doc/latex/wargame/ + cp symbols.pdf ~/texmf/doc/latex/wargame/ + cp compat.pdf ~/texmf/doc/latex/wargame/ If you want to generate the tutorial document, do @@ -160,7 +175,7 @@ If you also want to make the tutorial VASSAL module, do (also in Note, you need `pdfinfo` and `pdftocairo` from Poppler, and Python with -the module `PIL` for this. On Debian based systems, do +the module `PIL` for this. On Debian-based systems, do sudo apt install poppler-utils python3-pil @@ -171,12 +186,23 @@ for more ([here](https://ctan.org/tex-archive/macros/latex/contrib/wargame/doc/tutorial/) if you browse from CTAN). -## Examples +Another simple example to get you started is the game +[Tannenberg4](https://gitlab.com/wargames_tex/advancedguard_tex) also +available from GitLab. -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 -goes to the original authors of these games. +## Examples +Below are some print'n'play board wargames made with this package. See +also [LaTeX Wargames](https://wargames_tex.gitlab.io/wargame_www/) for +more. These are not original games but rather revamps of existing games. +All credits goes to the original authors of these games. + +- American Civil War + - [Smithsonian + Gettysberg](https://gitlab.com/wargames_tex/sgb_tex) (Avalon + Hill) +- WWI + - [Tannenberg4](https://gitlab.com/wargames_tex/advancedguard_tex) - WWII - Eastern Front - [Battle for Moscow](https://gitlab.com/wargames_tex/bfm_tex) @@ -187,10 +213,11 @@ goes to the original authors of these games. - [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 - D-Day](https://gitlab.com/wargames_tex/pkdday_tex) + - [Smithsonian Battle of the + Bulge](https://gitlab.com/wargames_tex/sbotb_tex) (Avalon + Hill) + - [The Drive on Metz](https://gitlab.com/wargames_tex/dom_tex) + (from *The Complete Wargames Handbook*) - Pacific theatre - [First Blood](https://gitlab.com/wargames_tex/firstblood_tex) @@ -205,6 +232,8 @@ goes to the original authors of these games. (Avalon Hill classic) - [Port Stanley](https://gitlab.com/wargames_tex/portstanley_tex) (from the *Wargamer* magazine) +- Abstract + - [Battle](https://gitlab.com/wargames_tex/battle_tex) ## VASSAL support @@ -287,16 +316,16 @@ form of expression. One *cannot* copyright ideas, only their expression in so far as it is *artistic* (i.e., not a trivial expression that anyone knowledgeable within the field can do with rudimentary effort). -So you *can not* copyright your game mechanics, for example, only how -you described them. You *can not* copyright a title (but you may be able -to claim trademark on it). You *can* copyright the wording of the rules, -the graphics that you use, and so on. +This means you *can not* copyright your game mechanics, for example, +only how you described them. You *can not* copyright a title (but you +may be able to claim trademark on it). You *can* copyright the wording +of the rules, the graphics that you use, and so on. This also means, that you are essentially free to make your own version of previously published game, *as long as* -- you do not copy existing text -- you do not copy existing graphics +- you do not copy existing text, +- you do not copy existing graphics, and - you respect any kind of trademark claims However, it is advisable to contact the copyright holders of the |