nuxt-altv

Nuxt alt:V Integration

Nuxt module for interacting with the alt:V Client EarlyAuth & WebView APIs.
Note: this module is just a wrapper around the alt:V API, it does not provide any functionality on its own.
If you have a feature request, please open an issue.

• ✨  Release Notes

Features

• 🔐  EarlyAuth API
  • 📦   Simplified Storage API
  • ℹ️   Easy alt:V Username retrieval
  • ⚙️   Full API access without having to use alt:V events manually
• 🖥️  WebView API Polyfills for testing in browser

Quick Setup

1. Add nuxt-altv dependency to your project

# Using pnpm
pnpm add -D nuxt-altv
# Using yarn
yarn add --dev nuxt-altv
# Using npm
npm install --save-dev nuxt-altv

2. Add nuxt-altv to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-altv'
  ]
})

That's it! You can now use Nuxt alt:V Integration in your Nuxt app ✨

Development

# Install dependencies
pnpm install
# Generate type stubs
pnpm run dev:prepare
# Develop with the playground
pnpm run dev
# Build the playground
pnpm run dev:build
# Run ESLint
pnpm run lint
# Run Vitest
pnpm run test
pnpm run test:watch
# Release new version
pnpm run release