vrchat-api-library

v2.0.0

Published

8 months ago

🔥🔥 Your All-in-One Node.js API Solution for Seamless Interaction with VRChat's REST API and real-time events using Websockets! ✅✅

Downloads

0High
0Medium
0Low

solitarju

vrchat api library websocket events authentication osc

VRChat API Library

VRChat API Library is a Node.js library that allows easy integration of the VRChat API into your applications.

It provides real-time event handling through WebSockets, all endpoints and API sections are built according to the community driven VRChat API Docs.

Feel free to reach out on the Discord server below for support or inquiries.

All dates in this document are formatted as YYYY-MM-DD (ISO 8601).

Disclaimer

Official Disclaimer from VRChat (Tupper):
Use of the VRChat API using applications other than the approved methods (website, VRChat application) is not officially supported. When using the API, please adhere to the following guidelines:

We do not provide documentation or support for the API.
Do not make queries to the API more than once per 60 seconds.
Abuse of the API may result in account termination.
Access to API endpoints may break at any given time, with no warning.

Introduction

VRChat API Library is a Node.js module that streamlines integration with the VRChat platform.

It allows you to interact with VRChat's APIs, enabling essential features and offering QOL utilities & improvements, such as:

Setting & retrieving user information.
Real-time events.
Custom implemented user-online / user-offline events.
QOL duplicate event prevention.

Each API section and endpoints are mostly built in reference to the community-driven VRChat API Docs, with exception to the real-time EventsApi.

Installation

Install the library via NPM:

npm install vrchat-api-library

Getting Started

Install the library using the above command.
Include the necessary classes in your application.

const { VRChat, Enums } = require('vrchat-api-library');

Authenticate your application using a VRChat account and start using the library.

const { VRChat, Enums } = require('vrchat-api-library');
const { stdin, stdout } = require('process');
const readline = require('readline');

const vrchat = new VRChat();

// Promise based console input function.
// Any promise-based input will work assuming it returns the two-factor authentication code.
function Prompt(query) {
    const question = readline.createInterface({
        input: stdin,
        output: stdout,
    });

    return new Promise(resolve => question.question(query, res => {
        question.close();
        resolve(res);
    }));
}

// Main asynchronous method.
const asyncMethod = async () => {
    const auth = await vrchat.Authenticate({
        username: "username",
        password: "password",
        authCookie: "",
        twoFactorAuth: ""
    }, async (type) => {
        return await Prompt(`Please input ${type} two factor code:\n`);
    });

    console.log(auth); // Logs authentication information as a JSON object to console.

    // Method ignoring errors.
    const friendsArray = await vrchat.FriendsApi.ListFriends({ n: 100, offline: true }); // Get an Array of LimitedUser objects as documented on the Community-driven API Docs.
    for(let i = 0; i < friendsArray.length; i++) {
      console.log(friendsArray[i].displayName); // Log display names of all offline friends to console returned from the API function call above.
    }

    // Method catching & handling errors. (I recommend catching & handling your errors, otherwise you could run into catastrophic errors that break your applications at runtime)
    // Get an Array of LimitedUser objects as documented on the Community-driven API Docs and only log names if there was no error, otherwise log the error.
    await vrchat.FriendsApi.ListFriends({ n: 100, offline: true }).then(res => {
        for(let i = 0; i < res.length; i++) {
            console.log(res[i].displayName); // Log display names of all offline friends to console returned from the API function call above.
        }
    }).catch(err => console.log(err));

    // Basic EventsApi usage, making use of the VRChat class.
    vrchat.EventsApi.Connect();

    // Usage of custom undocumented event type, this isn't valid, just for demonstration purposes.
    // Upon getting an undocumented event type, the library will warn you in the console and ask you to report it. (Please do this!!)
    vrchat.EventsApi.on("undocumented event", (data) => {
        console.log("Undocumented Event");
        console.log(data);
    });

    vrchat.EventsApi.on(Enums.EventType.error, (err) => {
        console.log("Error: " + err.message);
    });

    vrchat.EventsApi.on(Enums.EventType.userOnline, (data) => {
        console.log("User online");
        console.log(data);
    });

    vrchat.EventsApi.on(Enums.EventType.userOffline, (data) => {
        console.log("User offline");
        console.log(data);
    });

    // vrchat.EventsApi.Disconnect(); -- Optionally disconnect from the API
}

