Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aoijs/aoi.js
aoi.js - The most advanced string-based package to create a Discord Bot fast and powerful.
https://github.com/aoijs/aoi.js
aoi aoi-js aoijs bot bots callbacks discord discord-bot discord-js functions javascript music nodejs slash-commands
Last synced: about 7 hours ago
JSON representation
aoi.js - The most advanced string-based package to create a Discord Bot fast and powerful.
- Host: GitHub
- URL: https://github.com/aoijs/aoi.js
- Owner: aoijs
- License: apache-2.0
- Created: 2021-04-30T02:33:33.000Z (over 3 years ago)
- Default Branch: v6
- Last Pushed: 2024-05-30T18:36:21.000Z (4 months ago)
- Last Synced: 2024-05-31T18:29:28.530Z (4 months ago)
- Topics: aoi, aoi-js, aoijs, bot, bots, callbacks, discord, discord-bot, discord-js, functions, javascript, music, nodejs, slash-commands
- Language: JavaScript
- Homepage: https://aoi.js.org
- Size: 5.83 MB
- Stars: 315
- Watchers: 14
- Forks: 127
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
The most powerful string package to create a simple and fast Discord Bot.
---
[![NPM downloads][download-image]][download-url]
[![AoiJS Server][aoijs-server]][aoijs-server-url]
[![NPM version][npm-image]][npm-url]
[npm-image]: https://img.shields.io/npm/v/aoi.js.svg?color=42cfff
[npm-url]: https://npmjs.org/package/aoi.js
[download-image]: https://img.shields.io/npm/dt/aoi.js.svg?color=3182b0
[download-url]: https://npmjs.org/package/aoi.js
[aoijs-server]: https://img.shields.io/discord/773352845738115102?color=5865F2&logo=discord&logoColor=white
[aoijs-server-url]: https://discord.gg/HMUfMXDQsV
**[ Documentation ](https://aoi.js.org/)** | **[ Support Server ](https://discord.gg/HMUfMXDQsV)** | **[ NPM ](https://npmjs.org/package/aoi.js)** | **[ GitHub ](https://github.com/aoijs/aoi.js)**
---
## About
aoi.js is a JavaScript library that is designed to make it easy to build Discord bots.
It is open-source and free to use, and provides a simple, easy-to-use interface for interacting with the Discord API and
handling events.
aoi.js is suitable for beginners who are new to building bots, as well as experienced developers who want to save time
and streamline their workflow.
## Features
- **600+ Pre-built Functions:** aoi.js comes packed with over 600 pre-built functions that empower you to create dynamic
and interactive Discord bots with ease.
- **Built-in Custom Local Database:** With aoi.js, you get a powerful custom local database out of the box.
- **Extensions for Added Functionality:** Enhance your bots capabilities with aoi.js extensions like aoi.music and
aoi.panel. These extensions make it simple to add music playback, interactive panels, and more to your bot.
- **Easy-to-Use and Beginner Friendly:** aoi.js boasts a user-friendly syntax that is perfect for beginners. The
simple `$` prefix makes it easy to write commands and get your bot up and running quickly.
## Setup
```javascript
const {AoiClient} = require("aoi.js");
const client = new AoiClient({
intents: ["MessageContent", "Guilds", "GuildMessages"],
events: ["onMessage", "onInteractionCreate"],
prefix: "Discord Bot Prefix",
token: "Discord Bot Token"
});
// Ping Command
client.command({
name: "ping",
code: `Pong! $pingms`
});
```
### Adding Database
```javascript
const {AoiClient} = require("aoi.js");
const client = new AoiClient({
intents: ["MessageContent", "Guilds", "GuildMessages"],
events: ["onMessage", "onInteractionCreate"],
prefix: "Discord Bot Prefix",
token: "Discord Bot Token",
database: {
type: "aoi.db",
db: require("@aoijs/aoi.db"),
dbType: "KeyValue",
tables: ["main"],
securityKey: "a-32-characters-long-string-here",
}
});
// Ping Command
client.command({
name: "ping",
code: `Pong! $pingms`
});
```
## Command Handler
By default, aoi.js does not have a command handler. However, you can easily add one by using the `loadCommands` method.
```javascript
client.loadCommands("./commands/", true);
```
- `./commands/` is the directory where your commands are located.
- `true` allows to log the commands in console.
## Notices
- **Reading Functions**: Currently it reads `$` functions from bottom to top.
## Official Extensions
## Contributing
[Refer to contribution documentation for more information](https://github.com/aoijs/aoi.js/blob/v6/.github/CONTRIBUTING.md)