https://github.com/bf3rm/vextpack

A webpack plugin to automatically build a vuic file for Venice Unleashed
https://github.com/bf3rm/vextpack

venice-unleashed vext vuic webpack

Last synced: 11 days ago
JSON representation

A webpack plugin to automatically build a vuic file for Venice Unleashed

• Host: GitHub
• URL: https://github.com/bf3rm/vextpack
• Owner: BF3RM
• License: mit
• Created: 2019-10-13T10:30:44.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T10:51:20.000Z (about 2 years ago)
• Last Synced: 2024-10-15T04:32:51.972Z (3 months ago)
• Topics: venice-unleashed, vext, vuic, webpack
• Language: TypeScript
• Homepage:
• Size: 192 KB
• Stars: 4
• Watchers: 12
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VextPack

A webpack plugin to automatically build a vuic file for Venice Unleashed

## Problem

Venice Unleashed uses a .vuic file to pack the WebUI of a mod. Developers can use the vuic compiler to generate this file. The problem however is that when you use something like Webpack you really only wanna run one build command and be done. This plugin does exactly that, it generates a .vuic file after the files are built.

## Installation

With npm

```

npm install --save-dev vextpack

```

With yarn

```

yarn -D vextpack

```

## Usage

When installing VextPack it will automatically download the latest vuicc.exe, so you don't have to download it.

Using VextPack is simple, it is just a regular Webpack plugin and can be used as follows:

```js

// webpack.config.js

const { VextPackPlugin } = require('vextpack');

module.exports = {

    // ...

    plugins: [

        new VextPackPlugin({

            // OPTIONAL: Specify the location where the ui.vuic should be placed, defaults to '../'

            outputPath: '../',

            // OPTIONAL: Make a hot reloadable ui build, this creates a proxy ui that remotely loads the real ui

            hotReloadSupport: process.env.NODE_ENV !== 'production'

        })

    ]

}

```