Highrise Bot SDK: Unofficial JavaScript/TypeScript SDK for Building Highrise Bots

Build Advanced Highrise Bots with JavaScript

Highrise Bot SDK (highrise.bot) is the premier unofficial TypeScript/JavaScript SDK for creating powerful automation bots on the Highrise social platform. Whether you're building chat moderators, game assistants, or interactive experiences, our SDK provides enterprise-grade reliability with production-ready features.

Core Capabilities

• Real-time WebSocket Connection - Stable connection with auto-reconnect
• Complete Bot API Coverage - All official Highrise bot endpoints implemented
• Advanced Caching System - Efficient user position tracking and spatial queries and more upcoming
• Comprehensive Event Handling - All major Highrise events supported
• Web API Integration - Access to user, room, item, post, grab data

Performance Highlights

• 86%+ Memory Reduction in position tracking using binary encoding
• Sub-millisecond spatial queries for user location
• Automatic resource cleanup and connection management
• Object pooling for reduced garbage collection
• 98% Memory leak free

Installation

npm install highrise.bot

Quick Start

const { Highrise } = require('highrise.bot');

// Create bot instance
const bot = new Highrise(
  ['ChatEvent', 'UserJoinedEvent', 'UserMovedEvent'], // Events to listen for
  {
    LoggerOptions: {
      showTimestamp: true,
      showMethodName: true,
      colors: true
    },
    autoReconnect: true,
    reconnectDelay: 5000
  }
);

// Event handlers
bot.on('Ready', (metadata) => {
  console.log(`Bot connected to room: ${metadata.room.room_name}`);
});

bot.on('Chat', async (user, message) => {
  if (message === '!hello') {
    await bot.message.send(`Hello ${user.username}! 👋`);
  }
});

bot.on('UserJoined', async (user, position) => {
  await bot.message.send(`Welcome to the room, ${user.username}! 🎉`);
});

// Connect to Highrise
bot.login('your_64_character_bot_token', 'your_24_character_room_id');

Documentation

For complete API documentation, check the TypeScript definitions in index.d.ts or visit our documentation site (will be available soon).

Issues and Support

Found a bug or need help? Please send a message to me in highrise discord server @oqs0_ with:

• sdk version
• Error logs
• Steps to reproduce

License

MIT License - Copyright (c) 2025 Yahya Ahmed