Skip to content
VRCPulse
Menu
Check out VRCPulse
Docs menu

Getting started

Getting started

Account creation, asset registration, and the limits that apply to each plan.

Authentication

VRCPulse authenticates through Patreon OAuth. Choose Sign in with Patreon on the hosted app. An account is created on first sign-in; no separate registration exists. Accounts without a paid Patreon membership are assigned the Free plan.

Asset registration

An asset is a VRChat group or world monitored by VRCPulse. Assets are registered through the Bring assets online dialog, opened from Add asset on the dashboard or + on the Groups page.

RequirementGroupsWorlds
EligibilityGroup owner onlyWorld author (uploader) only
Ownership proofVerification code in VRChat bioVerification code in VRChat bio
Bot membershipBot account must be a group memberNot required

Procedure:

  1. Pick an account. Select a linked VRChat profile, or enter a profile URL or usr_ ID under Another profile.
  2. Prove ownership. Add the issued code (VRCPULSE-XXXXXX) to the profile bio and choose Check bio now. Skipped for profiles already linked.
  3. Select. Choose from the groups owned and worlds authored by the profile, then Add selected.
  4. Bot joins. For groups, the bot account requests membership. If the request cannot complete, the group enters Waiting for invite until the bot account is invited in VRChat and Check invite & register is run. Worlds are added to the bot's favorites.
  5. Done. Data appears after the first successful collection cycle.

Profiles can be linked in advance under Settings, VRChat Connections.

Plans and credits

Each registered asset consumes one credit. Plan limits:

PlanCreditsHistoryAPI access
Free230 daysNo
Supporter10UnlimitedNo
Pro25UnlimitedYes
UltraUnlimitedUnlimitedYes

History is the maximum range available to charts and the API. The plan is derived from the account's Patreon membership and changes when the membership changes. Current usage is shown under Settings, Monitoring credits.

On downgrade, assets exceeding the new credit limit remain active for a 7-day grace period, during which the account selects which assets stay active. Unselected assets are then paused. Paused assets and their data are retained.

Registration states

StateCauseResolution
Asset not listedProfile is not the group owner or world authorRegister from the owning profile
Waiting for inviteBot account is not a group memberInvite the bot account, then run Check invite & register
Waiting for creditRegistered assets exceed plan creditsPause an asset under Managed Assets, or change plan