amxxpack 1.3.1 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/lib/cli/services/project-creator.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ Simple build system and **CLI** for **AMX Mod X** projects.
|
|
|
3
3
|
|
|
4
4
|
## 📄 About
|
|
5
5
|
|
|
6
|
-
This system will be useful for projects with multiple plugins and assets. Using the command-line interface you can build entire project with a single command. It also supports hot rebuild to keep your plugins and assets up to date during the work.
|
|
6
|
+
This system will be useful for projects with multiple plugins and assets. Using the command-line interface you can build an entire project with a single command. It also supports hot rebuild to keep your plugins and assets up to date during the work.
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
## 📚 Features
|
|
@@ -29,7 +29,7 @@ npm install -g amxxpack
|
|
|
29
29
|
## ▶ Quick start
|
|
30
30
|
- Open a terminal inside the project directory (existing or create a new one)
|
|
31
31
|
- Execute `npm install amxxpack -g` command to install `amxxpack` globally
|
|
32
|
-
- Execute `amxxpack create .` command to create new config
|
|
32
|
+
- Execute `amxxpack create .` command to create a new config
|
|
33
33
|
- Execute `amxxpack install` to download project dependencies (compiler, thirdparty etc.)
|
|
34
34
|
- Use `amxxpack build` command to build the project
|
|
35
35
|
- Use `amxxpack watch` command to build the project and watch changes
|
|
@@ -37,11 +37,11 @@ npm install -g amxxpack
|
|
|
37
37
|
## 📋 Commands
|
|
38
38
|
- `amxxpack create <name>` - create new project
|
|
39
39
|
- `--git` - initialize git
|
|
40
|
-
- `--nonpm` - don't initialize npm
|
|
40
|
+
- `--nonpm` - don't initialize the npm package
|
|
41
41
|
- `--version` - project version
|
|
42
42
|
- `--author` - project author
|
|
43
43
|
- `--description` - project name
|
|
44
|
-
- `amxxpack config` - initialize project config in current workspace
|
|
44
|
+
- `amxxpack config` - initialize project config in the current workspace
|
|
45
45
|
- `amxxpack install` - install project dependencies
|
|
46
46
|
- `--config` - config file
|
|
47
47
|
- `amxxpack build` - command to build the project
|
|
@@ -52,14 +52,14 @@ npm install -g amxxpack
|
|
|
52
52
|
- `amxxpack compile <path|glob>` - compile specific plugin in the project
|
|
53
53
|
- `--config` - config file
|
|
54
54
|
- `--no-cache` - disable caching
|
|
55
|
-
- `amxxpack new <script|lib|include> [name]` - create new file in the project workspace
|
|
55
|
+
- `amxxpack new <script|lib|include> [name]` - create a new file in the project workspace
|
|
56
56
|
- `--config` - config file
|
|
57
57
|
- `--name` - plugin name
|
|
58
58
|
- `--version` - plugin version
|
|
59
59
|
- `--author` - plugin author
|
|
60
60
|
- `--lib` - library name
|
|
61
61
|
- `--include` - include list separated by a comma
|
|
62
|
-
- `--overwrite` - overwrite file if it already exists
|
|
62
|
+
- `--overwrite` - overwrite the file if it already exists
|
|
63
63
|
- `amxpack i` - alias to `install` command
|
|
64
64
|
- `amxpack n` - alias to `new` command
|
|
65
65
|
- `amxpack b` - alias to `build` command
|
|
@@ -83,7 +83,7 @@ In case your project requires third-party modules you can specify a link to thir
|
|
|
83
83
|
}
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
configuration above will download `somemodule-v100.zip` archive and extract it to the `./.thirdparty/somemodule` directory then you can use thirparty files in your project. For example add
|
|
86
|
+
the configuration above will download `somemodule-v100.zip` archive and extract it to the `./.thirdparty/somemodule` directory then you can use thirparty files in your project. For example, add a third-party directory to the include list:
|
|
87
87
|
```json
|
|
88
88
|
{
|
|
89
89
|
"include": [
|
|
@@ -130,7 +130,7 @@ or exclude `*.tga` and `*.wav` files:
|
|
|
130
130
|
}
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
You can also specify subdirectories for copying. With this configuration the builder will copy all files from `./assets/models` to `./models/myproject` of the project build directory.
|
|
133
|
+
You can also specify subdirectories for copying. With this configuration, the builder will copy all files from `./assets/models` to `./models/myproject` of the project build directory.
|
|
134
134
|
```json
|
|
135
135
|
{
|
|
136
136
|
"input": {
|
|
@@ -192,7 +192,7 @@ var ProjectCreator = /** @class */ (function () {
|
|
|
192
192
|
case 1:
|
|
193
193
|
_a.sent();
|
|
194
194
|
configPath = path_1.default.join(this.projectDir, config_1.default.projectConfig);
|
|
195
|
-
return [4 /*yield*/, fs_1.default.promises.writeFile(configPath, JSON.stringify(
|
|
195
|
+
return [4 /*yield*/, fs_1.default.promises.writeFile(configPath, JSON.stringify(project_config_1.default.defaults, null, 2))];
|
|
196
196
|
case 2:
|
|
197
197
|
_a.sent();
|
|
198
198
|
return [2 /*return*/];
|