asyncMethod(); // run asynchronous code from a synchronous context.

Classes/API Coverage

Here's a comprehensive overview of the classes and APIs available in the library:
All APIs can also be found at the community-driven VRChat API Docs, with exception to the EventsApi.

All API's excluding the VRChat class, EventsApi & AuthenticationApi now use constructed response objects as documented in the community-driven VRChat Docs, such as the GetOwnAvatar function returning a constructed Avatar object.

VRChat

Description: The VRChat class is designed to simplify authentication and automatically manage the library for you. It's the central component that connects you to each of VRChat's APIs.

EventsApi

Description: The EventsApi class offers a highly stable WebSocket connection for real-time events related to users and friends.
Features:
- Custom "user-online" and "user-offline" events to monitor user presence.
- Event type modularity, allowing undocumented event types to work flawlessly.
- Smart event de-duplication, making sure identical events don't repeat/spam while letting authentic & valid events pass.

AuthenticationApi

Description: The AuthenticationApi class focuses on handling authentication and user-related features, allowing you to securely log in and interact with VRChat's APIs.

AvatarsApi

Description: The AvatarsApi class enables interactions with user avatars, providing functionalities to work with avatars effectively.

EconomyApi

Description: The EconomyApi class is responsible for managing economic aspects in VRChat, such as transactions and VRC+ subscriptions.

FavouritesApi

Description: The FavouritesApi class offers features related to managing your favourited content in VRChat, including friends, worlds and avatars.

FilesApi

Description: The FilesApi class allows you to interact with files and their associated operations within VRChat.

FriendsApi

Description: The FriendsApi class provides methods to manage your friends list, retrieve information about friends, and monitor friend-related activities.

GroupsApi

Description: The GroupsApi class allows you to create and manage groups in VRChat, enabling collaboration and social interaction within these groups.

InvitesApi

Description: The InvitesApi class handles the process of inviting users to events or groups in VRChat, facilitating social connections and collaboration.

InstancesApi

Description: The InstancesApi class provides functionalities related to specific instances of VRChat worlds, including getting information about a particular instance.

NotificationsApi

Description: The NotificationsApi class manages notifications and alerts for users in VRChat, ensuring that users stay informed about relevant events.

PermissionsApi

Description: The PermissionsApi class allows you to retrieve information about user permissions in VRChat, enabling you to manage access and interactions effectively.

PlayerModerationApi

Description: The PlayerModerationApi class offers features for moderating user behavior and interactions in VRChat, ensuring a safe and enjoyable environment.

SystemApi

Description: The SystemApi class provides access to system-related information in VRChat. While it doesn't require authentication, it remains accessible within the library.

UsersApi

Description: The UsersApi class focuses on interactions with user profiles, allowing you to retrieve user information and manage user-related operations.

WorldsApi

Description: The WorldsApi class enables interactions with VRChat worlds, including features to retrieve world information and manage world-related activities.

Enums

Description: The Enums class consolidates various enumerations, including event types, for better organization and ease of use in the VRChat library.

License Change (2024-03-12 / v2.0.0)

As of v2.0.0, this package no longer uses the GPLv3 license and now uses the permissive MIT license, which as the sole developer of this project, I feel is more suitable for this project considering it is an NPM package that could be a dependency to other projects.

This will allow you to use this package as a dependency without having to source the original work or use the same license.

THIS DOES NOT APPLY TO VERSIONS PRIOR TO v2.0.0

TODO

Wiki/Documentation.
Code Consistency and General improvements.
Potentially adding support for OSC (Open Sound Control).

Changelog