8000 GitHub - tomhmagic/add-on-registry: A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-add-ons to display accurate information about packs. · GitHub
[go: up one dir, main page]

Skip to content

About

A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-add-ons to display accurate information about packs.

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

29 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Add-On Registry

A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-add-ons to display accurate information about packs.

If you are an add-on creator, you are welcome to add your pack to the registry so that it can be displayed accurately in other add-ons that display information about content from various add-ons.

Contribution

To add your pack, add an entry to registry.js with the required details, and submit it via pull-request.

Information:

  • Key: The key under which you add an entry should be the ID of your add-on. This should be the namespace that your add-on uses for blocks, entities etc.
  • name: The name of the add-on.
  • creator: The name of the creator or studio that created the add-on.

Please leave a trailing comma at the end of the list and use 4 spaces for indentation to make merging easier! You can also write your entries at any position in the list, not only at the end. That helps reduce merge conflicts.

Including it in your pack

To use the registry in your project, install it via NPM from this repository:

npm i https://github.com/Bedrock-OSS/add-on-registry

You can now use it in your project like this:

import { Registry } from "bedrock-add-on-registry"

function getAddOnName(identifier) {
    const namespace = identifier.split(":")[0];
    const entry = Registry[namespace];
    // Use the namespace itself as fallback
    return entry ? entry.name : namespace;
}

Alternatively, if you are not using a bundler, you can also copy the file registry.js and use it in your project.

About

A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-add-ons to display accurate information about packs.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0