Repo-based creator templates #2304

RedNesto · 2024-06-03T19:14:07Z

Why?

The main motivation is to offload the templates to a separate repo, which are updated independently when opening the creator for the first time in the IDE session. This means templates can be easily updated and tested in real time, no IDE restart (thank goodness.)

Also the creator file template settings became really cluttered and the UI is quite clunky sometimes. Now the templates are stored in a flat dir (zip archives are also supported.)

This also opens the door for anyone to create their own templates, and makes maintaining our templates so much easier (well, I might be biased on that.)

Oh yeah and it also gets rid of some "magic" code gen that breaks embarrassingly often for obscure reasons, so the fabric creator won't have this nasty issue where the main class is incomplete.

Overview

The templates are still Velocity templates, but they are now put together by a JSON file describing a specific template. See the templates repo at https://github.com/minecraft-dev/templates.

Template descriptors mostly contain properties (most of which are displayed in the creator UI) and the template files.

All file templates have access to all the properties in the descriptor. Some string in the descriptor also have access to properties (file template, destination and condition.)

Properties cannot reference properties declared after them (they are setup one by one in a single step.) I chose this limitation so that we cannot easily cause recursion.

Some properties will be of a custom type, or expose an existing class of the plugin, all of those should be marked with @TemplateApi and we should pay attention to not break the source compatibility of those classes without a good reason.

~~Used templates are remembered (only the path, not the files contents), there's no way to register them permanently (this could be added to the main settings eventually)~~ Template repositories can be configured in the main configurable, recent templates are no longer remembered.

Fixes #2294 #2264 #2254 #2252 #2141 #2118 #1835 #804 #771

Earthcomputer · 2024-06-05T17:13:06Z

I've only spent about 5 minutes looking at it so far, but one immediate question I have, is how are you going to make the options and labels translatable?

RedNesto · 2024-06-05T17:24:45Z

Yeah I've been thinking about it, at least for strings in our resource bundle. Unsure what would be the best way to handle translations provided by the repository itself.

Earthcomputer

Haven't tested it yet, but here are some thoughts having read through it. I'm assuming that you'll get rid of the old creator code once this is done?

.gitmodules

src/main/kotlin/creator/custom/providers/TemplateProvider.kt

src/main/kotlin/creator/custom/CustomPlatformStep.kt

src/main/kotlin/creator/custom/EvaluateTemplateExpressionAction.kt

Earthcomputer · 2024-06-05T23:45:07Z

src/main/kotlin/creator/custom/model/CreatorJdk.kt

+data class CreatorJdk(val sdk: Sdk?) {
+
+    val javaVersion: Int
+        get() = sdk?.let { JavaSdk.getInstance().getVersion(it)?.ordinal } ?: 17


Might want to put this 17 in a global default Java version constant somewhere, that we can bump as necessary. MC 1.20.6 is already on Java 21.

Might want to put this 17 in a global default Java version constant somewhere

Fair

that we can bump as necessary. MC 1.20.6 is already on Java 21.

Well, this value is supposed to be the default as a fallback. I expect template authors to always provide a default in the descriptor.

src/main/kotlin/creator/custom/model/TemplateApi.kt

src/main/kotlin/creator/custom/providers/BuiltInTemplateProvider.kt

Earthcomputer · 2024-06-06T00:18:38Z

src/main/kotlin/creator/custom/types/IntegerCreatorProperty.kt

+
+    override fun serialize(value: Int): String = value.toString()
+
+    override fun deserialize(string: String): Int = string.toIntOrNull() ?: 0


Maybe these deserialize functions could return a nullable value, so that if the jsons are invalid a warning could be logged? (and then createDefaultValue could be used)

This is one of the places I couldn't really figure out properly as it was written very early.
Your solution sounds good

So I think I'll keep it like that because createDefaultValue can take anything, usually it's a String, but it can be an Int, Boolean or even a Map if the property supports it.

The serialization methods are meant only for remembering values and have to be from/to Strings.

Deserialize can always fallback to the default value, I leave it up to the implementation to decide.

Earthcomputer · 2024-06-06T00:21:52Z

src/main/kotlin/creator/custom/types/LicenseProperty.kt

+    override fun serialize(value: LicenseData): String = value.id
+
+    override fun deserialize(string: String): LicenseData =
+        LicenseData(string, License.byId(string)?.toString() ?: string, ZonedDateTime.now().year.toString())


Maybe licenses could be made extensible, doesn't have to be in this PR though.

Yes, I simply moved the licenses to the templates repo and reused existing code.
The ids and corresponding files could be provided in a shared descriptor that other descriptors inherit from.

Earthcomputer · 2024-06-06T00:30:51Z

I also noticed that in the template repository, Fabric mod ids are validated to a minimum length of 1, whereas on Fabric mod ids have to be at least of length 2.

RedNesto · 2024-06-06T19:03:25Z

I'll look into improving the template selection, maybe split plugins and mods, and move the providers to the settings so we can have repos saved there and displayed in the creator.

Also fix template condition evaluation

Instead read directly inside them, and allow to configure a different repo root in cases like GitHub's zips, that have a root directory named after the repo and branch name

terminalsin · 2024-07-11T13:14:42Z

This is a huge undertaking and I'm so grateful for the people contributing to making this happen. I'm looking forward to this PR being merged :)

Earthcomputer · 2024-07-11T13:41:09Z

Hi, I've just tried this out, but it's saying there's no templates available:

Do you have any idea why this might be?

RedNesto · 2024-07-11T13:50:28Z

@Earthcomputer Oh that's not supposed to be like that by default. In the settings page there should be a table of template repositories with a Built In default repo. I'll look into it.

Earthcomputer · 2024-07-11T13:55:51Z

Ah yes. It seems the template repositories are empty by default.

