Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

@lcluber/orbisjs

0.5.3 • Public • Published

Synopsis

Orbis.js is an asynchronous assets loader written in Javascript.

  • Setup your json config file containing all your assets (images, textures, sprites, sounds, musics, texts, jsons),
  • launch the loader and use onProgress callback to set your own progress bar design,
  • wait for onComplete callback to start using your freshly loaded assets.

Motivation

The main purpose of this library is to provide a simple way to load assets only when needed instead of loading everything when the main page loads.

Installation

$ npm install @lcluber/orbisjs

Or download it here.

Demo

See a basic example here.

Usage

Learn how to use it here.

API Reference

Read the documentation here.

Tests

No tests to run yet

Contributors

There is still a lot of work to do on this project and I would be glad to get all the help you can provide. To contribute you can clone the project on GitHub and see NOTICE.md for detailed installation walkthrough of the project.

License

MIT License

Copyright (c) 2011 Ludovic CLUBER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

install

npm i @lcluber/orbisjs

version

0.5.3

license

MIT

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability