The Highrise Python Bot SDK is a python library for writing and running Highrise bots.
First, install the library (preferably in a virtual environment):
$ pip install highrise-bot-sdk==24.1.0
In the Settings section of the Highrise website, create a bot and generate the API token. You'll need the token to start your bot later.
You will also need a room ID for your bot to connect to; the room needs to be owned by you or your bot user needs to have designer rights to enter it.
Open a new file, and paste the following to get started (into mybot.py for example):
from highrise import BaseBot
class Bot(BaseBot):
pass
Override methods from BaseBot as needed.
When you're ready, run the bot from the terminal using the SDK, giving it the Python path to the Bot class:
$ highrise mybot:Bot <room ID> <API token>
RoomModeratedEvent, bot can now override on_moderate() metho to handle this event. Triggered when room is moderated by any user.on_user_join handle, this will allow bots to know what the user's location is on room join.self.highrise.get_inventory()). It returns list of items that bot has in its inventory.self.highrise.get_outfit()). It returns list of items that bot has equipped.self.highrise.set_outfit(outfit)). It takes list of items that bot should equip. Bot can equip free items or items in his own inventory.self.highrise.buy_item(item_id)). It takes item id and attempts to buy this item from highrise. Note bot can only use his own wallet to buy items. Some items are not available for purchase. Take note that bots can only equip those items and not trade them, there is no use in buying items more than one time.self.webapi.get_item(): Fetches a specific item by id.self.webapi.get_items(): Retrieves a list of items.self.webapi.get_grab(): Fetches a specific grab by id.self.webapi.get_grabs(): Retrieves a list of rooms.self.highrise.tip_user(user_id, amount)). Amount needs to be expressed in gold bars. Possible values are:
"gold_bar_1",
"gold_bar_5",
"gold_bar_10",
"gold_bar_50",
"gold_bar_100",
"gold_bar_500",
"gold_bar_1k",
"gold_bar_5000",
"gold_bar_10k",self.webapi. This enables easy communication with the Highrise Web API to gain access to public information about the game. Included are the following methods:
self.webapi.get_user(): Fetches a specific user by id.self.webapi.get_users(): Retrieves a list of users.self.webapi.get_room(): Fetches a specific room by id.self.webapi.get_rooms(): Retrieves a list of rooms.self.webapi.get_post(): Fetches a specific post by id.self.webapi.get_posts(): Retrieves a list of posts.self.highrise.buy_room_boost(payment_type, amount)).self.highrise.buy_voice_time(payment_type)).bot_wallet_only, bot_wallet_priority, user_wallet_only allowing bot to use its own wallet or user's wallet to pay for the purchase. Or to try to prioritize bot's wallet over user's wallet.async def before_start(self) -> None:). All bot initialization should be done here, and most things like reading from files, setting up database connections can be done here instead of on_connect.async def on_message(user_id, conversation_id, is_new_conversation)). It is triggered when user sends in game message to bot, using either new conversation or existing conversation. If this is new conversation is_new_conversation will be set to True, otherwise it will be set to False.self.highrise.send_message(conversation_id, message, type, room_id)). This can be only used on existing conversation, and will fail if conversation is not found. Bot can only send two types of messages, text and invite. Text is the normal message in which bot can send text to user, and invite is used to invite user to room. If type is invite then room_id must be provided in order to generate room invite for users.self.highrise.get_conversations(not_joined, last_id)). This will return list of conversations opened with bot, there are two types of conversations, the ones bot has joined and unjoined. If not_joined is set to True then only unjoined conversations will be returned, otherwise only joined conversations will be returned. Response will also return number of unjoined conversations that bot has. This method will return at most 20 conversations ordered from newest to the oldest, If last_id is provided then only conversations that are older than specified id will be returned.self.highrise.get_messages(conversation_id, last_id)). This will return list of messages in conversation, at most 20 messages will be returned ordered from newest to the oldest. If last_id is provided then only messages that are older than specified id will be returned. conversation_id must be from conversation that is available to bot.self.highrise.leave_conversation(conversation_id)). This will leave conversation, and bot will no longer receive messages from user in that conversation or have that conversation in his list.self.highrise.get_user_outfit(user_id)).self.highrise.get_voice_status())self.highrise.add_user_to_voice(user_id)self.highrise.remove_user_from_voice(user_id)self.on_voice_change(users, seconds_left)self.highrise.walk_to(AnchorPosition)).self.highrise.move_user_to_room(user_id, room_id)).self.on_user_move(user_id, position)).)self.highrise.get_room_privilege(user_id)).self.highrise.set_room_privilege(user_id, privilege)).self.highrise.moderate_room(user_id, moderate_action, action_length)).chat, send_whisper, send_emote, react, set_indicator, send_channel, walk_to, teleport) now return None, and raise a highrise.ResponseError on an error response.self.highrise.get_wallet()).FAQs
The Highrise Bot SDK, for running Highrise bots written in Python.
We found that highrise-bot-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.