https://github.com/dan-online/neptune
A simple, modular, configurable discordjs template made as a starting point for bots (WIP)
https://github.com/dan-online/neptune
config discord-bot discordbot discordjs modular multi-functional neptune plugins poseidon template
Last synced: about 2 months ago
JSON representation
A simple, modular, configurable discordjs template made as a starting point for bots (WIP)
- Host: GitHub
- URL: https://github.com/dan-online/neptune
- Owner: dan-online
- License: mit
- Created: 2020-05-12T16:28:20.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T05:48:29.000Z (over 1 year ago)
- Last Synced: 2025-04-24T00:09:16.259Z (about 2 months ago)
- Topics: config, discord-bot, discordbot, discordjs, modular, multi-functional, neptune, plugins, poseidon, template
- Language: JavaScript
- Homepage: https://neptune-bot.netlify.app
- Size: 1.98 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Neptune
> A template for a discord bot written with discordjs with reloadable events and commands along with a multitude of plugins
[![Discordjs Version][discordjs-image]][discordjs-url]
## Downloads
The master branch is unstable and should be used with caution.
To use stable releases go to [releases](../../releases)
## To-do
- ~Economy / points system plugin~
- ~Webhook plugin~
- API plugin
- Updater plugin/system
- Points system
- ~Translate~
- Welcome/Leave messages (image jimp)
- ~Verification system (email/oauth)~
- ~Status page~
- Monitoring app
- CLI init
## Installation
Make sure to have FFmpeg/avconv installed for the youtube plugin
#### .env
```env
TOKEN=DISCORD_BOT_TOKEN
YANDEX_TOKEN=YANDEX_TOKEN (only if translation API is enabled)
```
#### Config
```js
module.exports = {
prefix: "t!", // bot prefix
owner: "312551747027468290", // your id
emojis: {
// emojis for success and errors
err: {
full: ":red_circle:",
id: ":red_circle:",
},
success: {
id: ":white_check_mark:",
full: ":white_check_mark:",
},
},
persistent: false, // persistent database or in memory database
};
```
#### Install
```sh
$ yarn
$ npm
```
## Usage example
```sh
$ yarn start
$ npm start
```
## Meta
DanCodes – [@dan-online](https://github.com/dan-online) – [email protected]
Distributed under the MIT license. See `LICENSE` for more information.
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
[discordjs-image]: https://img.shields.io/npm/v/discord.js?color=%232196f3&label=discord.js
[discordjs-url]: https://discord.js.org