Ornithe Standard Libraries 0.20.1

OSL 0.20.1 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Blocks 0.1.1

• Fixed being unable to place blocks in air in Minecraft 1.1 and below.

Text Components 0.1 Alpha 3

Now supports Minecraft Alpha 1.0.1_01-1.0.17_04

Ornithe Standard Libraries 0.20.0

OSL 0.20.0 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Core 0.9.0

Added new registry utilities for the Blocks and Items APIs.

Blocks 0.1.0

The Blocks API provides events and utilities for registering blocks.

Events

• REGISTER_BLOCKS: this event is invoked right after Vanilla block registration is completed. Mods should register blocks in listeners to this event.

Block Registry

The BlockRegistry class provides public access to the block registry, including a helper method for registering blocks.

int getId(Block)
NamespacedIdentifier getKey(Block)

Block getBlock(int)
Block getBlock(NamespacedIdentifier)

Set<NamespacedIdentifier> keySet()

// 17w46a-
Block register(int, NamespacedIdentifier, Block)
// 17w47a+
Block register(NamespacedIdentifier, Block)

Block Extension

This API extends the Block class with some functionality from later Minecraft versions.

• Added boolean isAir() method in 17w46a and below.
• Added boolean is(Block) method in 1.6.4 and below.

Usage

package com.example;

import net.ornithemc.osl.blocks.api.BlockEvents;
import net.ornithemc.osl.entrypoints.api.ModInitializer;

public class ExampleInitializer implements ModInitializer {

	@Override
	public void init() {
		BlockEvents.REGISTER_BLOCKS.register(ExampleBlocks::init);
	}
}

package com.example;

import net.minecraft.block.Block;

import net.ornithemc.osl.blocks.api.BlockRegistry;
import net.ornithemc.osl.core.util.NamespacedIdentifiers;

public final class ExampleBlocks {

	public static final CookieBlock COOKIE = BlockRegistry.register(NamespacedIdentifiers.from("example", "cookie"), new CookieBlock());

	public static void init() {
	}
}

Items 0.1.0

The Items API provides events and utilities for registering items.

Events

• REGISTER_ITEMS: this event is invoked right after Vanilla item registration is completed. Mods should register items in listeners to this event.
• REGISTER_BLOCK_ITEMS (for 1.6.4 and below only): this event is invoked right after Vanilla block item registration is completed. Mods should register block items in listeners to this event.

Item Registry

The ItemRegistry class provides public access to the item registry, including helper methods for registering items.

int getId(Item)
NamespacedIdentifier getKey(Item)

Item getItem(int)
Item getItem(NamespacedIdentifier)

Set<NamespacedIdentifier> keySet()

Item register(Block)
Item register(Block, Item)
Item register(BlockItem)
// 17w46a-
Item register(int, NamespacedIdentifier, Item)
// 17w47a+
Item register(NamespacedIdentifier, Item)

Usage

package com.example;

import net.ornithemc.osl.entrypoints.api.ModInitializer;
import net.ornithemc.osl.items.api.ItemEvents;

public class ExampleInitializer implements ModInitializer {

	@Override
	public void init() {
		ItemEvents.REGISTER_ITEMS.register(ExampleItems::init);
	}
}

package com.example;

import net.minecraft.item.Item;

import net.ornithemc.osl.core.util.NamespacedIdentifiers;
import net.ornithemc.osl.items.api.ItemRegistry;

public final class ExampleItems {

	public static final CookieItem COOKIE = ItemRegistry.register(NamespacedIdentifiers.from("example", "cookie"), new CookieItem());

	public static void init() {
	}
}

Keybinds 0.3.0

Keybinds API V2 is a minor rewrite of the Keybinds API. The API V1 is still present, but deprecated.

Events

• REGISTER_KEYBINDS: this event is invoked upon game start-up, right after Vanilla keybinds have been initialized. Mods should register keybinds in listeners to this event.

Keybind Registry

The KeybindRegistry class provides public access to the keybind registry, including helper methods for registering keybinds.

Set<String> getCategories()

register(
	String: name,
	int: defaultKeyCode,
	String: category
)
// 17w43a+
register(
	String: name,
	InputConstants.Type: type,
	int: defaultKeyCode,
	String: category
)

register(KeyBinding)

Usage

package com.example;

import net.ornithemc.osl.entrypoints.api.client.ClientModInitializer;
import net.ornithemc.osl.keybinds.api.KeybindEvents;

public class ExampleInitializer implements ClientModInitializer {

	@Override
	public void initClient() {
		KeybindEvents.REGISTER_KEYBINDS.register(ExampleKeybinds::init);
	}
}

package com.example;

import org.lwjgl.glfw.GLFW;

import net.minecraft.client.options.KeyBinding;

import net.ornithemc.osl.keybinds.api.KeybindRegistry;

public final class ExampleKeybinds {

	public static final KeyBinding COOKIE = KeybindRegistry.register("cookie", GLFW.GLFW_KEY_Z, "example");

	public static void init() {
	}
}

Ornithe Standard Libraries 0.19.3

OSL 0.19.3 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Resource Loader 0.7.2

