What is discord-battleship?

Discord-BattleShip is meant to create and handle an advanced version of the classic board game, Battle Ship, in your very own Discord.js Bots! An example bot using this package can be found here.

Table of Contents

1. What is discord-battleship
2. Table of Contents
3. Installation
4. Getting Started
5. Documentation

Installation

npm install discord-battleship

Getting Started

Make sure you have installed the latest stable version of Node.js

Using CommonJS

const { Client } = require("discord.js");
const client = new Client();
const { DiscordBattleShip } = require("discord-battleship");

const BattleShip = new DiscordBattleShip({
    embedColor: "RED", /* Any Discord.js Color Resolvable will work. */
    prefix: "?", /* This is the prefix that will be used in the users DM's for commands. 
                    You can set this to any string. */
});

client.on("ready", () => console.log("Ready!"));

client.on("message", async (message) => {
    if (message.content.toLowerCase().includes("?battleship"))
        await BattleShip.createGame(message);
});

client.login("TOKEN");

Using Modules

import { Client } from "discord.js";
const client = new Client();
import { DiscordBattleShip } from "discord-battleship";

const BattleShip = new DiscordBattleShip({
    embedColor: "RED", /* Any Discord.js Color Resolvable will work. */
    prefix: "?", /* This is the prefix that will be used in the users DM's for commands. 
                    You can set this to any string. */
});

client.on("ready", () => console.log("Ready!"));

client.on("message", async (message) => {
    if (message.content.toLowerCase().includes("?battleship"))
        await BattleShip.createGame(message);
});

client.login("TOKEN");

Documentation

Class Options

options.embedColor: ColorResolvable

new DiscordBattleShip({ embedColor: "YELLOW" }) // Any hex value will work aswell.

Any valid Discord.js ColorResolvable is a valid option for this parameter. This option is the color for any embed sent by DiscordBattleShip.

options.prefix: string

new DiscordBattleShip({ prefix: "?" });

Any valid string is a valid option for this parameter. This option will be the prefix that the package will use in the DM's of users for adding boats, attacking, etc. This could be your custom server prefix, or some hard coded value.

Methods

createGame(message: Message): Promise<Message>

client.on("message", async (message) => {
    if (message.content.toLowerCase().includes("!battleship"))
        await BattleShip.createGame(message);
});

To create, handle and finish a new battleship game, call the createGame() method. This method only accepts one parameter, which is the message object. This is also the only method in the package. This method will handle the creation of the game, DMing users, updating each board, attacking the opponent, win states and more. This is all you need to know to create a new game of battle ship!

If you encounter bugs or would like to make suggestions you can do so here, or contact me dirrectly on Discord at That Duck Max#8153.