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..."

2025-07-31T14:57:40Z

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..."

New page

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]]

Setting up a Mod Development Environment - Revision history