tools.devnull.boteco.plugins.diceroll.DiceRollPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boteco-plugin-diceroll Show documentation
The newest version!
/*
 * The MIT License
 *
 * Copyright (c) 2016 Marcelo "Ataxexe" Guimarães 
 *
 * Permission  is hereby granted, free of charge, to any person obtaining
 * a  copy  of  this  software  and  associated  documentation files (the
 * "Software"),  to  deal  in the Software without restriction, including
 * without  limitation  the  rights to use, copy, modify, merge, publish,
 * distribute,  sublicense,  and/or  sell  copies of the Software, and to
 * permit  persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * The  above  copyright  notice  and  this  permission  notice  shall be
 * included  in  all  copies  or  substantial  portions  of the Software.
 *
 * THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT  WARRANTY OF ANY KIND,
 * EXPRESS  OR  IMPLIED,  INCLUDING  BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN  NO  EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM,  DAMAGES  OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT  OR  OTHERWISE,  ARISING  FROM,  OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE   OR   THE   USE   OR   OTHER   DEALINGS  IN  THE  SOFTWARE.
 */

package tools.devnull.boteco.plugins.diceroll;

import tools.devnull.boteco.plugin.Command;
import tools.devnull.boteco.plugin.Plugin;

import java.util.Collections;
import java.util.List;

import static tools.devnull.boteco.plugin.Command.command;

public class DiceRollPlugin implements Plugin {

  public static final String ID = "dice-roll";

  @Override
  public String id() {
    return ID;
  }

  @Override
  public String description() {
    return "Rolls dices and outputs the result";
  }

  @Override
  public List availableCommands() {
    return Collections.singletonList(
        command("roll")
            .with("nds")
            .does("Rolls the given dices and outputs the result. 'n' is the number of dices and 's' is the " +
                "number of sides. Use '+' to roll more dices with different sides.")
    );
  }

}