Configuring Solix Utility

Solix Utility is split into multiple sections to make it easier for you to configure, this guide will show each of those sections seperately allowing you to configure it with ease.

Bot Status

The bot status can be configured via the configuration file. It is relatively simple and does not require additional explanation.

##############
# BOT STATUS #
##############
botStatus: # Sets the status of the bot
  enabled: true
  status: 1 #5 - Competing, 2 - Listening, 0 - Playing, 1 - Streaming, 3 - Watching
  statusMessage: "Minecraft"

Welcome Message

The welcome message users recieve when they join the server.

###################
# WELCOME MESSAGE #
###################
welcomeMessage: # Send a message when a user joins a server
  enabled: true # Whether this option is enabled
  channelId: "CHANNEL_ID" # ID of the Channel
  message: 
    title: "👋 Welcome" # Title of embed
    text: "{user} has joined the server." # Use the placeholder {user} to input the user's username
    colour: "Random" # Colour of embed
  dmMessage:
    enabled: true # Whether the bot should DM the user on join
    embed: # Embed to show user
      title: "Thank you for joining {server}" # Use the placeholder {server} to input the server name
      description: "Thanks for joining {server}, we hope you enjoy your time here"
      footer: "Solix" # Footer of embed
      colour: "Blue" # Colour of embed

Leave message

This module sends a leave message to a channel when a user leaves. It is self explanatory.

#################
# LEAVE MESSAGE #
#################
leaveMessage: # Send a message when a user joins a server
  enabled: true
  channelId: "CHANNEL_ID"
  message: 
    title: "👋 Goodbye"
    text: "{user} has left the server." # Use the placeholder {user} to input the user's username
    colour: "Random"

Captcha System

This module shows how to configure the captcha system. The captchScreenEmbed is simply the embed which is shown on the captcha panel.

##################
# CAPTCHA SYSTEM #
##################
captchaVerification:  
  enabled: true
  roleId: "ROLE_ID" # Role given when user is verified. 
  captchaScreenEmbed: 
    title: "Verification"
    description: "This server uses captcha verification to ensure the safety of the users.\n\nTo enter the server, please click the button below and solve the CAPTCHA."
    colour: "Red"
    footer: "Solix"

XP System

This module shows the XP system. If levelUp is enabled, the bot will send messages on levelling up.

#############
# XP SYSTEM #
#############
xp: 
  enabled: true # Whether the whole module is enabled.
  messages: # Messages to be displayed when a user levels up.
    levelUp: true

DM command

Whether the DM command is enabled.

##############
# DM COMMAND #
##############
dm:
  enabled: true

Profile picture command

Controls whether the /pfp command is enabled.

###################
# PROFILE PICTURE #
###################
pfp:
  enabled: true

Autorole

############
# Autorole #
############
autorole: # Role to give user when they join the server
  enabled: true
  roleId: "ROLE_ID"