Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bosonprotocol/boson-dcl
Boson Protocol - Metaverse Toolkit - Decentraland SDK
https://github.com/bosonprotocol/boson-dcl
Last synced: about 1 month ago
JSON representation
Boson Protocol - Metaverse Toolkit - Decentraland SDK
- Host: GitHub
- URL: https://github.com/bosonprotocol/boson-dcl
- Owner: bosonprotocol
- License: apache-2.0
- Created: 2022-08-18T10:11:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T15:29:41.000Z (about 1 year ago)
- Last Synced: 2024-11-22T20:36:30.200Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 19 MB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/code-of-conduct.md
Awesome Lists containing this project
README
[](https://bosonprotocol.io)
# Boson Protocol Metaverse Toolkit - Decentraland Library
This repo provides the first instance of the Boson Protocol Metaverse Toolkit. This will allow scene builders, in [Decentraland](https://play.decentraland.org/?position=-86%2C108), the ability to add a Boson Kiosk to their scene, that will allow potential buyers to buy Boson rNFTs directly from the Metaverse, interacting directly with the Boson Protocol on Polygon.
# Integrate **@bosonprotocol/boson-dcl** in your own Decentraland Scene
Create your Decentraland Scene and use BOSON to sell redeemable NFT for physical products.
See [README.md](./library/README.md)
# Contribute to **@bosonprotocol/boson-dcl** development
We welcome contributions! Until now, Boson Protocol has been largely worked on by a small dedicated team. However, the ultimate goal is for all of the Boson Protocol repositories to be fully owned by the community and contributors. Issues, pull requests, suggestions, and any sort of involvement are more than welcome.
If you have noticed a bug, please report them here as an issue.
Questions and feedback are always welcome, we will use them to improve our offering.
All PRs must pass all tests before being merged.
By being in this community, you agree to the [Code of Conduct](./docs/code-of-conduct.md). Take a look at it, if you haven't already.
Before starting to contribute, please check out Local development guide.
## Prerequisites
Install `decentraland` CLI
```
npm install -g decentraland
```
Ref: [Decentraland CLI documentation](https://github.com/decentraland/cli)
## Build the library
Note that, as a developer if you wish to use the Metaverse Toolkit in production you will need to provide your own [Biconomy account details](https://biconomy.io/) to the scene `scene/src/bosonConfig.ts`. We do provide example configurations for use on the Polygon's Testnet Mumbai, so that people can get up and running quickly.
```
cd library
```
```
npm install
```
```
npm run build
```
## Test the library
An example of a Decentraland scene using the library is provided in the **_'scene'_** sub-folder.
```
cd scene
```
```
npm install
```
```
npm run build
```
```
dcl start --web3
```
## How to publish the library
A Github action automatically runs when a Release is created
# License
Licensed under [Apache v2](./LICENSE)