repository·master·Indexed 42 days ago
https://github.com/stuyk/altv-athenaA roleplay framework, script, and development toolkit for creating GTA:V servers on the alt:V platform. Built with TypeScript, Vue 3, NodeJS, Vite, and MongoDB, it provides a foundation of scripts, a cinematic camera system, and a client API for developers. Note: This framework is no longer being updated; Rebar Framework is recommended for current projects.
Athena is a free Roleplay framework, script, and toolkit designed for developers building GTA:V servers on the alt:V platform. It utilizes a modern tech stack including TypeScript, Vue 3, NodeJS, Vite, and MongoDB.
⚠️ IMPORTANT NOTICE: Athena is no longer being updated. For up-to-date practices and a plugin system, it is recommended to use the Rebar Framework instead.
The clothing images in this repository follow a specific pseudo-naming convention to map image files to in-game assets. The format is:
componentIdentifier-hashedDlcName-isProp?-isNotShared?-drawableID.png
To correctly identify or use an image, you must reconstruct this string based on the component type, the DLC hash, whether it is a prop, its gender exclusivity, and the drawable ID.
componentIdentifier-hashedDlcName-isProp?-isNotShared?-drawableID.pnghashedDlcName segment of the filename is generated using the alt.hash function from the alt:V API. When adding your own DLC images, you must use this same function to determine the correct hash name for your DLC to ensure compatibility with the naming scheme.The Basic Authentication plugin provides username and password authentication alongside a recovery seed phrase system.
When a user creates an account, a recovery seed phrase (consisting of 24 words) is generated. This phrase acts as the ultimate fallback for account recovery.
Key Security Details:
server.toml. These files allow you to switch between different environment modes (Development, Testing, Production) by selecting the appropriate JSON configuration. You should adjust these files based on your specific environment requirements.Choose one of the following configuration files based on your current development or deployment stage:
The components located in src-webviews/src/components are purpose-built specifically for Athena.
Warning: These components are shared across the entire system. Any changes made to their styling or behavior will propagate to every interface that uses them. Exercise caution when restyling or altering their logic to avoid unintended consequences across different parts of the application.
To begin developing a roleplay server with Athena, follow these steps to install the required software and clone the repository.
Ensure you have the following installed on your system:
Run these commands in your Terminal or PowerShell to clone the project and install dependencies:
git clone https://github.com/Stuyk/altv-athena
cd altv-athena
npm install
npm run update
npm run windowsThe RMLUI sprite management API allows you to render images at specific 3D world positions or screen positions using RMLUI. Sprites automatically scale based on their distance from the local player and can handle occlusion (blocking) and touch events.
Key Features:
DEFAULT_DRAW_DISTANCE of 20 units.opacity: 0.1) if an entity is blocking the line of sight between the player and the sprite.callOnceOnTouch callback that triggers when the player is within a TOUCH_DISTANCE of 2 units.@plugin/ prefix.import { create, update, remove } from './path-to-this-module';
// Example: Creating a sprite
create({
uid: 'my-unique-sprite',
path: '@plugin/my-plugin/client/icon.png',
width: 64,
height: 64,
position: { x: 100, y: 200, z: 50 },
callOnceOnTouch: (uid) => {
console.log(`Sprite ${uid} was touched!`);
}
});When building a menu, you can use different option types to control how users interact with the menu items. Use createOption<T>(...) to ensure type safety.
| Type | Behavior |
|---|---|
Invoke | A simple button. Executes the callback immediately when ENTER is pressed. |
Toggle | A boolean switch. Pressing ENTER flips the value and executes the callback. |
Range | A numeric slider. Use left/right to adjust by increment. If onlyUpdateOnEnter is false, the callback fires on every adjustment. If true, it only fires when ENTER is pressed. |
Selection | A dropdown-style menu. Use left/right to cycle through the options array. If onlyUpdateOnEnter is false, the callback fires on every change. |
Input | A text input field. Pressing ENTER triggers an RMLUI input prompt. The result is passed to the callback. |
RMLUI menus are constructed using a MenuInfo object which contains a header and an array of options. Each option must have a type that determines its behavior and required properties. All options inherit a base set of properties: title (string), description (string), and a callback function that executes when the option is interacted with.
Supported option types are:
Selection: A list of values to choose from.Toggle: A boolean switch.Range: A numeric slider with min/max bounds.Input: A simple trigger/button (type: 'Invoke').Invoke: A text input field (type: 'Input').Athena distinguishes between three types of webview content:
closeOnEscapeCallback when opening them.registerPersistentPage.When a standard page is closed via the Escape key, Athena automatically hides all overlays and then shows them again once the page is gone.