Welcome to the X-Ample Development Documentation! [UNDER CONSTRUCTION]

Introduction

X-Ample Development

Let's start building a quick, easy, and awesome dashboard in 5 minutes!

Quickstart

Options

Form Types

Welcome to the documentation of the NPM Discord-Dashboard v2 module.

Client

Domain

Port

Settings

Dashboard Settings

Redirect URL

Theme

Automatically accept the privacy policy for the Dashboard without having to give consent in the console.

Accept Privacy Policy

Do not create and don't listen an express http/-s server for Dashboard.

Don't Create Server

Use a modified version of the save system to save all settings at once, rather than save each option individually.

Efficient Saving System

Invite Endpoint

Automatically add a user to your Discord Server where the bot is when they log into the Dashboard.

Join Guild After Authorization

If you want to restrict console logs through Assistants Center, you can do so using this option.

Minimized Console Logs

The Dashboard allows you to add RateLimits for important endpoints. This allows you to protect against server load in the event of a DDOS attack on the server.

Rate Limits

You can restrict the availability of the Dashboard to only users with reassurance data on the server.

Required Permissions

Store your session and keep you from logging in every time.

Session Store

If you want to use the https protocol, you must provide us with a certificate and an SSL key String. This can also be `fs.readFileSync`.

Create an endpoint containing a link with an invitation to your Discord Support server.

Support Server

Under Maintenance Mode

Channels Multiple Select

Channels Select

Checkbox

Color Select

Embed Builder

Input

Multiple Select

Roles Multiple Select

Roles Select

Select

Spacer

Switch

Text Area

3rd Party Module

This method allows you to create a custom page type. This is useful if you want to create a page that is not passed within the theme.

Create Custom Page

The Dashboard class allows you to listen for events in the Dashboard.

Dashboard Events

A quick and easy way to store and retrieve settings from your dashboard.

Settings Handler

Dashboard has the Socket.io system loaded into it.

Web Sockets

Theme Maintenance

Theme 404

An Object which contains all the information for the admin page.

Admin

Custom Theme Options

An Object which contains all the icons used in the website.

Icons

An Object which contains all the information for the index page.

Index

An Object which contains all the information for the preloader.

Preloader

An Object which contains all the information for the storage.

Storage

An Array of addon IDs which will be imported into the theme.

Addons

An Object which contains all the information for the blacklisted page.

Blacklisted

A String which sets the color scheme of the whole website.

Color Scheme

An Array which contains all categories and commands for the commands page.

Commands

Starting from 1.5.0-beta.1, you are able to use database drivers! This means you can use MongoDB, MySQL, etc for your storage needs. This will store everything that needs to be persistent. (Feeds are stored separately)

Database Driver

An Object which contains all the error information.

Error

An Object which contains all the information for the footer.

Footer

An Object containing all of the locales to be used.

Locales

This is a log handler for your bot. It will collect all the logs from your bot and display them in the dashboard's admin page.

Log Handler

An Object which contains all the meta information

Premium

Soft-UI has a shards page built-in so if you use sharding you can publicly display statistics!

Sharding

An Object which contains all the sidebar information.

Sidebar

A String which is the email address displayed on the privacy-policy page.

Support E-Mail

An Object which contains all the SweetAlert information.

Sweet Alert

A [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) which is the name of your website and displayed in a lot of places.

Get Started

Essentials

Introduction