Skip to content

Commit

Permalink
meta: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dot-mike committed Dec 11, 2024
1 parent 043eb0b commit af704f2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ A sample extension that demonstrates how to create a simple extension for Flashp

Clone the repository and run `npm install` to install the dependencies.

Normal workflow is to first package the extension so you get the required files in `Package` directory. Copy the extension to `Flashpoint\Data\Extensions` and then run `npm run watch` to start the development server. After a build you have copy the file `Dist` directory to `Flashpoint\Data\Extensions` and do a hot-reload in the launcher by pressing `Ctrl+Shift+R` to see the changes.
Normal workflow is to first package the extension so you get the required files in `package`-directory.

After that you can run `npm run watch` to start the development server. The built file `ext.js` will be placed in the `dist`-directory can be copied to `Flashpoint\Data\Extensions\hello-world` directory.

## Build

Run `npm run build` to build the extension in development mode.

## Package

Run `npm run package` to build a distributable package of the extension. A new directory will be created in the `package`-directory that can be copied to `Flashpoint\Data\Extensions`. The `extensions.fplx` is just a renamed zip-file that can be used to distribute the extension, but it's not possible to install it directly from the Flashpoint Launcher.
Run `npm run package` to build a distributable package of the extension. A new directory named `hello-world` will be created in the `package`-directory that can be copied to `Flashpoint\Data\Extensions`. The new file `extensions.fplx` is just a renamed zip-file that can be used to distribute the extension. Note that the launcher it self does not support installing extensions from these file types yet.

0 comments on commit af704f2

Please sign in to comment.