Help language development. Donate to The Perl Foundation

antlia cpan:ANDINUS last updated on 2021-05-01

README.org
#+title: Antlia
#+subtitle: Antlia is a text based Rock paper scissors game
#+export_file_name: index
#+setupfile: ~/.emacs.d/org-templates/projects.org

| Website         | https://andinus.nand.sh/antlia             |
| Source          | https://git.tilde.institute/andinus/antlia |
| GitHub (mirror) | https://github.com/andinus/antlia          |

* Demo

This was recorded with ~asciinema~.

[[https://asciinema.org/a/410736][https://asciinema.org/a/410736.png]]

+ Antlia v0.1.0: https://asciinema.org/a/410736

* Installation

Antlia is released to CPAN, you can get it from there or install it from
source. In any case, ~zef~ is required to install the distribution.

You can run Antlia without ~zef~. Just run ~raku -Ilib bin/antlia~ from
within the source directory.

** Release

1. Run ~zef install antlia~.

Antlia should be installed, try running ~antlia --version~ to confirm.

** From Source

You can either download the release archive generated by cgit/GitHub or
clone the project if you have ~git~ installed.

*** Without ~git~

1. Download the release:
   - https://git.tilde.institute/andinus/antlia
   - https://github.com/andinus/antlia/releases
2. Extract the file.
3. Run ~zef install .~ in source directory.

*** With ~git~

All commits will be signed by my [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]].

#+begin_src sh
# Clone the project.
git clone https://git.tilde.institute/andinus/antlia
cd antlia

# Install octans.
zef install .
#+end_src

* Documentation

** Implementation

Just enter the player names & it'll print each throw along with scores.
Press enter to play another round.

** Options

*** players

Number of players. Default is 2, should be an integer equal to or
greater than 2.

* News

** v0.1.1 - 2021-05-01

+ Added support for more than 2 players.
+ Prints a scorecard after the last round.

** v0.1.0 - 2021-04-29

Initial Implementation