Ornithe Wiki - User contributions [en]

Signature Changer

2025-08-13T09:10:56Z

Space Walker: add Signature Changer page

Signature Changer is a tool to patch generic type signatures for classes, fields, and methods in Java class files. It takes in a [[Sparrow]] data file and applies those patches to a jar file. This tool was originally created by [https://github.com/Gaming32 Gaming32].

== Generic Type Signatures ==

Classes, fields, methods, and variables all define their generic type signatures in Java class files.

Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove them to shrink the jar file size. This is generally not a problem, since it does not affect the runtime behavior of a Java application. However, they do make a difference at ''compile time''.

Generics are a useful tool for writing type-safe code. However, if the generic type signatures are missing, code can become bothersome to write and more prone to errors.

== Signature Changer ==

Exceptor patches the generic type signatures in a jar using a [[Sparrow]] data file. It has the following features:

* Removing, adding or modifying generic type signatures for classes, fields, and methods.
* Generating a [[Sparrow]] file from a given jar file.

Sparrow

2025-08-13T09:09:04Z

Space Walker: add note on 'remove' mode

Sparrow is Ornithe's generics patch. It is used to modify generic type signatures in Java class files.

See [[Signature Changer]] for information on generic type signatures and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the generic type signatures stripped from the jar. Sparrow was created in an effort to reconstruct what the original generics would have been in the source code.

=== File Specification ===

The <code>.sigs</code> file format was originally created by [https://github.com/Gaming32 Gaming32]. <code>.sigs</code> files are <code>UTF-8</code> encoded text files. A line has the following format.

<class name> [<class signature>]
<member name> <member type descriptor> <member signature>
...
...

* <code>class name</code>: the internal name of the class.
* <code>class type signature</code>: the generic type signature of the class (optional).
* <code>member name</code>: the name of the field or method.
* <code>member type descriptor</code>: the type descriptor of the field or method.
* <code>member signature</code>: the generic type signature of the field or method.

==== Notes ====

The file format does not support generic type signatures for local variables.

The <code>class type signature</code> and <code>member type signature</code> values can be set to <code>.</code> to signal that the generic type signature should be removed from that class or class member respectively.

[[category:Mod Development]]

Sparrow

2025-08-13T08:10:02Z

Space Walker: create Sparrow page

Sparrow is Ornithe's generics patch. It is used to modify generic type signatures in Java class files.

See [[Signature Changer]] for information on generic type signatures and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the generic type signatures stripped from the jar. Sparrow was created in an effort to reconstruct what the original generics would have been in the source code.

=== File Specification ===

The <code>.sigs</code> file format was originally created by [https://github.com/Gaming32 Gaming32]. <code>.sigs</code> files are <code>UTF-8</code> encoded text files. A line has the following format.

<class name> [<class signature>]
<member name> <member type descriptor> <member signature>
...
...

* <code>class name</code>: the internal name of the class.
* <code>class signature</code>: the generic type signature of the class (optional).
* <code>member name</code>: the name of the field or method.
* <code>member type descriptor</code>: the type descriptor of the field or method.
* <code>member signature</code>: the generic type signature of the field or method.

==== Notes ====

The file format does not support generic type signatures for local variables.

[[category:Mod Development]]

Raven

2025-08-13T08:00:09Z

Space Walker: fix file spec section

Raven is Ornithe's patch for method throws clauses. It is used to modify methods attributes in Java class files.

See [[Exceptor]] for information on methods attributes and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the exceptions from the methods attributes stripped from the jar. Raven was created in an effort to reconstruct what the original method throws clauses would have been in the source code.

=== File Specification ===

<code>.excs</code> files are <code>UTF-8</code> encoded text files. A line has the following format.

<class name>
<method name> <method type name>[ <exception class name>...]
...
...

* <code>class name</code>: the internal name of the class.
* <code>method name</code>: the method name.
* <code>method type descriptor</code>: the descriptor describing the type of the method.
* <code>exception class name</code>: the internal name of the exception class.

[[category:Mod Development]]

Raven

2025-08-13T07:55:38Z

Space Walker: fix grammar

Raven is Ornithe's patch for method throws clauses. It is used to modify methods attributes in Java class files.

See [[Exceptor]] for information on methods attributes and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the exceptions from the methods attributes stripped from the jar. Raven was created in an effort to reconstruct what the original method throws clauses would have been in the source code.

=== File Specification ===

<code>.excs</code> files are <code>UTF-8</code> encoded text files. Each line defines the relationship between a class and its outer class and, if applicable, outer method. A line has the following format.

<class name> <method name> <method type name>[ <exception class name>...]

* <code>class name</code>: the internal name of the class.
* <code>method name</code>: the method name.
* <code>method type descriptor</code>: the descriptor describing the type of the method.
* <code>exception class name</code>: the internal name of the exception class.

[[category:Mod Development]]

Exceptor

2025-08-12T17:45:58Z

Space Walker: add Exceptor page

Exceptor is a tool to patch exceptions in methods class attributes in Java class files. It takes in a [[Raven]] data file and applies those patches to a jar file.

== Throws Clauses ==

The throws clause in a method declaration defines which exceptions can be thrown from within the method body. It is denoted by the <code>throws</code> key word and goes after the method parameter list before the opening bracket of the method body.

<pre>
public void openPage(String address) throws URISyntaxException, IOException {
...
}
</pre>

== Methods Attributes ==

Java class files have a <code>Methods</code> attribute that contains entries for each method defined in a class. These entries contain values for the name and type descriptor of the method, but also for the exceptions that can be thrown by that method.

Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove that value to shrink the jar file size. This is generally not a problem, since it does not affect the runtime behavior of a Java application. However, they do make a difference at ''compile time''.

Usually, the Java compiler forces you to handle exceptions. However, if the throws clauses are missing for some methods, you can invoke them and not handle the exceptions, without any compile error. While this may sound nice, it will lead to unexpected behavior, bugs, and even crashes.

A more bothersome issue occurs when overriding methods where the throws clause is missing. You are not able to throw any exceptions in that method at all. The compiler will complain that the exceptions are not handled. However, adding a throws clause to your override is not possible, because the method you are overriding does not have one. The only solution is to catch the exception and throw a runtime exception instead.

=== The Methods Attribute ===

The <code>Methods</code> attribute of a class contains entries for all methods defined in that class. Each entry has four values:

* <code>method access</code>: the access modifier of the method
* <code>method name</code>: the name of the method
* <code>method type descriptor</code>: the type descriptor of the method
* <code>method generic type signature</code>: the generic type signature of the method
* <code>method exceptions</code>: the internal names of all exceptions that can be thrown by the method

== Exceptor ==

Exceptor patches the methods attributes in a jar using a [[Raven]] data file. It has the following features:

* Setting the exceptions value in the methods attribute for existing methods.
* Generating a [[Raven]] file from a given jar file.

Raven

2025-08-12T16:58:04Z

Space Walker: add Raven page

Raven is Ornithe's patch for method throws clauses. They are used to modify methods attributes in Java class files.

See [[Exceptor]] for information on methods attributes and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the exceptions from the methods attributes stripped from the jar. Raven was created in an effort to reconstruct what the original method throws clauses would have been in the source code.

=== File Specification ===

<code>.excs</code> files are <code>UTF-8</code> encoded text files. Each line defines the relationship between a class and its outer class and, if applicable, outer method. A line has the following format.

<class name> <method name> <method type name>[ <exception class name>...]

* <code>class name</code>: the internal name of the class.
* <code>method name</code>: the method name.
* <code>method type descriptor</code>: the descriptor describing the type of the method.
* <code>exception class name</code>: the internal name of the exception class.

[[category:Mod Development]]

Nester

2025-08-12T16:31:33Z

Space Walker: add chapter on features

Nester is a tool to patch inner class attributes in Java class files. It takes in a [[Nests]] data file and applies those patches to a jar file.

== Inner Classes ==

Inner classes are classes that are defined inside other classes or methods. There are three types of inner classes: nested classes, local classes, and anonymous classes. Each type has its own uses, and a different relationship with its outer class or method.

=== Nested Classes ===

A nested class is a class declared inside another class.

<pre>
public class Outer {
...
public class Inner {
...
}
}
</pre>

Nested classes can be ''static'' or ''non-static''.
* A ''static'' nested class can access static members of its outer class, and vice versa, even if those members are private.
* A ''non-static'' nested class can access both static members and instance members of its outer class, and vice versa, even if those members are private.

=== Local Classes ===

A local class a class declared inside a method.

<pre>
public class Outer {
....
public void outer() {
...
class Inner {
...
}
}
}
</pre>

A local class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Anonymous Classes ===

An anonymous class is a class declared and instantiated at the same time.

<pre>
public class Outer {
...
public void outer() {
...
Runnable task = new Runnable() {
...
}
}
}
</pre>

An anonymous class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Special Classes ===

The Java compiler may generate special classes for some of the language's features. These synthetic classes are normally invisible.

* Switch statements are compiled to classes with enum value tables.
* A completely empty class may be generated and passed between multiple nested classes and their outer class to enforce the contract for access between them.

=== Inner Class Names ===

While the JVM specification does not enforce any naming scheme for inner classes, there is a convention for each type of inner class.

* Names for nested classes are typically composed of the outer class name and the inner name of the nested class. For example, a nested class with outer class name <code>com/example/Outer</code> and inner name <code>Inner</code> typically has the name <code>com/example/Outer$Inner</code>.
* Names for local classes are typically composed of the outer class name, the inner name of the inner class, and a number that counts up for each local class in the top-level outer class. For example, the second local class in some top-level class, with outer class name <code>com/example/Outer</code> and inner name <code>Inner</code> typically has the name <code>com/example/Outer$2Inner</code>.
* Names for anonymous classes are typically composed of the outer class name and a number that counts up for each anonymous class in the outer class. For example, the third anonymous class in outer class <code>com/example/Outer</code> typically has the name <code>com/example/Outer$3</code>.

== Inner Class Attributes ==

Inner class attributes describe the relationship between inner classes and their outer classes or methods. Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove them to shrink the jar file size. This is generally not a problem, since these attributes do not affect the runtime behavior of a Java application. However, they do make a difference at ''compile time''.

Interactions with inner classes will not work properly if the inner class attributes are missing. Access between non-static nested classes and their outer classes will be broken, anonymous classes will be accessible when they should not be, and references to nested classes will not work.

On top of the compile time issues, decompiler results will be significantly worse for jars where the inner class attributes are not present. Local and anonymous classes will not appear inside their outer classes and methods, and member access between nested classes and their outer classes may appear as references to methods that do not exist.

=== The InnerClasses Attribute ===

The <code>InnerClasses</code> attribute of a class contains entries for all inner classes referenced by that class. Each entry has four values:

* <code>inner class name</code>: the internal name of the inner class
* <code>outer class name</code>: the internal name of the outer class
* <code>inner name</code>: the simple name of the inner class (i.e. the name as declared in the source)
* <code>inner class access</code>: the access modifier flags of the inner class

The <code>outer class name</code> is empty for anonymous and local classes.

The <code>inner name</code> value is empty for anonymous classes.

=== The EnclosingMethod Attribute ===

The <code>EnclosingMethod</code> attribute of a class describes the outer class and method of an inner class. It has three values:

* <code>enclosing class name</code>: the internal name of the enclosing class
* <code>enclosing method name</code>: the name of the enclosing method
* <code>enclosing method descriptor</code>: the type descriptor of the enclosing method

This attribute is only present for local and anonymous classes.

The <code>enclosing method name</code> and <code>enclosing method descriptor</code> values are empty for anonymous classes that are declared in in-line initializers for fields.

== Nester ==

Nester patches inner class attributes in a jar using a [[Nests]] data file. It has the following features:

* Adding inner class attributes to existing classes.
* Remapping inner classes to fit the convention for [[Nester#Inner Class Names|inner class names]].
* Generating new classes if outer classes specified in the Nests file do not exist.

Nester

2025-08-12T15:48:26Z

Space Walker: add chapter on inner class names

Nester

2025-08-12T14:01:26Z

Space Walker: fix two typos

Nester is a tool to patch inner class attributes in Java class files. It takes in a [[Nests]] data file and applies those patches to a jar file.

== Inner Classes ==

Inner classes are classes that are defined inside other classes or methods. There are three types of inner classes: nested classes, local classes, and anonymous classes. Each type has its own uses, and a different relationship with its outer class or method.

=== Nested Classes ===

A nested class is a class declared inside another class.

<pre>
public class Outer {
...
public class Inner {
...
}
}
</pre>

Nested classes can be ''static'' or ''non-static''.
* A ''static'' nested class can access static members of its outer class, and vice versa, even if those members are private.
* A ''non-static'' nested class can access both static members and instance members of its outer class, and vice versa, even if those members are private.

=== Local Classes ===

A local class a class declared inside a method.

<pre>
public class Outer {
....
public void outer() {
...
class Inner {
...
}
}
}
</pre>

A local class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Anonymous Classes ===

An anonymous class is a class declared and instantiated at the same time.

<pre>
public class Outer {
...
public void outer() {
...
Runnable task = new Runnable() {
...
}
}
}
</pre>

An anonymous class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Special Classes ===

The Java compiler may generate special classes for some of the language's features. These synthetic classes are normally invisible.

* Switch statements are compiled to classes with enum value tables.
* A completely empty class may be generated and passed between multiple nested classes and their outer class to enforce the contract for access between them.

== Inner Class Attributes ==

Inner class attributes describe the relationship between inner classes and their outer classes or methods. Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove them to shrink the jar file size. This is generally not a problem, since these attributes do not affect the runtime behavior of a Java application. However, they do make a difference at ''compile time''.

Interactions with inner classes will not work properly if the inner class attributes are missing. Access between non-static nested classes and their outer classes will be broken, anonymous classes will be accessible when they should not be, and references to nested classes will not work.

On top of the compile time issues, decompiler results will be significantly worse for jars where the inner class attributes are not present. Local and anonymous classes will not appear inside their outer classes and methods, and member access between nested classes and their outer classes may appear as references to methods that do not exist.

=== The InnerClasses Attribute ===

The <code>InnerClasses</code> attribute of a class contains entries for all inner classes referenced by that class. Each entry has four values:

* <code>inner class name</code>: the internal name of the inner class
* <code>outer class name</code>: the internal name of the outer class
* <code>inner name</code>: the simple name of the inner class (i.e. the name as declared in the source)
* <code>inner class access</code>: the access modifier flags of the inner class

The <code>outer class name</code> is empty for anonymous and local classes.

The <code>inner name</code> value is empty for anonymous classes.

=== The EnclosingMethod Attribute ===

The <code>EnclosingMethod</code> attribute of a class describes the outer class and method of an inner class. It has three values:

* <code>enclosing class name</code>: the internal name of the enclosing class
* <code>enclosing method name</code>: the name of the enclosing method
* <code>enclosing method descriptor</code>: the type descriptor of the enclosing method

This attribute is only present for local and anonymous classes.

The <code>enclosing method name</code> and <code>enclosing method descriptor</code> values are empty for anonymous classes that are declared in in-line initializers for fields.

Nester

2025-08-12T13:53:34Z

Space Walker: Created page with "Nester is a tool to patch inner class attributes in Java class files. It takes in a Nests data file and applies those patches to a jar file. == Inner Classes == Inner classes are classes that are defined inside other classes or methods. There are three types of inner classes: nested classes, local classes, and anonymous classes. Each type has its own uses, and a different relationship with its outer class or method. === Nested Classes === A nested class is a cla..."

Nester is a tool to patch inner class attributes in Java class files. It takes in a [[Nests]] data file and applies those patches to a jar file.

== Inner Classes ==

Inner classes are classes that are defined inside other classes or methods. There are three types of inner classes: nested classes, local classes, and anonymous classes. Each type has its own uses, and a different relationship with its outer class or method.

=== Nested Classes ===

A nested class is a class declared inside another class.

<pre>
public class Outer {
...
public class Inner {
...
}
}
</pre>

Nested classes can be ''static'' or ''non-static''.
* A ''static'' nested class can access static members of its outer class, and vice versa, even if those members are private.
* A ''non-static'' nested class can access both static members and instance members of its outer class, and vice versa, even if those members are private.

=== Local Classes ===

A local class a class declared inside a method.

<pre>
public class Outer {
....
public void outer() {
...
class Inner {
...
}
}
}
</pre>

A local class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Anonymous Classes ===

An anonymous class is a class declared and instantiated at the same time.

<pre>
public class Outer {
...
public void outer() {
...
Runnable task = new Runnable() {
...
}
}
}
</pre>

An anonymous class can access both static and instance members from its outer class, as well as local variables from the scope in which it is declared in its outer method.

=== Special Classes ===

The Java compiler may generate special classes for some of the language features. These synthetic classes are normally invisible.

* Switch statements are compiled to classes with enum value tables.
* A completely empty class may be generated and passed between multiple nested class and their outer class to enforce the contract for access between them.

== Inner Class Attributes ==

Inner class attributes describe the relationship between inner classes and their outer classes or methods. Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove them to shrink the jar file size. This is generally not a problem, since these attributes do not affect the runtime behavior of a Java application. However, they do make a difference at ''compile time''.

Interactions with inner classes will not work properly if the inner class attributes are missing. Access between non-static nested classes and their outer classes will be broken, anonymous classes will be accessible when they should not be, and references to nested classes will not work.

On top of the compile time issues, decompiler results will be significantly worse for jars where the inner class attributes are not present. Local and anonymous classes will not appear inside their outer classes and methods, and member access between nested classes and their outer classes may appear as references to methods that do not exist.

=== The InnerClasses Attribute ===

The <code>InnerClasses</code> attribute of a class contains entries for all inner classes referenced by that class. Each entry has four values:

* <code>inner class name</code>: the internal name of the inner class
* <code>outer class name</code>: the internal name of the outer class
* <code>inner name</code>: the simple name of the inner class (i.e. the name as declared in the source)
* <code>inner class access</code>: the access modifier flags of the inner class

The <code>outer class name</code> is empty for anonymous and local classes.

The <code>inner name</code> value is empty for anonymous classes.

=== The EnclosingMethod Attribute ===

The <code>EnclosingMethod</code> attribute of a class describes the outer class and method of an inner class. It has three values:

* <code>enclosing class name</code>: the internal name of the enclosing class
* <code>enclosing method name</code>: the name of the enclosing method
* <code>enclosing method descriptor</code>: the type descriptor of the enclosing method

This attribute is only present for local and anonymous classes.

The <code>enclosing method name</code> and <code>enclosing method descriptor</code> values are empty for anonymous classes that are declared in in-line initializers for fields.

Nests

2025-08-12T12:52:46Z

Space Walker: remove chapter about inner class attributes (and move them to the Nester page)

Nests are Ornithe's inner class patches. They are used to modify inner class attributes in Java class files.

See [[Nester]] for information on inner class attributes and how these patches are applied.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the inner class attributes stripped from the jar. Nests were created in an effort to reconstruct what the original inner classes would have been in the source code.

=== File Specification ===

<code>.nest</code> files are <code>UTF-8</code> encoded text files. Each line defines the relationship between a class and its outer class and, if applicable, outer method. A line has the following format.

<class name> <outer class name> <outer method name> <outer method descriptor> <inner name> <access>

* <code>class name</code>: the internal name of the class
* <code>outer class name</code>: the internal name of the outer class.
* <code>outer method name</code>: the name of the outer method (may be empty).
* <code>outer method descriptor</code>: the descriptor describing the type of the outer method (may be empty).
* <code>inner name</code>: the inner name of the class (may be empty).
* <code>access</code>: the access flags for the inner class.

==== Notes ====

The <code>inner name</code> component does not directly correspond to the inner name as defined in the inner class attribute. Rather, it is used to construct a new internal name of the class. The actual inner name is parsed from this component.

For regular inner classes, the <code>inner name</code> component corresponds directly to the inner name as defined in the inner class attribute. If the component is all digits, the inner class is assumed to be anonymous, and the actual inner name <code>null</code>. If the component starts with digits and transitions to text, the inner class is assumed to be local, and the inner name the text part of the component.

For example:
* <code>Example</code> - the class is assumed to be a regular inner class, with inner name <code>Example</code>.
* <code>1</code> - the class is assumed to be an anonymous class, with inner name <code>null</code>.
* <code>1Example</code> - the class is assumed to be a local class, with inner name <code>Example</code>.

[[category:Mod Development]]

Installing Ornithe

2025-08-12T11:19:09Z

Space Walker: remove chapter numbers as they are automatically assigned

This guide will only cover installing Ornithe to the Official Minecraft launcher, MultiMC and its derivatives such as PrismLauncher and for a dedicated server. Other launchers may also allow for an automated installation, however as of 2025-04-23 we are not aware of any.

=== Download the installer ===

Head to our website at https://ornithemc.net/download and grab the installer for your platform. Should the native installer not be available for your platform or not work for you, follow the steps at [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== Official Launcher ====

Due to the difficulties around managing multiple instances using the official launcher its usage in modded scenarios
is generally discouraged.

Before starting, make sure that both your game and the launcher are closed.

===== GUI Installation =====

* Select the "Client(Official Launcher)" environment
* Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
* Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
* Choose the installation location. This directory should be your <code>.minecraft</code> directory. The Installer will default to the default location, so if you haven't changed anything it should also be fine to leave as-is.
* The Installer will generate a new profile for Ornithe by default. This behavior can be disabled by unchecking this checkbox.

Now, click "Install", wait for your installation to complete and enjoy the game.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> subcommand. Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs client --minecraft-version VERSION

Example:
$ ornithe-installer-rs client --minecraft-version 1.7.2

The <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to generate a profile: <code>-p --generate-profile <VALUE></code>

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== GUI Installation =====

* Select the "MultiMC/PrismLauncher" environment
* Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
* Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
* Choose the installation location. By default, the installer will output a zip file for your instance into this directory. However, if you have unselected "Generate Instance Zip" this directory should be your launcher's <code>instances</code> directory.

Now, click "Install".

If you generated an instance zip, import it into your launcher, for example by dragging it onto it.
Otherwise, restart your launcher for it to reload the instance list.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs mmc --minecraft-version VERSION

Example:
$ ornithe-installer-rs mmc --minecraft-version 1.7.2

The <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to generate a profile zip: <code>-z --generate-zip <VALUE></code>
* Whether to copy the output path to the clipboard: <code>-c --copy-profile-path <VALUE></code>

==== Server ====

Most likely, your server will not have a graphical environment so you should skip ahead to the Cli Installation.

===== GUI Installation =====

* Select the "Server" environment
* Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
* Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
* Choose the installation location. By default, the installer will install into a new <code>server</code> sub-directory in the current directory.
* If "Download Minecraft Server" is checked, the installer will download the server jar for you. Otherwise, you will have to download it yourself.

Now, click "Install".

You can then start your server with either
java -jar fabric-server-launch.jar nogui
if you selected the Fabric Loader, or
java -jar quilt-server-launch.jar nogui
if you chose the Quilt Loader.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> subcommand. Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs server --minecraft-version VERSION

Example:
$ ornithe-installer-rs server --minecraft-version 1.7.2

The <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> subcommand is used.

$ ornithe-installer-rs server --minecraft-version VERSION run

Example:

$ ornithe-installer-rs server --minecraft-version 1.7.2 run

In addition to the arguments available for the <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

* Java arguments to pass to the server: <code>--args <ARGS></code>
* Java binary to use to start the server: <code>--java <PATH></code>

The <code>--download-minecraft</code> flag is not applicable and always enabled when the <code>run</code> subcommand is used.

Then, your server will be installed automatically and started afterwards.

=== Addendum: Using the java-based installer ===

// TODO

Nests

2025-07-31T16:00:51Z

Space Walker: create Nests page

Nests are Ornithe's inner class patches. They are used to modify inner class attributes in Java class files.

See [[Nester]] for information on how these patches are applied.

=== Inner Class Attributes ===

Inner class attributes are necessary for interactions with inner classes to work as expected. This is especially noticeable with non-static inner classes, and anonymous classes in particular. These inner classes can access fields, methods, or variables from their outer class or method, as well as the other way around.

Obfuscators such as [https://www.guardsquare.com/proguard ProGuard] may remove these class file attributes. This is generally not a problem, since these attributes do not affect the runtime behavior of a Java application. However, if you wish to de-obfuscate and decompile a jar file, you will get better results when the inner class attributes are present.

=== Relevance ===

Most Minecraft versions before 1.8.2 Pre-release 5 had the inner class attributes stripped from the jar. Nests were created in an effort to reconstruct what the original inner classes would have been in the source code.

=== File Specification ===

<code>.nest</code> files are <code>UTF-8</code> encoded text files. Each line defines the relationship between a class and its outer class and, if applicable, outer method. A line has the following format.

<class name> <outer class name> <outer method name> <outer method descriptor> <inner name> <access>

* <code>class name</code>: the internal name of the class
* <code>outer class name</code>: the internal name of the outer class.
* <code>outer method name</code>: the name of the outer method (may be empty).
* <code>outer method descriptor</code>: the descriptor describing the type of the outer method (may be empty).
* <code>inner name</code>: the inner name of the class (may be empty).
* <code>access</code>: the access flags for the inner class.

==== Notes ====

The <code>inner name</code> component does not directly correspond to the inner name as defined in the inner class attribute. Rather, it is used to construct a new internal name of the class. The actual inner name is parsed from this component.

For regular inner classes, the <code>inner name</code> component corresponds directly to the inner name as defined in the inner class attribute. If the component is all digits, the inner class is assumed to be anonymous, and the actual inner name <code>null</code>. If the component starts with digits and transitions to text, the inner class is assumed to be local, and the inner name the text part of the component.

For example:
* <code>Example</code> - the class is assumed to be a regular inner class, with inner name <code>Example</code>.
* <code>1</code> - the class is assumed to be an anonymous class, with inner name <code>null</code>.
* <code>1Example</code> - the class is assumed to be a local class, with inner name <code>Example</code>.

[[category:Mod Development]]

Setting up a Mod Development Environment

2025-07-31T14:57:40Z

Space Walker: Created page with "This article is a guide on how to set up an Ornithe mod development environment. == Before You Get Started == If you have no prior experience with programming in Java, it is strongly recommended you learn at least the basics first. Here are some resources to help you on your way: * Oracle Java tutorials: https://docs.oracle.com/javase/tutorial/ * Java tutorial at W3Schools: https://www.w3schools.com/java/ Ornithe modding is essentially the same as Fabric/Quilt modding..."

This article is a guide on how to set up an Ornithe mod development environment.

== Before You Get Started ==

If you have no prior experience with programming in Java, it is strongly recommended you learn at least the basics first. Here are some resources to help you on your way:
* Oracle Java tutorials: https://docs.oracle.com/javase/tutorial/
* Java tutorial at W3Schools: https://www.w3schools.com/java/

Ornithe modding is essentially the same as Fabric/Quilt modding. There are, however, a few key differences. If you are not familiar with Fabric/Quilt modding, you may peruse their documentation ([https://wiki.fabricmc.net/ here] for Fabric, [https://wiki.quiltmc.org/ here] for Quilt), though it is not required to follow this guide.

== The Mod Template ==

The mod template is a bare bones mod development project. It has all the necessary elements, and can be customized to suit your own needs. You can visit the repository on GitHub at https://github.com/OrnitheMC/ornithe-mod-template/.

=== Using the Template ===

The first step is to create a new repository from the template. In the <code>Create a new repository</code> dialog, make sure to select the <code>Include all branches</code> option.

Next, you must choose the correct branch for your project. Which branch to choose depends on the mod loader of your choice, and the Minecraft version your mod will be targeting.

* <code>fabric/merged</code> for a Fabric mod for Minecraft 1.3 or later.
* <code>fabric/split</code> for a Fabric mod for Minecraft 12w30e or earlier.
* <code>quilt/merged</code> for a Quilt mod for Minecraft 1.3 or later.
* <code>quilt/split</code> for a Quilt mod for Minecraft 12w30e or earlier.

You may rename the chosen branch to <code>main</code> (or otherwise as you see fit) and discard the others.

=== Setting up the Project ===

Once you have prepared your new repository, you can clone it to your computer and import the project into your IDE.

Next, it's time to configure the project for the target Minecraft version. The <code>gradle.properties</code> file contains the versions for key dependencies. Visit https://ornithemc.net/develop/ to look up the latest versions. Then edit the values for the following fields.
* <code>minecraft_version</code>: the Minecraft version your mod will be targeting.
* <code>loader_version</code>: the version of the mod loader.
* <code>osl_version</code>: the version of OSL (Ornithe Standard Libraries).

Some dependencies are different for Minecraft versions before 1.3 compared to 1.3 and later. These dependencies may also not be available at all for the Minecraft version your mod is targeting. In that case you will also need to make changes to the <code>build.gradle</code> file.

==== Dependencies for Minecraft 1.3 or Later ====

Edit the values for the following fields in the <code>gradle.properties</code> file.
* <code>feather_build</code>: the build number of the [[Feather]] mappings.
* <code>raven_build</code>: the build number for [[Raven]].
* <code>sparrow_build</code>: the build number for [[Sparrow]].
* <code>nests_build</code>: the build number for [[Nests]].

If Raven is not avaliable, remove the following line from the <code>dependencies { }</code> block in the <code>build.gradle</code> file.

exceptions ploceus.raven(project.raven_build)

If Sparrow is not avaliable, remove the following line from the <code>dependencies { }</code> block in the <code>build.gradle</code> file.

signatures ploceus.sparrow(project.sparrow_build)

If Nests are not avaliable, remove the following line from the <code>dependencies { }</code> block in the <code>build.gradle</code> file.

nests ploceus.nests(project.nests_build)

==== Dependencies for Minecraft 12w30e or Earlier ====

Edit the values for the following fields in the <code>client/gradle.properties</code> and <code>server/gradle.properties</code> files.
* <code>feather_build</code>: the build number of the [[Feather]] mappings.
* <code>raven_build</code>: the build number for [[Raven]].
* <code>sparrow_build</code>: the build number for [[Sparrow]].
* <code>nests_build</code>: the build number for [[Nests]].

If Raven is not avaliable, remove the following line from the <code>project.dependencies { }</code> block in the <code>build.gradle</code> file.

exceptions project.ploceus.raven(project.raven_build)

If Sparrow is not avaliable, remove the following line from the <code>project.dependencies { }</code> block in the <code>build.gradle</code> file.

signatures project.ploceus.sparrow(project.sparrow_build)

If Nests are not avaliable, remove the following line from the <code>project.dependencies { }</code> block in the <code>build.gradle</code> file.

nests project.ploceus.nests(project.nests_build)

=== Updating Mod Metadata ===

The last step is to update the mod metadata to make it your own.

In the <code>gradle.properties</code> file, update the value of the <code>archives_base_name</code> field. This will be used to construct file name of the compiled mod jar.

In the <code>src/main/resources/</code> folder, update the <code>mod.json</code> file. This step differs slightly depending on the mod loader you chose to use.

==== Updating <code>fabric.mod.json</code> ====

In the <code>fabric.mod.json</code> file, update the following fields.
* <code>id</code>: the mod id. This ought to be a unique identifier for your mod. It should have only lowercase letters and underscores. Generally, you can use your mod's name, turned all lowercase, and replacing any spaces with underscores. For example, for a mod named <code>My Cool Mod</code>, the mod id could be <code>my_cool_mod</code>.
* <code>name</code>: the name of your mod.
* <code>description</code>: a short description of your mod, what it's for and/or what it does.
* <code>authors</code>: a list of people who made the mod. Add your name(s) to this list.

There are other fields in the <code>mod.json</code> that may be relevant to your mod. Feel free to fill those in or remove them as you see fit.

==== Updating <code>quilt.mod.json</code> ====

In the <code>quilt.mod.json</code> file, update the following fields.
* <code>id</code>: the mod id. This ought to be a unique identifier for your mod. It should have only lowercase letters and underscores. Generally, you can use your mod's name, turned all lowercase, and replacing any spaces with underscores. For example, for a mod named <code>My Cool Mod</code>, the mod id could be <code>my_cool_mod</code>.
* <code>name</code>: the name of your mod.
* <code>description</code>: a short description of your mod, what it's for and/or what it does.
* <code>contributors</code>: a list of people who made the mod. Add your name(s) to this list.

There are other fields in the <code>mod.json</code> that may be relevant to your mod. Feel free to fill those in or remove them as you see fit.

== Almost Done! ==

With the mod template set up and configured, you are almost ready to start working on your mod. You may have to refresh your IDE for the changes to take effect. After that, it's time to write some code!

[[Category:Mod Development]]

Ornithe Installer

2025-07-29T13:08:34Z

Space Walker: consistent capitalization of GUI

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== GUI ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the old,

java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions
loader-versions, --list-loader-versions
List available loader versions
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Ornithe Installer

2025-07-29T13:07:35Z

Space Walker: fix typo

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== Gui ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the old,

java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions
loader-versions, --list-loader-versions
List available loader versions
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Ploceus

2025-07-29T13:03:05Z

Space Walker:

Ploceus is a [https://gradle.org/ Gradle] plugin. It is an extension to [https://wiki.fabricmc.net/documentation:fabric_loom Loom] that configures projects for Orntihe mod development.

== Features ==

==== Basic functionality ====
* Expanding the Minecraft version support with a custom versions manifest.
* Setting up Loom's intermediate mappings provider to use Ornithe's [[Calamus Intermediary|Calamus]] intermediary.
* Upgrading Minecraft libraries.
* Adding additional Minecraft libraries.

==== Additional features ====
* Depending on [[Ornithe Standard Libraries|OSL]].
* Using [[Feather Mappings|Feather]] mappings.
* Applying [[Nests|inner class patches]].
* Applying [[Sparrow|generic type signature patches]].
* Applying [[Raven|throws clause patches]].
* Applying [[Condor|LVT patches]].
* Applying [[Preen|miscellaneous de-obfuscation patches]].

== Using Ploceus ==
The easiest option to make use of Ploceus is to start with [https://github.com/OrnitheMC/ornithe-mod-template Ornithe's Mod Template].

Should you need to add it to an already existing project these steps should cover your needs:

==== Adding Ornithe's maven repository for plugin resolution ====

<code>settings.gradle</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven { url = "https://maven.ornithemc.net/releases" }
maven { url = "https://maven.orntithemc.net/snapshots"
}
}

<code>settings.gradle.kts</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven("https://maven.ornithemc.net/releases")
maven("https://maven.orntithemc.net/snapshots")
}
}

==== Apply the plugin ====

<code>build.gradle</code>
plugins {
/* ... (Other plugins) */
id "ploceus" version "<version>"
}

<code>build.gradle.kts</code>
plugins {
/* ... (Other plugins) */
id("ploceus") version "<version>"
}

===== Note =====

The major and minor Ploceus version must match the major and minor Loom version! For example, if the Loom version is <code>1.10-SNAPSHOT</code>, the Ploceus version must be <code>1.10-SNAPSHOT</code>.

== Configuring Ploceus ==

The latest versions for the relevant dependencies can be found on the [https://ornithemc.net/develop develop] page on the website.

==== Split development environments ====

How you configure Ploceus depends on the Minecraft version you are developing for. Merged client-server development environments are not supported for Minecraft versions before 1.3. For these versions, you must configure Loom and Ploceus for a split development environment. You may use a sub-project structure (see the <code>fabric/split</code> branch on the Ornithe Mod Template) in order to develop both a client mod and a server mod in one project, or choose to develop a client-only or server-only mod.

In either case, you must configure Loom and Ploceus for a one-side-only development environment.

<code>build.gradle</code>
loom {
...
clientOnlyMinecraftJar() // for a client-side-only (sub)project
// serverOnlyMinecraftJar() // for a server-side-only (sub)project
}

ploceus {
...
clientOnlyMappings() // for a client-side-only (sub)project
// serverOnlyMappings() // for a server-side-only (sub)project
}

<code>build.gradle.kts</code>
loom {
...
clientOnlyMinecraftJar() // for a client-side-only (sub)project
// serverOnlyMinecraftJar() // for a server-side-only (sub)project
}

ploceus {
...
clientOnlyMappings() // for a client-side-only (sub)project
// serverOnlyMappings() // for a server-side-only (sub)project
}

==== Mappings ====

It is recommended to use [[Feather Mappings|Feather]] mappings for your mod development environment, though the use of MCP mappings is also supported for a handful of Minecraft versions.

To use Feather mappings, add the <code>mappings</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
mappings ploceus.featherMappings(<Feather build>)
}

<code>build.gradle.kts</code>
dependencies {
...
mappings(ploceus.featherMappings(<Feather build>))
}

To use MCP mappings, add the <code>mappings</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
mappings ploceus.mcpMappings(<MCP channel>, <Minecraft version>, <MCP build>)
}

<code>build.gradle.kts</code>
dependencies {
...
mappings(ploceus.mcpMappings(<MCP channel>, <Minecraft version>, <MCP build>))
}

==== OSL ====

[[Ornithe Standard Libraries|OSL]] provides hooks and events for modding with Ornithe. To use OSL, add the dependency as follows.

<code>build.gradle</code>
dependencies {
...
ploceus.dependOsl(<OSL version>)
// ploceus.dependOsl(<configuration>, <OSL version>) // default configuration is modImplementation
}

<code>build.gradle.kts</code>
dependencies {
...
ploceus.dependOsl(<OSL version>)
// ploceus.dependOsl(<configuration>, <OSL version>) // default configuration is modImplementation
}

You may also depend on individual OSL modules.

<code>build.gradle</code>
dependencies {
...
ploceus.dependOslModule(<OSL version>, <module name>)
// ploceus.dependOslModule(<configuration>, <OSL version>) // default configuration is modImplementation
}

<code>build.gradle.kts</code>
dependencies {
...
ploceus.dependOslModule(<OSL version>, <module name>)
// ploceus.dependOslModule(<configuration>, <OSL version>, <module name>) // default configuration is modImplementation
}

==== Nests ====

[[Nests|Nests]] are Ornithe's inner classes patches. To apply these patches, add the <code>nests</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
nests ploceus.nests(<Nests build>)
}

<code>build.gradle.kts</code>
dependencies {
...
nests(ploceus.nests(<Nests build>))
}

==== Sparrow ====

[[Sparrow|Sparrow]] is Ornithe's generic type signatures patch. To apply these patches, add the <code>signatures</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
signatures ploceus.sparrow(<Sparrow build>)
}

<code>build.gradle.kts</code>
dependencies {
...
signatures(ploceus.sparrow(<Sparrow build>))
}

==== Raven ====

[[Raven|Raven]] is Ornithe's throws clauses patch. To apply these patches, add the <code>exceptions</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
exceptions ploceus.raven(<Raven build>)
}

<code>build.gradle.kts</code>
dependencies {
...
exceptions(ploceus.raven(<Raven build>))
}

[[Category:Mod Development]]

Ploceus

2025-07-29T12:34:36Z

Space Walker:

= Ploceus =

Ploceus is a [https://gradle.org/ Gradle] plugin. It is an extension to [https://wiki.fabricmc.net/documentation:fabric_loom Loom] that configures projects for Orntihe mod development.

== Features ==

==== Basic functionality ====
* Expanding the Minecraft version support with a custom versions manifest.
* Setting up Loom's intermediate mappings provider to use Ornithe's [[Calamus Intermediary|Calamus]] intermediary.
* Upgrading Minecraft libraries.
* Adding additional Minecraft libraries.

==== Additional features ====
* Depending on [[Ornithe Standard Libraries|OSL]].
* Using [[Feather Mappings|Feather]] mappings.
* Applying [[Nests|inner class patches]].
* Applying [[Sparrow|generic type signature patches]].
* Applying [[Raven|throws clause patches]].
* Applying [[Condor|LVT patches]].
* Applying [[Preen|miscellaneous de-obfuscation patches]].

== Using Ploceus ==
The easiest option to make use of Ploceus is to start with [https://github.com/OrnitheMC/ornithe-mod-template Ornithe's Mod Template].

Should you need to add it to an already existing project these steps should cover your needs:

==== Adding Ornithe's maven repository for plugin resolution ====

<code>settings.gradle</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven { url = "https://maven.ornithemc.net/releases" }
maven { url = "https://maven.orntithemc.net/snapshots"
}
}

<code>settings.gradle.kts</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven("https://maven.ornithemc.net/releases")
maven("https://maven.orntithemc.net/snapshots")
}
}

==== Apply the plugin ====

<code>build.gradle</code>
plugins {
/* ... (Other plugins) */
id "ploceus" version "<version>"
}

<code>build.gradle.kts</code>
plugins {
/* ... (Other plugins) */
id("ploceus") version "<version>"
}

===== Note =====

The major and minor Ploceus version must match the major and minor Loom version! For example, if the Loom version is <code>1.10-SNAPSHOT</code>, the Ploceus version must be <code>1.10-SNAPSHOT</code>.

== Configuring Ploceus ==

The latest versions for the relevant dependencies can be found on the [https://ornithemc.net/develop develop] page on the website.

==== Split development environments ====

How you configure Ploceus depends on the Minecraft version you are developing for. Merged client-server development environments are not supported for Minecraft versions before 1.3. For these versions, you must configure Loom and Ploceus for a split development environment. You may use a sub-project structure (see the <code>fabric/split</code> branch on the Ornithe Mod Template) in order to develop both a client mod and a server mod in one project, or choose to develop a client-only or server-only mod.

In either case, you must configure Loom and Ploceus for a one-side-only development environment.

<code>build.gradle</code>
loom {
...
clientOnlyMinecraftJar() // for a client-side-only (sub)project
// serverOnlyMinecraftJar() // for a server-side-only (sub)project
}

ploceus {
...
clientOnlyMappings() // for a client-side-only (sub)project
// serverOnlyMappings() // for a server-side-only (sub)project
}

<code>build.gradle.kts</code>
loom {
...
clientOnlyMinecraftJar() // for a client-side-only (sub)project
// serverOnlyMinecraftJar() // for a server-side-only (sub)project
}

ploceus {
...
clientOnlyMappings() // for a client-side-only (sub)project
// serverOnlyMappings() // for a server-side-only (sub)project
}

==== Mappings ====

It is recommended to use [[Feather Mappings|Feather]] mappings for your mod development environment, though the use of MCP mappings is also supported for a handful of Minecraft versions.

To use Feather mappings, add the <code>mappings</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
mappings ploceus.featherMappings(<Feather build>)
}

<code>build.gradle.kts</code>
dependencies {
...
mappings(ploceus.featherMappings(<Feather build>))
}

To use MCP mappings, add the <code>mappings</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
mappings ploceus.mcpMappings(<MCP channel>, <Minecraft version>, <MCP build>)
}

<code>build.gradle.kts</code>
dependencies {
...
mappings(ploceus.mcpMappings(<MCP channel>, <Minecraft version>, <MCP build>))
}

==== OSL ====

[[Ornithe Standard Libraries|OSL]] provides hooks and events for modding with Ornithe. To use OSL, add the dependency as follows.

<code>build.gradle</code>
dependencies {
...
ploceus.dependOsl(<OSL version>)
// ploceus.dependOsl(<configuration>, <OSL version>) // default configuration is modImplementation
}

<code>build.gradle.kts</code>
dependencies {
...
ploceus.dependOsl(<OSL version>)
// ploceus.dependOsl(<configuration>, <OSL version>) // default configuration is modImplementation
}

You may also depend on individual OSL modules.

<code>build.gradle</code>
dependencies {
...
ploceus.dependOslModule(<OSL version>, <module name>)
// ploceus.dependOslModule(<configuration>, <OSL version>) // default configuration is modImplementation
}

<code>build.gradle.kts</code>
dependencies {
...
ploceus.dependOslModule(<OSL version>, <module name>)
// ploceus.dependOslModule(<configuration>, <OSL version>, <module name>) // default configuration is modImplementation
}

==== Nests ====

[[Nests|Nests]] are Ornithe's inner classes patches. To apply these patches, add the <code>nests</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
nests ploceus.nests(<Nests build>)
}

<code>build.gradle.kts</code>
dependencies {
...
nests(ploceus.nests(<Nests build>))
}

==== Sparrow ====

[[Sparrow|Sparrow]] is Ornithe's generic type signatures patch. To apply these patches, add the <code>signatures</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
signatures ploceus.sparrow(<Sparrow build>)
}

<code>build.gradle.kts</code>
dependencies {
...
signatures(ploceus.sparrow(<Sparrow build>))
}

==== Raven ====

[[Raven|Raven]] is Ornithe's throws clauses patch. To apply these patches, add the <code>exceptions</code> dependency as follows.

<code>build.gradle</code>
dependencies {
...
exceptions ploceus.raven(<Raven build>)
}

<code>build.gradle.kts</code>
dependencies {
...
exceptions(ploceus.raven(<Raven build>))
}

[[Category:Mod Development]]

Ornithe Standard Libraries

2024-02-01T18:47:04Z

Space Walker: add description of osl

Ornithe Standard Libraries (OSL for short) provides tools for mod developers to use in their mods. Much like Fabric API and Quilt Standard Libraries, it aims to be non-invasive yet provide the hooks and APIs that other mods need to add new content.

User:Space Walker

2024-01-30T23:39:54Z

Space Walker: Created page with "I make stuff."

I make stuff.