Documentation

Installation

Requirements

JavaScript or TypeScript with a modern bundler (Vite, Next.js, Nuxt, SvelteKit, Astro, etc.), or a runtime supporting

codetxt

fetch

(such as Bun or Node 18+).

A Discord account that has joined the PresenceKit server and approved sharing with

codetxt

/confirm

Access to the official

codetxt

https://presence-api.iconical.dev

endpoint. The SDK does not support overriding the API origin.

From the PresenceKit repository root:

codetxt

bun install
bun run build
bun pm pack --filename presencekit-local.tgz

From your own consumer project's directory, install the archive using the path to your checkout:

codetxt

bun add /path/to/presencekit/presencekit-local.tgz

On Windows, use the equivalent local absolute path. The installed package is named

codetxt

@iconical/presence

. Rebuild, repack, and reinstall after library changes.

If Vite is still serving a cached version, restart your consumer project's dev server:

codetxt

bun run dev -- --force

bun add @iconical/presence
# or
npm install @iconical/presence
# or
pnpm add @iconical/presence

Use the entrypoint for your framework:

index.tsts

console.log('hello world');

React, Vue, and Svelte are optional peer dependencies; install only the framework you use.

The packed SDK contains compiled JavaScript and declaration files under

codetxt

dist/

. No TypeScript source compilation is required in your consumer project.

codetxt

import { createPresenceClient } from "@iconical/presence";
const client = createPresenceClient();

For network or consent errors, see Troubleshooting.

Was this page helpful?