# hf-scripts

> Scripts for the hf template project

Latest version **0.5.1** (published 2023-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install hf-scripts
pnpm add hf-scripts
yarn add hf-scripts
bun add hf-scripts
```

Provides the commands `startup`, `comp-server`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2023-06-06 |
| First published | 2023-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20 |
| Dependencies | 4 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Richard Oliver Bray |
| Maintainers | robray |
| Keywords | haxe, haxeFlixel, gamedev |

## Links

- npm: https://www.npmjs.com/package/hf-scripts
- Repository: https://github.com/RichardBray/hf-scripts
- Homepage: https://github.com/RichardBray/hf-scripts#readme
- Issues: https://github.com/RichardBray/hf-scripts/issues
- npm.io page: https://npm.io/package/hf-scripts

## Dependencies (4)

- [log-update](https://npm.io/package/log-update.md) ^5.0.1
- [http-server](https://npm.io/package/http-server.md) ^14.1.1
- [chokidar-cli](https://npm.io/package/chokidar-cli.md) ^3.0.0
- [concurrently](https://npm.io/package/concurrently.md) ^8.1.0

## Recent versions

- 0.5.1 (latest) — 2023-06-06
- 0.5.0 — 2023-06-06
- 0.4.5 — 2023-03-31
- 0.4.4 — 2023-03-30
- 0.4.3 — 2023-03-30
- 0.4.2 — 2023-03-30
- 0.4.1 — 2023-03-30
- 0.4.0 — 2023-03-30

## README

# HF-Scripts
Scripts used in the unofficial HaxeFlixel template.

## Install

Then you can install the scripts on your relevant project
`npm i hf-scripts`

You need to make sure your project has the following dependencies installed before this will work:
- chokidar-cli
- concurrently
- http-server

The scripts file depends on the commands form these packages to work properly.

## Config file

You can create a configuration file to change a few things. Here are the default configuration settings for a project:

```js
const defaultOptions = {
  /**
   * Port that the webserver runs on.
   */
  webServerPort: 1212,
  /**
   * If this is set to true it will connect to the `compServerPort`.
   * And cache a HTML5 build of the game if `allowFirstBuild` is true to speed up subsequent builds.
   */
  useCompServer: true,
  /**
   * Builds the game for HTML5 before running the webserver.
   * Used for caching purposes so only works if `useCompServer` is true.
   */
  allowFirstBuild: true,
  /**
   * Port for compilation server
   */
  compServerPort: 8000,
  /**
   * Displays a notification in the OS when a build is complete.
   * Currently this only works on MacOS.
   */
  displayNotification: true,
};

```

## Support

If you've found this package useful and want to support me, you can [buy me a coffee](https://ko-fi.com/richardoliverbray).

If you to know more about me [check out my website](https://robray.dev/).

---
_Source: https://npm.io/package/hf-scripts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._