Ornithe Standard Libraries (OSL) provides tools for modding with Ornithe.
Libraries
Core API
The Core API provides common utilities used by other modules, such as an events system and registries.
Blocks API
The Blocks API provides events and utilities for creating custom blocks.
Branding API
This module patches the title screen with mod loader information in 16w05a and below, emulating what you would see in 16w05b and above. This is done by parsing the run args for the versionType option.
Config API
The Config API provides a framework for building and storing mod configs.
Entrypoints API
The Entrypoints API allows mod developers to submit entrypoints that are called before the game is initialized.
Executors API
This module patches the game instance so it can be used as an Executor, and provides a background executor service for background tasks.
Items API
The Items API provides events and utilities for creating custom items.
Keybinds API
The keybinds API provides events for registering keybinds.
Lifecycle Events API
The Lifecycle Events API provides events to track the lifecycle of the Minecraft client and server.
Localization
The Localization API provides utilities for localizing text and handles loading in mods' translation files.
Networking API
The Networking API provides a framework for client-server communication.
Resource Loader API
The Resource Loader API allows mods to load their own resources into the game.
Text Components API
This module provides an alternative to Minecraft's Text components.
Information for developers
Our Ploceus gradle plugin provides helper methods for adding OSL dependencies to your projects:
dependencies {
...
ploceus.dependOsl('0.20.1')
}
You can also add dependencies on individual OSL modules:
dependencies {
...
ploceus.dependOslModule('0.20.1', 'core')
ploceus.dependOslModule('0.20.1', 'entrypoints')
}
