https://github.com/Burdigalax/BurdigalaxGUI

React GUI for RP Game.
https://github.com/Burdigalax/BurdigalaxGUI

Last synced: 3 months ago
JSON representation

React GUI for RP Game.

• Host: GitHub
• URL: https://github.com/Burdigalax/BurdigalaxGUI
• Owner: Burdigalax
• Created: 2019-12-20T22:21:47.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T17:59:06.000Z (about 2 years ago)
• Last Synced: 2024-08-03T16:15:03.093Z (6 months ago)
• Language: JavaScript
• Size: 7.72 MB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-onset - Burdigalax GUI - Beautiful React GUI for shop, gas station and inventory. (Packages and Plugins / Other packages)

README

        
# Burdigalax-project v4.7.1

Burdigalax project.

# Quick installation GUI

DOWNLOAD Burdigalax Packages to install on your ONSET server.  

:warning: If you move these files in a package other than "burdigalax" be sure to rename imports of js files in HTML files.

[![Download](./download.svg "Download") Download Burdigalax package GUI v4.7.1.](https://github.com//Burdigalax/BurdigalaxGUI/raw/master/ONSET_SERVER.4.7.1.zip)

# Avanced Usage

## Building and running on localhost

First install dependencies:

```sh

npm install

// or

yarn

```

To run in hot module reloading mode on localhost browser:

```sh

npm run start

// or

yarn start

```

To create a production build:

- Edit **config.js** file for specify your package server name.

```js

module.exports = {

  serverPackageName: "burdigalax"

};

```

- Execute build

```sh

yarn build

```

## Installation on you server

- Copy generate files on folder `dist/` to your server to `{serverPackageName}/client/gui/`  

  /!\ List of generated files to copy _(Exemple with onShop)_ : - onShop.html - onShop.burdigalax.js - vendors.burdigalax.js - commons.burdigalax.js

- For **Onset** game declare this files on your `package.json` server. _(Exemple with onShop)_

```json

  "files": [

    "client/gui/onShop.html",

    "client/gui/onShop.burdigalax.js",

    "client/gui/vendors.burdigalax.js",

    "client/gui/commons.burdigalax.js",

  ]

```

The commons and vendors files are the same and mandatory for all BurdigalaxRP modules.

## onShop

Readme : https://github.com/Burdigalax/BurdigalaxGUI/tree/master/src/app/onShop/README.md

## gasStation

Readme : https://github.com/Burdigalax/BurdigalaxGUI/tree/master/src/app/gasStation/README.md

## inventory

Readme : https://github.com/Burdigalax/BurdigalaxGUI/tree/master/src/app/inventory/README.md

### Contact

> Discord: RomBurdi#9770