Skip to content

Innovative Discord Bot for playing Tic-Tac-Toe ๐ŸŽฎ๐Ÿ…

License

Notifications You must be signed in to change notification settings

dsogo/discord-tictactoe

ย 
ย 

Repository files navigation

Discord TicTacToe logo

An innovative Bot for playing Tic Tac Toe on Discord!
Created with discord.js.

Node.js CI Docker Build status Npm version License

demo

"Discord TicTacToe" is a self-hosted NodeJS bot which allows you to play the popular TicTacToe game on Discord. Invite your friends or play against our robot, a fearsome opponent. Type !ttt to challenge someone else and use reactions to play, so simple! Works out-of-the-box, no configuration needed.

If you have a problem when using the bot, or you want to propose a new feature, feel free to open an issue.

Have fun!

A SaaS-based bot (hosted solution) is under consideration. More info soon!

Installation

Before installing the bot, you need to create your own Discord Application. Then, you can install the bot via Docker or npm (check below!). If you are not a programmer, I recommend you to opt for Docker because its the simplest solution.

The bot works out-of-the-box. Otherwise if you want to configure it, check the file config.example.json in the config folder. Create a file called config.json to change default options.

Running via Docker

  1. Make sure to have Docker installed.
  2. Pull the latest image from DockerHub:
    docker pull utarwyn/discord-tictactoe
  3. Start the Docker container by providing Discord Client ID and Token:
    docker run --name tictactoebot -e CLIENT_ID=YOUR_CLIENT_ID -e TOKEN=YOUR_TOKEN utarwyn/discord-tictactoe
  4. Add -d option to run the bot in the background.
    You can also pass others options with -e OPTION_NAME=option_value.
  5. Use the option -v $(pwd)/config/config.json:/app/config/config.json to load a custom config file.

Use it in your project

  1. Install the project from npm:
    npm install discord-tictactoe or yarn add discord-tictactoe
  2. Use as an independent bot:
    const TicTacToe = require('discord-tictactoe');
    const bot = new TicTacToe({
      clientId: 'YOUR_CLIENT_ID',
      token: 'YOUR_BOT_USER_TOKEN',
      language: 'en',
      command: '!ttt'
    }); 
    bot.connect().catch(() => console.error("Cannot connect TicTacToe bot"));
  3. OR use it in your own bot:
    const TicTacToe = require('discord-tictactoe');
    const Discord = require('discord.js');
    const yourBot = new Discord.Client();
    
    new TicTacToe({
      language: 'fr',
      command: '!ttt'
    }, yourBot);
    
    yourBot.login('YOUR_BOT_TOKEN');

License

"Discord TicTacToe" is open-sourced software licensed under the Apache-2.0 license.


GitHub @utarwyn ย ยทย  Twitter @Utarwyn

About

Innovative Discord Bot for playing Tic-Tac-Toe ๐ŸŽฎ๐Ÿ…

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 93.8%
  • JavaScript 4.8%
  • Dockerfile 1.4%