web-bundle - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #llm #golang #go #deep-learning #windows #awesome #cli #kubernetes #awesome-list #vue #security

web-bundle

(★ 362)

Tool to pack binary files into a PNG image.

파일 탐색기

최종 버전 다운로드 (.zip)

- - resource-pass.wb
  - resource.wb
- - wb.js
  - wb.min.js
- app-haxe.js
- index-haxe.html
- index-js.html
- Bundle.hx
- data-encrypted.wb.png
- data.json
- data.wb.png
- index.js
- portrait.png
- xml.dae
- Bundle.js
- index.js
- wb.js
.gitignore
haxelib.json
LICENSE.md
package.json
README.md
WebBundleHaxe.hxproj
WebBundleJS.hxproj
WebBundleTest.hx

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/eduardo-costa/web-bundle

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd web-bundle

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Web Bundle

* Tool to pack binary files into a PNG image.
* Users can load a `bundle.wp` file and extract its data indexed by the original file's path.
  * A file in the folder `root/img/logo.png` can be accessed by `bundle.read("img/logo.png") == Uint8Array`
  * Helper methods allow users to read the desired data format.
    * `var d = bundle.readJSON("data/file.json") == object`
	* `var s = bundle.readText("data/file.txt") == string`
	* `var img = bundle.readImg("img/logo.jpg") == ImageElement`

## Example Bundle
This PNG contains the following files:

* xml.dae
* data.json
* portrait.png

![packed bundle](https://raw.githubusercontent.com/haxorplatform/web-bundle/1.0/test/data.wb.png)

# Why Bundle stuff ?

* Significantly reduce the number of HTTP requests allowing fast page loads
* Text data can be at least 40% compressed
* Browsers decompression routines are native and fast
* Games can greatly benefit of the compression and data packing
* No need to create and manage your own pack data type

## Compression [CLI]
* Install the `wb` tool with `$ npm install web-bundle`, or find it in `tool/wb.js`
* In the command line, run `$ wb encode -o my-bundle.wb foo.json bar.png`
* After running, `foo.json` and `bar.png` will be stored in `my-bundle.png`
* Use `--output` or `-o` to choose the output location for the bundle
* Use `--add` or `a` to add files to an existing bundle instead of creating a new one
* See `wb --help` for more

## Compression [Node.JS]
* Install web-bundle with `npm install --save web-bundle`
```javascript
var wb = require('web-bundle');

var bundle = new wb.Bundle();
bundle.addFile('foo.png', function(err) {
  // some/dir/foo.png has been added to the bundle
  
  bundle.write('bundle.wb', function(err) {
    // Bundle written
  });
});
```

## Decompression [JavaScript, browser]
* Add the scripts `deploy/js/wb.js` or `deploy/js/wb.min.js`  to your page. 
```javascript
var b = new Bundle();
b.load("data/output.wb",function(bundle,progress)
{
	if(progress >= 1.0)
	{
		if(bundle != null)
		{
			bundle.read[Text|JSON|Img|...]("data-id");
		}
	}
},[password]);
```

## Decompression [Haxe]
* Make sure `<script src='js/wb.js'/>` exists in your page.
* Make sure the `web-bundle` library is installed and linked in your project.
  * Use `haxelib` to install the library.
  * `haxelib git web-bundle https://github.com/haxorplatform/web-bundle.git 1.0`
	  
```haxe
import js.Bundle;

var b : Bundle = new Bundle();
b.load("data/output.wb",function(bundle:Bundle,progress:Float)
{
	if(progress >= 1.0)
	{
		if(bundle != null)
		{
			bundle.read[Text|JSON|Img|...]("data-id");
		}
	}
},[password]);
```

## Decompression [Node.JS]
* Install with `$ npm install --save web-bundle`
```javascript
var wb = require('web-bundle');

var bundle = new wb.Bundle();
bundle.load('my-bundle.wb', function(err) {
  // Bundle loaded
  bundle.read('foo.json') // -> Buffer
  bundle.readString('foo.json') // -> string
  bundle.readJSON('foo.json') // -> Object
});
```

## Decompression [CLI]
* Install the `wb` tool with `$ npm install web-bundle`, or find it in `tool/wb.js`
* To see the contents of a bundle, run `$ wb ls my-bundle.wb`
* To extract all files, use `$ wb decode my-bundle.wb`
* Specify an output location with `--output` or `-o`: `$ wb decode my-bundle.wb --output some/dir`
* Extract a single file with `--extract` or `-e`: `$ wb decode my-bundle.wb --extract foo.png`
* See `$ wb --help` for more