https://github.com/mafineeek/rebar-inventory-starter

Starter "inventory" script for RP servers, that needs to be extended. Includes Value[1-4] parameters, custom names and simple Vue View with TailwindCSS & FontAwesome Icons
https://github.com/mafineeek/rebar-inventory-starter

Last synced: 1 day ago
JSON representation

Starter "inventory" script for RP servers, that needs to be extended. Includes Value[1-4] parameters, custom names and simple Vue View with TailwindCSS & FontAwesome Icons

• Host: GitHub
• URL: https://github.com/mafineeek/rebar-inventory-starter
• Owner: mafineeek
• Created: 2024-05-22T17:36:18.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T17:44:11.000Z (7 months ago)
• Last Synced: 2024-05-22T18:46:46.878Z (7 months ago)
• Language: TypeScript
• Size: 5.86 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Inventory Starter Plugin for Rebar Framework

This project is an **STARTER** inventory plugin designed for the Rebar framework, that can **and needs to** be extended. Interface is built with Vue 3 and TailwindCSS, and handles server-side inventory management using the Rebars database management and custom collection.

## Features

* Icon Support: Items can have icons from FontAwesome for better visual representation.

* Event-Driven: Communicates with the server using custom events.

* Customized items: Set Value[1-4] with custom values so you can handle different cases of one item type

* Factory: Items are based on custom created ItemFactory

```ts

import { ItemEntityType } from './ItemEntityType.js';

import { TestItem } from '../test/TestItem.js';

import * as alt from 'alt-server';

export const ItemFactory = {

    create: (data: any, player: alt.Player) => {

        switch (data.type) {

            case ItemEntityType.TestItem:

                return new TestItem(data, player);

        }

    }

}

```

## Installation

From the main directory of your `Rebar` installation.

```

git clone https://github.com/mafineeek/rebar-inventory-starter src/plugins/inventory

```

## API

There is no API provided for this plugin natively. It's just boilerplate to create your own inventory, so you can make it by yourself.

btw, first plugin for Rebar, cool tool 👻