Skip to main content

Addon page

The addon page fills the area beside the Catalog's addon list.

The default page​

Installing registerCatalog() generates a page from the addon metadata passed to core.register({ manifest }). It shows:

  • The addon's name, version and icon, with an optional thumbnail banner.
  • Its description and author names.
  • Config and Guide buttons, enabled when that addon registers the corresponding entry point.

Edit the authored manifest's header and metadata.authors to update display text and version. The icon comes from pack_icon.png; the optional top-level thumbnail supplies the banner. Addon manifests describes asset paths and metadata defaults.

Replace the page​

Custom Economy addon page

Keep the Catalog browser and supply a module containing your own addon_page:

  1. Create catalog-pages.tsx in the owning behavior pack's ui/ directory:
packs/BP/ui/catalog-pages.tsx
import { Screen, Embed, Panel, Text, type JSX } from '@bedrock-core/ui';
import { Button, FRAME } from '@bedrock-core/ore-styled';
import screens from '@bedrock-core/catalog/compiled';
import { CATALOG_PAGE_AREA, pageTargeted, registerCatalogPage } from '@bedrock-core/catalog/integration';

const Page = (): JSX.Element => (
<Screen>
<Embed frame={FRAME} area={CATALOG_PAGE_AREA}>
<Panel flexDirection={'column'} gap={8} padding={8}>
<Text>{'Welcome to my addon'}</Text>
<Button onPress={pageTargeted('config')}>{'Settings'}</Button>
</Panel>
</Embed>
</Screen>
);

export default { ...screens, addon_page: Page };
export function shape(): Record<string, never> {
registerCatalogPage(Page);
return {};
}

The imported screens keep the browser and framework pages. addon_page supplies your replacement; shape() publishes it. Use CATALOG_PAGE_AREA for the Embed area: it follows the host layout, while Catalog provides the outer frame and sidebar. Page buttons use pageTargeted() to open registered entry points such as config or guide.

  1. Point the Catalog declaration at that module in your existing registration. Keep your manifest and other app declarations:
Behavior pack script entry
import { core } from '@bedrock-core/server';
import { registerCatalog } from '@bedrock-core/catalog';

core.register({
manifest,
catalog: {
...registerCatalog(),
compiled: './packs/BP/ui/catalog-pages.tsx',
},
});

The compiled path is relative to config.json. The module is discovered through this declaration, so keep its .tsx filename as shown.

  1. Run your normal build and deploy both the behavior and resource packs.

Publish a page without the browser​

Config and Guides register their own navigation destinations. An addon can publish a custom page for other addons' Catalog browsers while installing neither the Catalog command nor its browser screens.

Create a screen in the owning behavior pack's ui/ directory:

packs/BP/ui/addon_page.screen.tsx
import { Button, Embed, Panel, Screen, Text, type JSX } from '@bedrock-core/ui';
import { FRAME } from '@bedrock-core/ore-styled';
import { CATALOG_PAGE_AREA, pageTargeted } from '@bedrock-core/catalog/integration';

export default function AddonPage(): JSX.Element {
return (
<Screen>
<Embed frame={FRAME} area={CATALOG_PAGE_AREA}>
<Panel flexDirection={'column'} padding={8} gap={4}>
<Text>{'My addon'}</Text>
<Button onPress={pageTargeted('config')}>{'Settings'}</Button>
<Button onPress={pageTargeted('guide')}>{'Guide'}</Button>
</Panel>
</Embed>
</Screen>
);
}

Publish it from the owning script entry after compiled screen registration:

packs/BP/scripts/main.ts (fragment)
import { system } from '@minecraft/server';
import { core } from '@bedrock-core/server';
import { registerConfig } from '@bedrock-core/config';
import { registerGuides } from '@bedrock-core/guides';
import { publishCatalogPage } from '@bedrock-core/catalog/integration';
import AddonPage from '../ui/addon_page.screen';

core.register({
manifest,
config: registerConfig(definition),
guides: registerGuides(),
});

system.run(() => { publishCatalogPage(core, AddonPage); });

Build with the UI compiler and export both packs. The addon_page screen belongs to this addon; another Catalog reads its published values and resolves its buttons against this addon's registered Config and Guide destinations. Runtime shutdown withdraws the publication.

Next steps​

  • API — page publishing functions and types
  • Embed — the embedded page and host contract