@rpack-dev/core 0.1.14 → 0.1.15

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 ADDED
@@ -0,0 +1,30 @@
1
+ # rpack-dev
2
+ ![NPM Version](https://img.shields.io/npm/v/@rpack-dev/core?logo=npm)
3
+
4
+ A Resource Pack editor for Minecraft
5
+
6
+ This repository contains the core API of rPack.dev.
7
+
8
+ # Building
9
+ ```bash
10
+ npm run build
11
+ ```
12
+
13
+ The resulting files will be in the `dist` folder.
14
+
15
+ # Development
16
+ When new files are added (or old files are removed), you need to update the barrel file running the `prebuild:barrel` script.
17
+ ```bash
18
+ npm run prebuild:barrel
19
+ ```
20
+
21
+ **Watch mode** allows you to quickly iterate on the project while still seeing errors. This can be started by running the `watch` script.
22
+ ```bash
23
+ npm run watch
24
+ ```
25
+
26
+ There are two different ways to load the development instance.
27
+ ## Using a Local Override
28
+ When Watch mode is enabled, the application automatically starts an rPack.dev development server (or connects to an existing instance).
29
+ Using this, you can use a real rPack.dev instance (either a local offline instance or a deployed version online, such as at [app.rpack.dev](https://app.rpack.dev)) and **enable a local override** for the core module. (Currently, as there is not much functional UI, this
30
+ is automatically enabled). If this is enabled, then