# pheanut

> Phina.js Framework

Latest version **0.4.3** (published 2021-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install pheanut
pnpm add pheanut
yarn add pheanut
bun add pheanut
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.3 |
| Published | 2021-01-06 |
| First published | 2020-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 489.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | ynatani |
| Maintainers | yn1323 |
| Keywords | Phina.js |

## Links

- npm: https://www.npmjs.com/package/pheanut
- Repository: https://github.com/yn1323/pheanut
- Homepage: https://github.com/yn1323/pheanut#readme
- Issues: https://github.com/yn1323/pheanut/issues
- npm.io page: https://npm.io/package/pheanut

## Dependencies (3)

- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [phina.js](https://npm.io/package/phina.js.md) git://github.com/phinajs/phina.js.git#develop
- [@fortawesome/fontawesome-free](https://npm.io/package/@fortawesome/fontawesome-free.md) ^5.13.0

## Recent versions

- 0.4.3 (latest) — 2021-01-06
- 0.4.2 — 2021-01-05
- 0.4.1 — 2021-01-05
- 0.4.0 — 2021-01-05
- 0.3.1 — 2020-05-08
- 0.3.0 — 2020-05-08
- 0.2.1 — 2020-05-05
- 0.2.0 — 2020-05-05
- 0.1.2 — 2020-02-11
- 0.1.1 — 2020-02-11
- 0.1.0 — 2020-02-11
- 0.0.2 — 2020-02-11
- 0.0.1 — 2020-02-10

## README

# Pheanut

## 概要
国産2Dゲームライブラリ [Phina.js](https://phinajs.com/)を少しだけ使いやすくするツール

### 機能
- フォルダ構成を作成
- hot reload
- linter
- assets/scenes用ファイルの自動生成
- 状態管理の追加

## 必要な環境
- Node.js
- npm(最新のNode.jsがあれば不要)

## はじめかた(最初に1回だけ実行)

1. 新規フォルダを作成
   ```bash
   mkdir pheanut
   ```
1. 作成したフォルダに移動
   ```bash
   cd pheanut
   ```
1. npmの初期化
   ```bash
   npm init
   ```
1. Pheanutの追加
   ```bash
   npm install --save-dev pheanut
   ```
1. Pheanutの中身を展開
   ```bash
   node ./node_modules/pheanut/bin
   ```
1. packageのinstall
   ```bash
   node run install
   ```

## 始め方
1. 始め方
   ```bash
   node run start
   ```

## 機能
### フォント
1. ドットフォントの使用
   - server/config.js useDotFont -> true
1. AwesomeFontの使用
   - server/config.js useIconFont -> true

## 便利コマンド
```bash
# assets/scenesのファイルを作成
# assets追加、scene追加時に必ず実行すること
npm run auto
```

```bash
# hot reload
npm run start
```

```bash
# ビルド(作品完成時に実行)
npm run build
```

```bash
# lint
npm run lint
```

## Author
ynatani

## License
MIT

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