hitagi.js 开源项目教程

hitagi.js 开源项目教程

hitagi.jsJavaScript HTML5 game development framework项目地址:https://gitcode.com/gh_mirrors/hi/hitagi.js

1. 项目的目录结构及介绍

hitagi.js 项目的目录结构如下：

hitagi.js/
├── src/
│   └── lol.js
├── package.json
├── webpack.config.js
├── webpack.config.test.js
├── .eslintrc
├── test/
│   └── test_main.js
└── README.md

目录结构介绍：

• src/: 存放项目的主要源代码文件。
• src/lol.js: 项目的启动文件。
• package.json: 项目的配置文件，包含项目的依赖、脚本等信息。
• webpack.config.js: Webpack 的生产环境配置文件。
• webpack.config.test.js: Webpack 的测试环境配置文件。
• .eslintrc: ESLint 的配置文件，用于代码风格检查。
• test/: 存放项目的测试代码。
• test/test_main.js: 测试代码的主文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/lol.js。该文件是整个项目的入口点，负责初始化项目并启动应用。

3. 项目的配置文件介绍

package.json

package.json 是项目的配置文件，包含以下主要内容：

{
  "name": "hitagi.js",
  "version": "1.1.6",
  "description": "Game development framework",
  "main": "src/lol.js",
  "scripts": {
    "build": "webpack --mode production",
    "test": "webpack --config webpack.config.test.js && mocha test_output/test_main.js",
    "lint": "eslint src"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/Purpwood/hitagi.js.git"
  },
  "keywords": [
    "game",
    "gamedev",
    "framework",
    "hitagi",
    "ecs"
  ],
  "author": "Rogan Murley",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/Purpwood/hitagi.js/issues"
  },
  "homepage": "https://github.com/Purpwood/hitagi.js",
  "dependencies": {
    "howler": "^1.1.26",
    "lodash": "^4.17.15",
    "pixi.js": "^3.0.7"
  },
  "devDependencies": {
    "@babel/core": "^7.9.0",
    "@babel/preset-env": "^7.9.5",
    "babel-loader": "^8.1.0",
    "brfs": "^2.0.2",
    "eslint": "^5.7.0",
    "mocha": "^6.2.3",
    "simple-mock": "^0.2.14",
    "transform-loader": "^0.2.4",
    "webpack": "^4.43.0",
    "webpack-cli": "^3.3.11",
    "webpack-dev-server": "^3.10.3"
  }
}

主要配置项介绍：

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的启动文件路径。
• scripts: 项目的脚本命令，包括构建、测试和代码检查。
• repository: 项目的代码仓库地址。
• keywords: 项目的关键词，用于描述项目特性。
• author: 项目作者。
• license: 项目使用的开源许可证。
• bugs: 项目的问题跟踪地址。
• homepage: 项目的官方主页。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。

webpack.config.js

webpack.config.js 是 Webpack 的生产环境配置文件，用于打包项目代码。

webpack.config.test.js

webpack.config.test.js 是 Webpack 的测试环境配置文件，用于打包测试代码。

.eslintrc

.eslintrc 是 ESLint 的配置文件，用于定义代码风格检查规则。

总结

通过本教程，您已经了解了 hitagi.js 项目的目录结构、启动文件和配置文件。希望这些信息能帮助您更好地理解和使用该项目。

hitagi.jsJavaScript HTML5 game development framework项目地址:https://gitcode.com/gh_mirrors/hi/hitagi.js