zelgod / imvu.js

A JavaScript library for interacting with the IMVU API.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@imvu/

Build Packages Coverage Status

A JavaScript/TypeScript library for interacting with the IMVU API.

This library allows easy usage to the exposed API endpoints on IMVU's current IMVU Next implementation, as well as several legacy web endpoints.

Despite what IMVU's own imvu.js library claims, they are not using standard JavaScript practices. This collection of libraries is intended to be a more modern, more complete, and more correct implementation of the IMVU API.

Installation

npm install @imvu/client

Information

Packages

The @imvu mono-repository contains the following packages:

  • @imvu/client: The client library for interacting with the IMVU API. (log in, gifting, messaging, etc.)
  • @imvu/imq: Library for interacting with the IMVU IMQ websocket server (chat, notifications, etc).
  • @imvu/chkn: Download, extract, and create product CHKN files.
  • @imvu/studio: Library for interacting with IMVU Studio services (product publishing, editing, etc).
  • @imvu/tools: A collection of tools for interacting with IMVU's API (product downloading, etc).

Testing

This library has testing in place to ensure the integrity and reliability of the APIs being used.

If you would like to run the tests, I recommend using a VPN and separate account to avoid potential rate limiting and IP issues.

Please set the IMVU_USERNAME and IMVU_PASSWORD environment variables to your IMVU account credentials. Do not use your main account, as the tests may modify your account.

License

This project is licensed under the MIT License - see the LICENSE file for details

About

A JavaScript library for interacting with the IMVU API.

License:MIT License


Languages

Language:TypeScript 100.0%