Introduction

A subscription based GTA:V Roleplay Framework for alt:V.

Summary

This project solely exists as a new standard for GTA 5 roleplay scripts on the alt:V client. The Athena Roleplay Script for GTA 5 has type safety through TypeScript and a solid foundation for what is considered core for a Roleplay server. You can find a list of features for the Athena Roleplay Script below in the Feature List section.

You will have to do some general script writing and know Javascript or Typescript to fully understand what this script has to offer. The script itself takes some of the harder pieces of writing a roleplay script for GTA 5 and makes them more accessible.

This is a framework and not a out-of-the-box full-featured script. This framework aims to provide the bare minimum necessary to help you get your server running at a much faster rate.

Where to Purchase?

Configuration files may be purchased from Gumroad.

No there is not a lifetime package for Athena.

Demo Server?

We have a small demo server available for you to test the framework with Administrative capabilities. You can check that out using the alt:V client at https://altstats.net/server/504‚Äč

Feature List

  • Fully Open Source

  • Typescript

  • Scalable Folder Structure

  • Basic Unit Test Support

  • Character Editor

  • Character Selection

  • Character Info Support

  • Character Appearance Synchronization

  • Whitelist

    • Discord Role / Bot Integration

    • Console Commands

  • Console Commands

    • Ban

    • Unban

    • Kick

    • KickAll

    • SetAdmin

    • Dox

    • Screenshot

    • Add to Whitelist

    • Remove from Whitelist

  • Food & Water System

    • Customizable Food / Water

    • Restore Food / Water with Items

  • Player

    • Health Synchronization

    • Armour Synchronization

    • Play 3D Custom Sounds (Short)

    • Play 2D Custom Sounds (Short)

  • Name Tags

    • Display after 7.5s (Used for Hiding Names Partially)

    • Names Hidden in Vehicles

  • Easy Discord Login / Authentication (alt:V Ares)

  • Admin System

    • Utilizes the Permission System

    • Various Admin Commands

    • NoClip Command

  • Chat System

    • Send Messages to Closest Players

    • Create Custom Commands

    • Assign Permission Values to Commands

  • Voice System

    • Uses built-in Voice by alt:V

    • Spatial, and Distance Built-in

    • Can be toggled off for the classic SAMP experience

  • Permission System

    • A basic permission system for running commands.

    • Allows commands to be restricted to specific groups.

  • World

    • Synchronized World Time

    • Synchronized Weather Patterns

    • Different Weather Based on Region

    • Adjustable Configuration

    • Performance Grid for Object Interactions / Finding

  • Interaction System

    • Parse Objects by Section

    • Add Custom Interactions Easily

    • Colshape System to Represent Interaction Points

    • ATM Object Interaction

  • Blip System

    • Global Blip Controller

    • Repeat Blips are Streamed

    • Automatically Generate Blips for Useable Objects (Atms, Fuel, etc.)

  • Marker System

    • Global Marker Controller

    • Easily add and remove global markers

  • Text Label System

    • Global Text Label Controller

    • Easily add and remove text labels

  • Section System

    • World split into Sections

    • Split Sections Help with Performance

    • Lookup Closest Players by Section / Slice

  • Currency System

    • Deposit Currency

    • Withdraw Currency

    • Transfer Bank Currency

  • Vehicle System

    • Control Vehicle Door States

    • Control Vehicle Door Locks

    • Handle Vehicle Ownership

    • Handle Vehicle Keys

    • Handle Vehicle Synchronization Pop-in

    • Seatbelt / Handle Window Fly-through

    • Personal Vehicle Spawner Menu

  • Inventory System

    • Drop Items

    • Pickup Items

    • Move Items

    • Multiple Slots for Items

    • Inventory Item Restriction Flags

    • Animations for Picking Up / Dropping

    • All Weapon Icons

    • Equipment Slots

    • Toolbar Slots

    • Custom Item Effects

    • CONSUMABLE Items

    • Custom Item Rules for Swapping, Equipping, Dropping, etc.

    • Item Swap

    • Item Stack

    • Item Equip / Unequip

    • Item Splitting

  • Clothing System

    • Clothing Selection

    • Tops

    • Hats

    • Bags

    • Bottoms

    • Shoes

    • Accessories

    • Bracelets

    • Watches

    • Masks

    • Name Individual Items

    • Describe Individual Items

    • Separate Item Equips

  • Toolbar System

    • Equip an item in a Toolbar Equippable Item

    • Press 1-4 to swap items in toolbar

  • Phone System

    • A built in phone.

    • Phone can handle custom applications.

    • Dealership App in Phone

    • Bank App in Phone

    • Vehicle Summoner in Phone

  • Custom Job Framework

    • Easy to Use Job Language / Creation

    • Play Animations

    • Play Particles

    • Play Sounds

    • Add Blips

    • Add Markers

    • Custom Waypoint Types... Go To, Capture, etc.

    • Custom Criteria: No Vehicle, No Weapon, etc.

    • Call Events on Objective Completions

    • Job Menu

  • Action Menus

    • Ifinitely scaling menus.

    • A menu system that calls other events easily.

    • Easily construct custom menus in minutes to define functionality.

  • Extendable Core Resource

    • Extend the core resource by writing your own code in the 'plugins' folder.

Running this Project

Please see the before setup page for setup instructions.