rwarnking / pdf-games

Collection of mini-games that run in a pdf using latex and javascript
MIT License
0 stars 0 forks source link

PDF games

Build status Linting status of master Version Licence

Description

This is a collection of LaTeX files, that contain some sort of JavaScript allowing for applications or games.

Table of Contents

  1. List of Games
  2. Installation
  3. Usage
  4. Contributing
  5. Credits
  6. License

List of available Games

If you have additional game ideas feel free to mention them as a comment in this issue. For images and more details of the different games, take a look into the wiki of this project.

Installation

If you are only interested in the PDF you can download a zip containing all PDFs from here. To program such a PDF yourself you need this:

  1. install LaTeX e.g. TeX Live
  2. install the insdljs package
    • This package is not necessarily included in the default LaTeX packages and needs to be installed manually
    • Download the acrotex bundle Source1 | Source2
    • Unzip the bundle
    • Use tex acrotex.ins to compile the file and to get the insdljs.sty
    • Check that the files are found by LaTeX e.g. by putting them in the same directory

Alternativly you can use one of the install scripts (bash | powershell) to install all dependencies and the acrotex package automatically.

Dependencies

Mandatory

Mandatory when using template

Optional but recommended

Usage

Simply compile the .tex file to PDF and open the PDF with Adobe Acrobat Reader, other PDF viewer were not tested and may not be able to run the JavaScript.

OBACHT: Different compiler might leed to different outputs for example regarding spacing. The here used compiler was pdfLaTeX with TeX live version 2021. Furthermore you might need to enable the JavaScript even when using Adobe, more information regarding the settings can be found here.

If you have problems compiling it yourself you can try to use the compile.ps1 powershell script.

For more details on the different games and how the program similar projects, take a look into the wiki of this project.

Contributing

I encourage you to contribute to this project, in form of bug reports, feature requests or code additions. Although it is likely that your contribution will not be implemented.

Please check out the contribution guide for guidelines about how to proceed as well as a styleguide.

Credits

Up until now there are no further contributors other than the repository creator.

License

This project is licensed under the MIT License