RedNesto · 2024-07-11T14:20:32Z

Should be fixed now

Earthcomputer · 2024-07-11T15:13:52Z

Just a couple of things:

Use Mixins should be enabled by default on the Fabric and Architectury platforms, and disabled by default on Forge and NeoForge. I've noticed that the value of this checkbox is connected on all platforms, maybe it should be disconnected (stored with a different key).
FabricApi and ArchitecturyApi should not be in pascal case.
While fetching versions from the internet, there could be an AsyncProgressIcon. In the old creator this is done inside AbstractLatentStep.

RedNesto · 2024-07-12T10:24:31Z

Fixed all of these.

Also I forgot to answer to your question about the old wizard.
I plan on keeping it until the end of the year, so people who have issues with this new one have a "backup". Guess I should add a warning that it will be removed at some point in the future in the UI.

RedNesto added the feature: creator label Jun 3, 2024

Earthcomputer requested changes Jun 6, 2024

View reviewed changes

RedNesto force-pushed the repo-based-project-templates branch from 6007822 to 973540e Compare June 14, 2024 12:36

RedNesto force-pushed the repo-based-project-templates branch from 50d0d5a to ac7dcfa Compare July 2, 2024 16:03

RedNesto added 22 commits July 7, 2024 17:55

Initial custom template system

10d4ca6

Add remember, editable and property derivation

e1c1dc5

Add hidden properties

d56284a

Implement property derivation for all types

2e79118

Actual types implementation

1486196

Also fix template condition evaluation

Some more stuff

bf48447

Some more refactoring to get things working nicely

5386102

Move CreatorProperties to an EP

b7ab23d

Add property UI order

11256de

Move custom template to a separate module builder

f6e3682

Add default values to template descriptor

120a66f

Add option to output null value if default

0bf51a1

Add group/collapsibleGroup support

bc88e1f

Dropdown labels

0b35944

Use segmented buttons for options by default

334f388

Support comma separated string lists

28c9150

Add TemplateProviders

3e43015

WIP Sponge creator

9f1eb1e

Support built-in templates

b84751a

Support multiple templates per provider

217fd08

Remove commented code

82781eb

Remember used templates

a272f5b

RedNesto added 9 commits July 7, 2024 17:59

Fix Parchment property not matching first release of a major mc version

f8a0dd3

NeoForge Kotlin templates

84375b6

Add $version placeholder to remote url

dcc5ca2

Fixup github archive matcher

174fec9

Add Fabric split sources

3c3b5ba

Use Neo's ModDev plugin in 1.21

ae4be36

Improve template error reporting

fad2ebb

Fix Loom's default version selection

dc58e6b

No longer unzip remote templates

1c64ab4

Instead read directly inside them, and allow to configure a different repo root in cases like GitHub's zips, that have a root directory named after the repo and branch name

RedNesto force-pushed the repo-based-project-templates branch from ac7dcfa to 1c64ab4 Compare July 7, 2024 16:06

RedNesto added 2 commits July 8, 2024 17:54

Cache downloaded versions

4a1d63c

Remove superfluous blank line

55cbc54

Earthcomputer self-requested a review July 9, 2024 22:35

RedNesto added 2 commits July 11, 2024 16:19

Actually add the builtin repo by default

cba685f

Hide the repositories row if only one repo is configured

1ce67eb

RedNesto added 6 commits July 11, 2024 17:19

Proper module generation for finalizers

4e61b15

Update templates submodule

c6ad8d0

Add customizable storage keys

d61a9bc

Rename FabricApi -> Fabric API and ArchitecturyApi -> Architectury API

4b637f7

Remove dead code

36b34ae

Add versions download indicator

e5e5832

Earthcomputer approved these changes Jul 12, 2024

View reviewed changes

Earthcomputer merged commit 85e493a into minecraft-dev:dev Jul 12, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repo-based creator templates #2304

Repo-based creator templates #2304

RedNesto commented Jun 3, 2024 •

edited

Loading

Earthcomputer commented Jun 5, 2024

RedNesto commented Jun 5, 2024

Earthcomputer left a comment

Earthcomputer Jun 5, 2024

RedNesto Jun 6, 2024

Earthcomputer Jun 6, 2024

RedNesto Jun 6, 2024

RedNesto Jul 12, 2024

Earthcomputer Jun 6, 2024

RedNesto Jun 6, 2024

Earthcomputer commented Jun 6, 2024

RedNesto commented Jun 6, 2024

terminalsin commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 12, 2024


		override fun serialize(value: Int): String = value.toString()

		override fun deserialize(string: String): Int = string.toIntOrNull() ?: 0

Repo-based creator templates #2304

Repo-based creator templates #2304

Conversation

RedNesto commented Jun 3, 2024 • edited Loading

Why?

Overview

Earthcomputer commented Jun 5, 2024

RedNesto commented Jun 5, 2024

Earthcomputer left a comment

Choose a reason for hiding this comment

Earthcomputer Jun 5, 2024

Choose a reason for hiding this comment

RedNesto Jun 6, 2024

Choose a reason for hiding this comment

Earthcomputer Jun 6, 2024

Choose a reason for hiding this comment

RedNesto Jun 6, 2024

Choose a reason for hiding this comment

RedNesto Jul 12, 2024

Choose a reason for hiding this comment

Earthcomputer Jun 6, 2024

Choose a reason for hiding this comment

RedNesto Jun 6, 2024

Choose a reason for hiding this comment

Earthcomputer commented Jun 6, 2024

RedNesto commented Jun 6, 2024

terminalsin commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 11, 2024

Earthcomputer commented Jul 11, 2024

RedNesto commented Jul 12, 2024

RedNesto commented Jun 3, 2024 •

edited

Loading