Skip to content

A cross-platform, TypeScript framework for multiplayer mods in Grand Theft Auto.

License

Notifications You must be signed in to change notification settings

aurora-mp/framework

Repository files navigation

Aurora Multiplayer

Aurora Multiplayer (aurora-mp) is a powerful TypeScript framework that lets you write a single codebase for GTA servers and gamemodes on platforms like alt:V, RAGE MP, and FiveM.

NPM Version Package License Discord

Early Development

This project is still in its infancy. It’s under active development, and not all platforms are supported yet.

🚀 Overview

Aurora Multiplayer abstracts away the differences between popular GTA multiplayer platforms (such as alt:V, FiveM, RAGE MP ...) so you can write one single, strongly-typed codebase that runs on all of them. With built-in dependency injection, an event-driven architecture, and first-class TypeScript support, you spend less time wrestling with platform quirks and more time crafting immersive multiplayer experiences.

🔑 Key Features

  • Cross-Platform
    Write your game logic once and deploy it to alt:V, FiveM or RAGE MP, and any other supported runtimes without changing a single line of business code.

  • Modular Design
    Break your code into self-contained modules for core, client, server, and custom webviews—each managed by Aurora’s powerful module loader.

  • Event-Driven
    React to player actions, network events, and custom triggers via concise TypeScript decorators like @OnServer, @OnClient, and @OnWebview.

  • Type-Safe APIs
    Enjoy fully-typed interfaces for all core services (dependency injection, configuration, logging, webviews), with autocomplete and compile-time checks.

  • Webview Integration
    Build rich in-game UIs using standard web technologies (HTML/CSS/JS) and communicate seamlessly with your server and client-side code.

🌍 Supported Platforms

Aurora Multiplayer currently provides first-class support for the following multiplayer platforms:

  • alt:V (WIP) – A modern, high-performance GTA V multiplayer platform with strong TypeScript support.
    • Will possibly be removed, not implemented now that it has become Majestic MP
  • FiveM (Not yet) – Community-driven GTA V multiplayer mod with a massive ecosystem (experimental support via plugins).
  • RAGE MP (WIP, will be finalized soon) – A widely-used modding platform for GTA V, praised for its stability and extensive feature set.
  • YAMP - Maybe?
  • Other Runtimes – Easily extendable: create adapters for any GTA multiplayer environment of your choice.

🛠️ Getting Started

Documentation - WIP

🙏 Special Thanks

Aurora Multiplayer wouldn’t be possible without the inspiration and support from these amazing projects:

About

A cross-platform, TypeScript framework for multiplayer mods in Grand Theft Auto.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •