Skip to content

getting started

Jump to bottom
E33EPUS edited this page Nov 3, 2026 · 1 revision

Getting started

The 0.3.0 coordinate below refers to a local build; the latest public release is still 0.1.0-beta beta3.

Add the AtomLib platform JAR to the host's mods/ folder, then declare its published coordinate in development. Maven publication is not configured in this repository; build/test-maven is the explicit local input used by tests.

repositories { maven { url = uri('/absolute/path/to/AtomLib/build/test-maven') }
             mavenCentral() }
dependencies {
    // Fabric: modImplementation; Forge/NeoForge: implementation
    implementation 'com.atom.lib:atomlib-1.20.1-forge:0.3.0'
}

Open the runtime only from client code. Register a font supplied by the host for priority, and call registerDefaults() so text renders CJK out of the box through the bundled subsetted Noto Sans SC (GB2312-complete hanzi, kana, Latin-1 supplement, punctuation and kaomoji symbols; emoji, Hangul words and GBK extensions are intentionally excluded). Host fonts win: the bundled faces join the fallback chain behind whatever the host set. The charset contract and the regeneration workflow live in tools/default-font-charset.txt and tools/subset_default_font.py.

try (var runtime = AtomLibRuntime.open("example");
     var fonts = new FontRegistry(runtime);
     var text = new TextService(fonts);
     var layout = new YogaLayoutEngine()) {
    var body = new FontId("host.body");
    fonts.register(body, FontSource.file(hostFontPath));
    fonts.registerDefaults(); // appended behind your own fallbacks

    LayoutTree tree = buildHostTree(text, body);
    var frame = PresentationFrame.create(
        tree, layout.layout(tree, viewport), viewport,
        Map.of(), new PresentationFrame.Offset(0, 0));
}

YogaLayoutEngine is single-threaded: create, lay out, paint and close it on the same thread. LayoutTree uses stable NodeId identities; changing a node's children or measurement callback updates only the affected native subtree. PresentationFrame is immutable and supplies border, content and hit rectangles plus clipping for painting and hit testing.

For Minecraft rendering, call MinecraftRenderBridge.get() from the render thread. Flush pending GuiGraphics/DrawContext work before drawFrame, and run vanilla content in vanillaPass between Skija passes. In CPU previews use RenderSession and Surface.makeRasterN32Premul directly.

The two integration examples in examples/a and examples/b show the two supported paths. Example A uses the optional design package (UiTokens, SkiaDraw, UiCards). Example B builds a Yoga layout and paints it with a raw Skija Canvas. The optional local controls and settings shell are documented separately in controls.md.

The common Java bytecode targets 17. Forge runs on 17; Fabric and NeoForge run on 21. Hosts must keep Minecraft's existing LWJGL version and must not compile or bundle a second Skija runtime into their own artifact.

AtomLib

Clone this wiki locally