README.md

Horsebot

Horsebot is the official Stallion Squad Discord Bot. It serves as a companion for players! Horsebot can retrieve players Steam inventories, item information and wiki data on the fly! Horsebot grabs API data from the Peekio API.

Horsebot was originally created for the Steam game Stallion Squad but we're now open-sourcing the project!

⭐ Star us on GitHub — it motivates us a lot!

Table of Content

• Installation
  • Creating environment variables
• Commands
• Links

Installation

1. Extract files into a folder
2. Open a terminal in your folder and install dependencies by using

npm i

3. To start use

node index.js

Creating environment variables

1. Create .env file in your folder
2. Define enviromental variables like that:

BOT_TOKEN=YOUR_BOT_TOKEN
STEAM_API_KEY=YOUR_STEAM_API_KEY

Commands

• /horse - Sends random image from thishorsedoesnotexist.com
• /inspect - Inspects user's Steam inventory using SteamId64
• /inventory - Displays user's Steam inventory using SteamId64
• /item Displays information about the Steam item
• /ping - Checks Horsebot's response time to Discord
• /suggest - Add a suggestion to the suggestions channel
• /userinfo - Displays information about the user
• /wiki - Displays wiki statistics

Links

• Kozi.dev
• Peekio.no
• Peekio API Documentation
• Issue tracker
• Source code