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.
| Requirement | Groups | Worlds |
|---|---|---|
| Eligibility | Group owner only | World author (uploader) only |
| Ownership proof | Verification code in VRChat bio | Verification code in VRChat bio |
| Bot membership | Bot account must be a group member | Not required |
Procedure:
- Pick an account. Select a linked VRChat profile, or enter a profile URL or
usr_ID under Another profile. - Prove ownership. Add the issued code (
VRCPULSE-XXXXXX) to the profile bio and choose Check bio now. Skipped for profiles already linked. - Select. Choose from the groups owned and worlds authored by the profile, then Add selected.
- 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.
- 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:
| Plan | Credits | History | API access |
|---|---|---|---|
| Free | 2 | 30 days | No |
| Supporter | 10 | Unlimited | No |
| Pro | 25 | Unlimited | Yes |
| Ultra | Unlimited | Unlimited | Yes |
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
| State | Cause | Resolution |
|---|---|---|
| Asset not listed | Profile is not the group owner or world author | Register from the owning profile |
| Waiting for invite | Bot account is not a group member | Invite the bot account, then run Check invite & register |
| Waiting for credit | Registered assets exceed plan credits | Pause an asset under Managed Assets, or change plan |
