syntx.js

     

Documentation

Syntx.js is an npm package built on top of discord.js that simplifies and accelerates the creation of Discord bots. It uses a JSON-based structure and provides helpers for prefix commands, slash commands, embeds, components, polls, and more.

Requires Node.js ≥ 18.

Installation

npm i syntx.js

# or from GitHub
npm i github:erxproject/syntx.js

Table of contents

• Setting up the client
• Prefix commands
• Slash commands
• Embeds
• Components
• Polls

Setting up the client

const { ERXClient, Intents } = require("syntx.js")

const client = new ERXClient({
    prefix: "!",
    intents: Intents.All,
    token: "YOUR_DISCORD_BOT_TOKEN",
    clientId: "YOUR_APPLICATION_ID"
})

client.ready(() => {
    console.log(`Bot ${client.bot.user.username} is ready!`)
})

client.start()

Prefix commands

Register commands with client.command() and call client.registerCommands() before client.start().

const { ERXClient, Intents, cmd } = require("syntx.js")

const client = new ERXClient({ prefix: "!", intents: Intents.All, token: "TOKEN" })

client.command({
    name: "hi",
    alias: ["hello", "hey"],
    content: async (message) => {
        cmd.message.send({ text: `Hello, ${message.author.username}!` }, message)
    }
})

client.registerCommands()
client.start()

Slash commands

Use SlashCommand to define the command, client.slash() to register it, and client.registerSlashCommands() to deploy it to Discord.

const { ERXClient, Intents, SlashCommand } = require("syntx.js")

const client = new ERXClient({ intents: Intents.All, token: "TOKEN", clientId: "CLIENT_ID" })

client.slash({
    data: new SlashCommand({
        name: "ping",
        description: "Replies with Pong!",
        scope: "global" // or "guild"
    }),
    execute: async (interaction) => {
        await interaction.reply("🏓 Pong!")
    }
})

client.ready(async () => {
    await client.registerSlashCommands()
})

client.start()

Embeds

const { Embed, cmd } = require("syntx.js")

const embed = new Embed()
embed.set({
    title: "Hello!",
    description: "This is an embed.",
    color: "#5865F2",
    footer: "Syntx.js",
    thumbnail: "https://example.com/icon.png"
})
embed.timestamp()

cmd.message.send({ embeds: [embed.build()] }, message)

Components

Buttons

const { Buttons, cmd } = require("syntx.js")

const row = new Buttons()
row.set([
    { label: "Click me!", style: "Primary", id: "btn-click" },
    { label: "Visit", style: "Link", url: "https://example.com" }
])

cmd.message.send({ text: "Press a button:", components: [row.build()] }, message)

Handle the interaction with client.interaction() and activate the listener with client.registerInteractions().

client.interaction({
    id: "btn-click",
    content: async (interaction) => {
        await interaction.reply({ content: "You clicked it!", ephemeral: true })
    }
})

client.registerInteractions()
client.start()

Modals

const { Modal } = require("syntx.js")

const modal = new Modal()
modal.set({
    id: "feedback-modal",
    title: "Send Feedback",
    inputs: [{ id: "feedback-input", label: "Your feedback", style: "paragraph" }]
})

// Show the modal on a button click
client.interaction({
    id: "open-modal",
    content: async (interaction) => {
        await interaction.showModal(modal.build())
    }
})

// Handle the submission
client.modal({
    id: "feedback-modal",
    run: async (interaction) => {
        const feedback = interaction.fields.getTextInputValue("feedback-input")
        await interaction.reply({ content: `Thanks! "${feedback}"`, ephemeral: true })
    }
})

Polls

const { Poll, cmd } = require("syntx.js")

const poll = new Poll()
poll.set({
    question: "Favorite color?",
    answers: [
        { text: "Red",   emoji: "🔴" },
        { text: "Blue",  emoji: "🔵" },
        { text: "Green", emoji: "🟢" }
    ],
    duration: 24,       // hours
    multiselect: false
})

cmd.message.send({ poll: poll.build() }, message)

More information in the documentation.