Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (45 loc) · 2.82 KB

README.md

File metadata and controls

60 lines (45 loc) · 2.82 KB
Raw

Uno Module

Build Status Scrutinizer Code Quality Latest Stable Version Latest Unstable Version Total Downloads

Play UNO in IRC. Includes an automated bot player and points system.

System Requirements

If your setup can run the main bot, it can run this module as well.

Installation

To install this module, we will use composer:

composer require wildphp/module-uno

That will install all required files for the module. In order to activate the module, add the following line to your modules array in config.neon:

- WildPHP\Modules\Uno\Uno

The bot will run the module the next time it is started.

Usage

For the rules of UNO, please refer to the UNO rules. This is the set of rules this module tries to follow. This module adjusts the following rules:

  • Only 1 card can be drawn per turn.
  • Action cards do not take effect when they are the first card.
  • The module yells UNO automatically.

Use newgame to open a game in a channel, then use start to start playing after all players have joined. You must have the newgame permission to start and stop games.

While running, the following commands are available:

  • play [card]
    • Alias: pl
  • draw - Draw a card if you do not have valid moves. Can only draw 1 card per turn.
    • Alias: dr
  • pass - Pass the current turn if you do not have valid moves.
    • Alias: pa or ps
  • validmoves - Show available valid moves for the current top card.
    • Alias: vm
  • cards - Show your cards.
  • color - Change the current color - only when allowed to do so.
    • Alias: c
  • unorules - Shows a basic list of rules and principles.
  • unohs - Show the high scores for UNO.
  • botenter - Add the automatic bot player to an open game.
  • togglecolors - Toggle card colors in personal messages for the participant sending the command.
  • stop - Stop the current game.

If a participant's turn is up, but he or she does not interact with the game within 2 minutes, the automatic bot player will take over the turn.

It is possible to run multiple games at once, however you can only run 1 game per channel.

License

This module is licensed under the GNU General Public License, version 3. Please see LICENSE to read it.