Skip to content

Commit

Permalink
Merge pull request #40 from yaserOSource/main
Browse files Browse the repository at this point in the history
Docs Update
  • Loading branch information
torchesburn committed Dec 2, 2021
2 parents 62493c7 + 6f82800 commit 695faa7
Showing 1 changed file with 52 additions and 2 deletions.
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Metaverse Loader/Codec
## Woader? Moader? Moadec.
# Totum

This library takes an arbitrary URL (https://, ethereum://, and more) and compiles it into a THREE.js app representing it, written against the Metaversefile API.

Expand All @@ -10,3 +9,54 @@ The metaverse loader is intended to be driven by a server framework (like vite.j
It is easy to define your own data types and NFT interpretations by writing your own app template. If you would like to support a new file format or Ethereum Token, we would appreciate a PR.

Although this library does not provide game engine facilities, the API is designed to be easy to hook into game engines, and to be easy to drive using AIs like OpenAI's Codex.

---

## Usage

```js

let object;
try {
object = await metaversefileApi.load(url);
} catch (err) {
console.warn(err);
}
return object;

```

### Inputs
* url: {URL of the asset that can be downloadable by the screenshot system} **[Required]**

### Returns
* Promise:

### Output
* Object of application

### Supported Assets
* `VRM`
* `VOX`
* `JS`
* `SCN`
* `LIGHT`
* `IMAGE`
* `HTML`
* `GROUP`
* `GLBB`
* `GLB`
* `GIF`
* `FOG`
* `Background`

---
## Architecture

### Flow Diagram

![Totum diagram 02](https://user-images.githubusercontent.com/51108458/144339720-354aa56d-aa61-4e96-b49c-bf9e652d1f48.png)



---

0 comments on commit 695faa7

Please sign in to comment.