@pizzapopcorn/unijs 0.0.5 → 0.0.7
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 +24 -24
- package/dist/unity.js +902 -505
- package/dist/unity.min.js +1 -1
- package/package.json +44 -39
package/README.md
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
# UniJS - WebGL Interop (Library)
|
|
2
|
-
|
|
3
|
-
## Prerequisites
|
|
4
|
-
- Your Unity WebGL build must have the [Unity plugin package](https://github.com/PizzaPopcorn/unijs) installed and implemented (instructions provided in the README of that repo).
|
|
5
|
-
- If you want to customize the library you need to have [Node.js](https://nodejs.org) installed.
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
IMPORTANT: You don't have to clone/fork this repository if you just want to use the library without modifying it. Use CDN in that case.
|
|
9
|
-
|
|
10
|
-
For getting the latest version in your project just paste this line in the html page that will load the Unity instance:
|
|
11
|
-
```javascript
|
|
12
|
-
<script src="https://cdn.jsdelivr.net/npm/@pizzapopcorn/unijs/dist/unity.min.js"></script>
|
|
13
|
-
```
|
|
14
|
-
Now if you want to customize the library you can clone/fork this repository and follow the build steps.
|
|
15
|
-
|
|
16
|
-
## Build
|
|
17
|
-
Building is pretty straightforward, just do the modifications you need and then run the following command:
|
|
18
|
-
```bash
|
|
19
|
-
npm run build
|
|
20
|
-
```
|
|
21
|
-
That will create `unity.js` and `unity.min.js` files that you can manually import to your web page project.
|
|
22
|
-
|
|
23
|
-
## Additional Notes
|
|
24
|
-
Notice that this library is designed to be only compatible with browser since that's where Unity runs. That being said, there is no need to import the npm package in any scenario, it just exists for the sake of the CDN download.
|
|
1
|
+
# UniJS - WebGL Interop (Library)
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
- Your Unity WebGL build must have the [Unity plugin package](https://github.com/PizzaPopcorn/unijs) installed and implemented (instructions provided in the README of that repo).
|
|
5
|
+
- If you want to customize the library you need to have [Node.js](https://nodejs.org) installed.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
IMPORTANT: You don't have to clone/fork this repository if you just want to use the library without modifying it. Use CDN in that case.
|
|
9
|
+
|
|
10
|
+
For getting the latest version in your project just paste this line in the html page that will load the Unity instance:
|
|
11
|
+
```javascript
|
|
12
|
+
<script src="https://cdn.jsdelivr.net/npm/@pizzapopcorn/unijs/dist/unity.min.js"></script>
|
|
13
|
+
```
|
|
14
|
+
Now if you want to customize the library you can clone/fork this repository and follow the build steps.
|
|
15
|
+
|
|
16
|
+
## Build
|
|
17
|
+
Building is pretty straightforward, just do the modifications you need and then run the following command:
|
|
18
|
+
```bash
|
|
19
|
+
npm run build
|
|
20
|
+
```
|
|
21
|
+
That will create `unity.js` and `unity.min.js` files that you can manually import to your web page project.
|
|
22
|
+
|
|
23
|
+
## Additional Notes
|
|
24
|
+
Notice that this library is designed to be only compatible with browser since that's where Unity runs. That being said, there is no need to import the npm package in any scenario, it just exists for the sake of the CDN download.
|