Rebar for alt:V

Rebar is a TypeScript framework for alt:V that prioritizes plugins, translations. Rebar was inspired by Athena and meant to take Athena's best features and create a framework that gives developers a quick starting point.

Plugins for Rebar allow developers to drag & drop repositories into their server framework.

Features

• TypeScript
• Plugins
• Locale / Translation Support
• Path Aliasing
• Transpiling
• Reload
• Webview Overlays, Persistent Pages, and Single Pages
• Vue 3
• TailwindCSS

Requirements

This is not optional, install these programs.

• Node.js
• pnpm
• MongoDB Server
  • Ensure that if you are running it locally, do not set a database password.
  • When you move your server to production use something like MongoDB Atlas

Usage

git clone https://github.com/Stuyk/rebar-altv

cd rebar-altv

pnpm i

pnpm binaries

pnpm start

Structure

A folder structure that is simple to read, and simple to write.

├───main
│   ├───client
│   ├───server
│   ├───shared
│   └───translate
└───plugins
    └───your-plugin
        ├───client
        │   └───index.ts
        ├───server
        │   └───index.ts
        ├───translate
        │   └───index.ts
        └───webview
            └───MyCustomPage.vue

Documentation

https://stuyk.github.io/rebar-altv

If you wish to run documentation locally, you can do the following:

pnpm install retypeapp --global

retype start ./docs