Skip to content
A Discord automation application.
JavaScript TSQL
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Design general structures of new version Dec 30, 2019
commands Normalize Jan 16, 2020
etc/sql Normalize Jan 16, 2020
handlers
structures
translations
.eslintrc.js Setup new project with README Dec 18, 2019
.gitignore
CODE_OF_CONDUCT.md
LICENSE
README.md Normalize Jan 16, 2020
index.js
package.json
preferences.js
yarn.lock Design general structures of new version Dec 30, 2019

README.md

scriptoned-base

The scriptoned project is a Discord automation application.

  • scriptoned-base is the modified version of bare fork of original scriptoned repository to provide the normalized code of the scriptoned project. Also, this repository will apply the every core code updates from original repository. If you want clean code base without any additional commands including not basic feature, you can use this repository instead.

Contributor Covenant License: MIT Code style: standard

Table of Contents


Requirements

To develop and run this project, you need to install some software working hard behind this project. The project is based on following software:

Installation

  1. Fork or download this Git repository.
  • git clone <repository url>
  1. Install the dependencies via Yarn.
  • yarn
  1. Fill or edit the missing(or invalid) values of preferences.js
  • The token put on client.token is not valid value.
  1. Start the project:
  • as normal state: yarn start
  • as sharding state: yarn shard
  • as debug state: yarn debug
  • as debug sharding state: yarn debug-shard

Directories

Also, following list includes important files.

  • bin: Where start up files with options are located.
  • commands: Where the command modules are located.
    • refs.js: Specific categories which need to be exposed.
  • etc: ETC.
    • sql: Where the SQL queries are stored. (static)
  • handlers: Where the Discord.js event handlers are located.
  • structures: Modules and important logics.
    • database: Exports Knex.js client.
    • message: Where the modules required in message handler.
    • permission: Logics related to user permission.
  • translations: Where the translations are stored.

License

This repository is accepting the MIT license.

MIT License

Copyright 2019 Seia-Soto and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
You can’t perform that action at this time.