Skip to content

An auto-complete enabled Discord bot to showcase your vehicles using a simple config file.

License

Notifications You must be signed in to change notification settings

Mirasaki/dayz-vehicle-bot

Repository files navigation

dayz-vehicle-bot

Overview

CodeFactor GitHub license GitHub issues GitHub forks GitHub stars

A DayZ bot written in JavaScript to display an overview of your in-game vehicles in Discord using a simple JSON config file.

Features

  • Search vehicles using the /vehicles command, auto-complete enabled.
  • Automatically post all available vehicles in a configured text channel on boot, making sure the information displayed is always up-to-date.
    • ❗ The bot deletes previous messages - belonging to the client - in the channel to keep it clean, so use a dedicated channel for this
  • Easily add variants that inherit data from the base vehicle, while still allowing you to overwrite any values
  • Add more custom fields to the embed, like where/how to obtain the vehicle if it's not for sale.
    • Check out the last M3S - Example example in the /config/vehicles.json file for more information, or /config/vehicles-advanced-config.json for an advanced config example

Technologies Used

Showcase

Embed Output/Preview

Installation

Requirements

  • Node/NodeJS - Be sure to check the box that says "Automatically install the necessary tools" when you're running the installation wizard

1) Head over to the download page

2) Download either the zip or zip.gz source code

3) Extract it using your favorite zip tool

4) Open the folder containing your recently extracted files

5) Open a console/terminal/shell prompt in this directory

  • Run npm install to install all dependencies

ALL CONFIGURATION IS DONE IN THE /config/ FOLDER

6) Rename .env.example to .env located in the /config folder

  • Provide all your configuration values in this file
  • Also provide the values in config/config.json (optional)

7) Use node . to start the application or npm run start:dev if you have nodemon installed for automatic restarts on changes (development)

About

An auto-complete enabled Discord bot to showcase your vehicles using a simple config file.

Topics

Resources

License

Stars

Watchers

Forks