Fixes direct path resource access from the default resource pack not working in 1.6-1.12.

Ornithe Standard Libraries 0.19.2

OSL 0.19.2 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Config 0.6.2

Fixes a crash in b13-b1.7 when joining a multiplayer server, caused by the crash fix from 0.19.0.

Ornithe Standard Libraries 0.19.1

OSL 0.19.1 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Resource Loader 0.7.1

Fixes a bug where only one mod resource pack would be used for a resource even if other mod resource packs provided that same resource as well.

Ornithe Standard Libraries 0.19.0

OSL 0.19.0 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Core 0.8.0

• Added several internal utilities for other OSL APIs to use.
• Added IOSupplier, a Supplier that throws IOExceptions.
• Added Unit, a singleton object.

Branding 0.4.3

Refactored some things to make use of new Core utilities.

Config 0.6.1

Fixed CLOSE_WORLD event not firing if the world is closed due to a level save conflict. This would lead to crashes upon joining another world.

Entrypoints 0.6.1

Suppressed a Mixin warning that would appear in logs.

Lifecycle Events 0.6.1

Fixed server STOP event firing twice on dedicated servers.

Localization 0.1.0

The Localization API split off from the Resource Loader API. It provides utilities for localizing text, and handles loading in mods' translation files.

Localizing Text

The L10n class provides utilities for localizing text.

// localizing a translation key
String localizedText = L10n.get("example.translationKey");

// localizing a translation key with formatting arguments
String localizedTextWithArgs = L10n.get("example.translationKey", "Some Arg", 1);

// localizing a translation key with a default value in case no localization exists
String localizedTextOrDefault = L10n.getOrDefault("example.translationKey", "Example Text");

// checking whether a localization for a translation key exists
boolean localizedTextExists = L10n.has("example.translationKey");

Providing Translations

Translation files can be added to your mod's resources and will be loaded automatically. While Minecraft natively only supports .lang files in versions 18w01a and below, and only .json files in 18w02a and above, the Localization API ensures both .lang and .json files are supported in any Minecraft version.

The Localization API also adds support for all-lowercase translation file names in 1.10.2 and below (e.g. en_us.lang instead of en_US.lang).

Localization in Minecraft Alpha and Beta

While Minecraft supports localization in Minecraft Beta, the only supported language is English (US). OSL's Localization API implements support for other languages, but none are provided by default and no GUI screen for switching languages is added.

Minecraft Alpha does not natively support localization at all, but OSL's Localization API implements the necessities for mods to make use of. Do note that OSL will not modify any Vanilla Minecraft text to localize it.

Resource Loader 0.7.0

This update to the Resource Loader API is a major rewrite. All internals and code APIs have changed, and mods that make use of them will most likely need to be updated. See the pull request for a detailed overview of the changes and update paths for mods that depend on the Resource Loader API.

Text Components 0.1 Alpha 2

• Added TextComponents.builder() method for constructing components with a builder pattern.
• Added visit methods to TextComponent for reading components with a visitor pattern.

Ornithe Standard Libraries 0.18.0

OSL 0.18.0 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Core 0.7.1

The Core API now provides a transitive injected interface for Vanilla's Identifier class implementing OSL's NamespacedIdentifier.

Branding 0.4.2

Fixes the version string used in Alpha 1.2.1_01 and earlier. The format now matches that used in following versions.

Entrypoints 0.6.0

The init entrypoint is now invoked before client-init and -server-init`. This change was made in order to match behavior from Fabric Loader's entrypoints.

Lifecycle Events

Now supports Beta 1.3.

Executors 0.1.0

This new API provides access to the main game instances as java.util.concurrent.Executors, and supplies a background executor for running tasks off the main game thread.

The Minecraft and MinecraftServer classes are made to implement Executor. Any tasks submitted are guaranteed to run on the main game thread. If called from a different thread, the task will be queued to be run at the start of the next tick. Instances can be acquired using the Lifecycle Events API.

MinecraftInstance.get().execute(
    // this code is guaranteed to be run on the main client thread!
);

The background executor can be acquired through the net.ornithemc.osl.executors.api.BackgroundExecutor class.

BackgroundExecutor.get().execute(
    // this code is guaranteed to be run on a background thread!
);

Networking Implementation 0.1.1

Fixes a crash due to a Mixin injection failure in late 1.7 snapshots.

Text Components 0.1 Alpha 1

This new API provides an alternative to Vanilla's chat component system. This is an Alpha release of this API and changes are very likely, so use with caution!

Text components can be made using factory methods in the net.ornithemc.osl.text.api.TextComponents class. Text components can be converted into legacy formatted strings as well.

TextComponent text = TextComponents.literal("this is a text component")
    .format(Formatting.BOLD)
    .append(" - and this is another one!");

String string = text.buildFormattedString();

Ornithe Standard Libraries 0.17.2

OSL 0.17.2 supports Minecraft versions between Alpha 1.0.1_01 and Release 1.14.4.

Resource Loader 0.6.1

• Fixes crashes when mod resources are accessed before the game is done initializing.
• Fixes crashes in findResources if the search directory does not exist.