Skip to content

Plugins ​

A plugin adds one part of a pack. This section has a page per plugin, and each page answers the same question: what does it add, and why?

What a plugin can add ​

KindIsUsed as
FilesArtifacts to install.They just get installed.
VariablesNamed values.${java_home} anywhere.
Launch piecesNamed parts of the command line.'@forge.jvmArgs' in args.
EnvironmentEnvironment variables for the game.Set automatically.

Nothing else. A plugin runs only while you build, and none of it reaches the player's machine.

Any pack ​

PluginDoes
Local filesfilesInstalls a folder from your disk.
Files by linklinksInstalls a file you have a URL for, pinned by hash.

Both take a to function that says where each file is installed:

js
to: (file) => '${game_directory}/mods/' + file.filename,

Minecraft ​

PluginDoes
Vanilla MinecraftminecraftThe game as Mojang ships it.
Server listserverlistPre-fills the multiplayer server list.
A serverserverA Minecraft server, whichever kind.
Custom auth serverauthlibertyPoints the game at your own account server.
BifrostresolveBifrostMakes a player's login token at launch.

Minecraft mod loaders ​

Use one instead of minecraft. Each loader includes the game.

PluginDoes
ForgeforgeForge mods, Minecraft 1.1 and later.
NeoForgeneoforgeNeoForge mods, 1.20.2 and later.
FabricfabricFabric mods.
CleanroomcleanroomForge 1.12.2 mods on a modern Java.
lwjgl3ifylwjgl3ifyForge 1.7.10 mods on a modern Java.

Minecraft mod resources ​

PluginDoes
A resources fileresourcesMods, packs and plugins listed in one TOML file.
ModrinthmodrinthMods and modpacks from Modrinth. No key needed.
CurseForgecurseforgeMods and modpacks from CurseForge. Needs an API token.

Java ​

PluginDoes
Java runtimejavaThe Java that runs the game.
Discrete GPUdgpujStarts that Java on the fast graphics card.

Where they come from ​

Everything is exported by @opys/minecraft, except files, which is in @opys/dev.

Need something that is not here? Write a plugin. It is one function.