Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
182 lines (106 sloc) 5.38 KB

Configuration

Using hastebin, Glyph makes it easy to set a custom configuration on your server.

Setting a configuration

  1. Say to Glyph "view config"
  2. Open the given hastebin url and click Duplicate & Edit
  3. Edit the configuration, which is in the YAML format, and then click Save
  4. Copy the new url and say to Glyph "load config (url)"
  5. Glyph will now attempt to load the configuration and if any errors are found, provide a message pointing to what needs to be fixed

Note

If the configuration has an error, Glyph will fallback to using the previous error-free configuration. Additionally, if Glyph is removed from the server, the servers configuration will be deleted from the database.

Default Configuration

.. literalinclude:: default.yml

Any new options added to the configuration will automatically show up next time you view the config to edit it.

Example Configuration

.. literalinclude:: example.yml


Options

Wiki

Here is where the default Wikia wiki for Glyph to use when searching is specified. However, Wikipedia can be used instead if set to wikipedia.

.. attribute:: wiki

  .. attribute:: sources

    The Wikia_ wikis to use for searches, the spelling is taken from the url. For example, the Mass Effect wiki is :code:`masseffect` because it is **masseffect**.wikia.com

    **Value:** *array of strings* - The Wikia wiki names or Wikipedia

  .. attribute:: minimumQuality

    The minimum article quality (as seen by the Wikia API) to allow when searching a wiki and returning a page.

    **Value:** *integer* - A number between 0 and 100 (inclusive)

Roles

Glyph can give people cosmetic roles, typically for roleplay and such. These allowed roles must be set in the configuration and the Glyph role placed above them so that he may set them.

.. attribute:: selectableRoles

  .. attribute:: roles

    List of allowed roles for people to be asked to be set as.

    **Value:** *array of strings* - The names of the selectable roles

  .. attribute:: limit

    The maximum number of roles people can have.
    **-1** means infinite, **1** means automatically replace old one with new one, and
    **any other positive number** means the cap is that many roles and the user will need to remove ones they no longer want.

    **Value:** *integer* - The maximum number of selectable roles someone can have

QuickView

.. attribute:: quickview

  Control the appearance of QuickViews

  .. attribute:: furaffinityEnabled

    Whether or not QuickView embeds will be made when a link for a FurAffinity artwork is posted.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: furaffinityThumbnail

    Whether or not QuickView embeds will have thumbnails of the artwork.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: picartoEnabled

    Whether or not QuickView embeds will be made when a link for a Picarto stream is posted.

    **Value:** *boolean* - :code:`true` or :code:`false`

Auditing

.. attribute:: auditing

  While the new Discord auditing feature is nice, it misses out on some important information.

  .. attribute:: joins

    Whether or not to log member joins.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: leaves

    Whether or not to log member leaves.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: purge

    Whether or not to log when the purge skill is used.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: kicks

    Whether or not to log when the kick skill is used.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: bans

    Whether or not to log when the ban skill is used.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: names

    Whether or not to log when a user changes their username (not to be confused with nicknames).

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: webhook

    The webhook to post audit logs to.
    (Go to the channel you want logs in, and Create Webhook, and copy the URL.)

    **Value:** *url* - The URL of the webhook to send audits to

Starboard

.. attribute:: starboard

  Ever wanted to allow everyone pin messages and have them show up in another channel to be remembered forever? That's starboarding!

  .. attribute:: enabled

    Whether or not to allow starboarding.

    **Value:** *boolean* - :code:`true` or :code:`false`

  .. attribute:: webhook

    The webhook to post starred messages to.
    (Go to the channel you want logs in, and Create Webhook, and copy the URL.)

    **Value:** *url* - The URL of the webhook to send starred messages to

  .. attribute:: emoji

    The name of the emoji to look for, can be a standard or custom emoji.

    **Value:** *string* - The exact name of the emoji

  .. attribute:: threshold

    The minimum number of stars a message needs before it is sent to the starboard.

    **Value:** *integer* - A number greater than or equal to 1

  .. attribute:: allowSelfStarring

    Whether or not to allow self starring (adding stars to your own messages to send them to the starboard).
    :code:`Manage Messages` permission is need to remove self-stars.

    **Value:** *boolean* - :code:`true` or :code:`false`