PHPackages                             discodian/discodian - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. discodian/discodian

ActiveProject[Utility & Helpers](/categories/utility)

discodian/discodian
===================

The Discord bot toolkit for modern php

0.1.0-beta.2(8y ago)11142[9 issues](https://github.com/discodian/discodian/issues)MITPHP

Since Dec 18Pushed 8y ago5 watchersCompare

[ Source](https://github.com/discodian/discodian)[ Packagist](https://packagist.org/packages/discodian/discodian)[ RSS](/packages/discodian-discodian/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (1)Versions (4)Used By (0)

[![Packagist](https://camo.githubusercontent.com/e7cc07cac4284b12fc29eceaa02ba29845d2d9465008441205d7a4b50ea363e3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646973636f6469616e2f646973636f6469616e2e737667)](https://packagist.org/packages/discodian/discodian)[![Packagist](https://camo.githubusercontent.com/88de37324c5a01e905f89958a645229e5c752245771aeaace4d6e1a216996432/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646973636f6469616e2f636f72652e737667)](https://packagist.org/packages/discodian/core)[![Packagist](https://camo.githubusercontent.com/869fc934dfc5239f033ac07ea90d0037d22c6a558bed68d65144c328366b3663/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646973636f6469616e2f646973636f6469616e2e737667)](https://packagist.org/packages/discodian/discodian)[![Join our Discord server](https://camo.githubusercontent.com/cf224e9a5baa16d5cc5f585b2b2ae4eb818602d0137e994cb3739f6613b14faa/68747470733a2f2f646973636f72646170702e636f6d2f6170692f6775696c64732f3338303639373938333130323232323334352f656d6265642e706e67)](https://discord.gg/erybZg6)

Discodian
=========

[](#discodian)

*Discodian (Discord Custodian), the extensible php toolkit to create your own Discord bot.*

> Please note [sharding is not yet supported](https://github.com/discodian/discodian/issues/2).

Requirements
------------

[](#requirements)

- PHP 7.1 or up.
- Some knowledge about [composer](http://getcomposer.org).

Installation
------------

[](#installation)

```
composer create-project discodian/discodian
```

Configuration
-------------

[](#configuration)

Make sure to get a bot token from the [developer portal](https://discordapp.com/developers/applications/me).

- New App.
- Under section "Bot" click "Create a Bot User".
- Under section "Bot" click "click to reveal" next to Token. This is the bot token.
- Feel free to configure the bot to your liking.

Copy `.env.example` to `.env` if it doesn't exist yet and add any necessary configuration settings.

Run
---

[](#run)

Fire up the bot using the following command:

```
php discodian
```

Possibly you'd like to have your bot run in production permanently. The easiest way to do so is using [supervisor](http://supervisord.org/index.html). Here's an example config you can use (assuming your bot is installed in `/home/bot`:

```
[program:your-bot]
process_name=%(program_name)s
command=php /home/bot/discodian
autostart=true
autorestart=true
user=bot
numprocs=1
redirect_stderr=true
stdout_logfile=/home/bot/bot.log

```

Extensions
----------

[](#extensions)

Create a composer-based package and make sure you use type "discodian-extension" in the composer.json definition. Here's an excerpt to give an indication;

```
{
    "name": "github-username/discodian-amazing-extension",
    "description": "Kick ass awesome extension for Discodian",
    "type": "discodian-extension"
}
```

In the root path of your package create a file `bootstrap.php`, you can use this file to hook into the Discodian ecosystem.

```