Giter Club home page Giter Club logo

sourcemod-docs-bot's Introduction

SourceMod Docs Bot

A Discord bot that provides documentation hints for the SourceMod API.

Commands

  • /docs <query> - Displays symbol information.
  • /reload-symbols - Owner only command to reload symbols.

Deploying the bot

Preparation

  1. Clone this repository and navigate to the directory.
  2. Copy .env.example to .env and fill environment variables.

Deploying using PM2

  1. Run npm install to install all the dependencies.
  2. Run npm run build to build the application.
  3. Run npm run deploy:prod to deploy the slash commands.
  4. Run pm2 start dist/index.js --name sourcemod-docs-bot to start the bot.

Deploying using Docker (Compose)

  1. Copy docker-compose.yml.example to docker-compose.yml.
  2. Run docker-compose up -d to start the bot in the background.

Development

  1. Clone the repository with git clone https://github.com/Sikarii/sourcemod-docs-bot.
  2. Navigate to the cloned repository with cd sourcemod-docs-bot.
  3. Copy .env.example to .env and fill environment variables.
  4. Run npm run deploy:dev to deploy slash commands to the dev guild.
  5. Run npm run dev to run the bot in development mode (restarts on changes).

Acknowledgments

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.