skinnybot/skinny-skeleton

A framework to create discord bot in PHP.

v2.0.0 2019-10-22 22:13 UTC

This package is auto-updated.

Last update: 2020-11-27 01:34:35 UTC


README

Travis Scrutinizer StyleCi Stable Version Downloads License
Build Status Scrutinizer StyleCI Latest Stable Version Total Downloads License

The bot skeleton used for Skinny.

The source code of the bot core can be found here: SkinnyBot/Skinny.

Requirements

Installation

  • composer create-project --prefer-dist skinnybot/skinny-skeleton <application_name>
  • Rename the file config/config.default.php to config/config.php
  • Configure your bot token in the file config/config.php

Run

Command line only : php run.php

Note

The skeleton will install by default the Module Plugin and the Basic Plugin automatically.

Running the bot permanently on a Server

I recommend to use the popular Unitech/pm2 npm package to run your bot. You will need NodeJS and npm installed on your server.

# Using Ubuntu
curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
sudo apt-get install -y nodejs

# Using Debian, as root
curl -sL https://deb.nodesource.com/setup_7.x | bash -
apt-get install -y nodejs


# Then
sudo npm install pm2@latest -g
pm2 start run.php -n "skinny"

More informations on the pm2 package can be found on the Unitech/PM2 repository.

More informations about installing NodeJS can be found here.

Contribute

Follow this guide to contribute