Add warning when trying to run Fabric API as an executable #1196

IMS212 · 2020-12-02T05:38:25Z

This PR shows this when the jar is run as an executable. This would fix a lot of the confusion around the API, and the current code does not seem to have problems with anything else in the API.

modmuss50 · 2020-12-02T08:37:49Z

I don’t believe we are allowed to release this onto curseforge. I’m 99% sure that executable jars are against the TOS. Please correct me if I’m wrong.

IMS212 · 2020-12-02T16:23:30Z

I have asked around, and it seems it is in the clear. BetterFPS does this as well and is allowed on curseforge.

liach · 2021-01-08T05:20:52Z

src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

+
+public final class APIWarning {
+	public static void main(String[] args) {
+		String st = "Fabric API is not meant to be run.\nPlease place this file in your mods folder.";


Preferably this should be handled by a resource bundle

liach · 2021-01-08T05:21:59Z

build.gradle

+				attributes 'Implementation-Title': 'FabricAPI',
+						'Implementation-Version': project.version,
+						'Main-Class': 'net.fabricmc.fabric.impl.launch.APIWarning'
+			}


You should move this block into tasks.withType(Jar) so this implementation info and main class is available for any jar produced

I think I've fixed both these, you mind reviewing again?

Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

IMS212 · 2021-01-12T01:21:44Z

Wait, what? I didn't remove the request for API developers

i509VCB · 2021-01-12T01:29:22Z

src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

+	public static void main(String[] args) {
+		Locale defaultLocale = Locale.getDefault();
+		ResourceBundle WarningAPI = ResourceBundle.getBundle("lang/WarningAPI", defaultLocale);
+		JOptionPane.showMessageDialog(null, WarningAPI.getString("api.warning"));


This will fail if fabric api is run in a headless environment. Just check GraphicsEnvironment to validate that otherwise print the message in sys out.

Would system error be better? Since it's already an error, and this way it will be highlighted red (in consoles/terminals that treat error differently to out).

this has been fixed with Alex's PR

liach · 2021-01-12T01:34:18Z

src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

-		String st = "Fabric API is not meant to be run.\nPlease place this file in your mods folder.";
-		JOptionPane.showMessageDialog(null, st);
+		Locale defaultLocale = Locale.getDefault();
+		ResourceBundle WarningAPI = ResourceBundle.getBundle("lang/WarningAPI", defaultLocale);


I hope we can have a bundle setup like https://github.com/FabricMC/fabric-installer/blob/e76d587e22ae9767c0f97fc782c991e461881b1c/src/main/java/net/fabricmc/installer/util/Utils.java#L36-L50 so that we don't need to use iso encoding and ugly unicode escapes for the translation properties

* Fix headless exception. (This seems to work for me locally?) * Spaces -> Tabs. * msg -> message. * Fix uppercase variable name (by inlining it).

@AlexIIL

…hanks to @AlexIIL Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

IMS212 · 2021-01-12T04:15:11Z

It's been updated with both ResourceBundles and headless support, you mind re-reviewing?

OroArmor · 2021-01-12T04:35:11Z

I would also add something to link to the fabric installer, so that people can install the loader if they don't have it yet

Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

IMS212 · 2021-01-12T04:38:46Z

Done.

liach · 2021-01-12T05:33:13Z

src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

+
+public final class APIWarning {
+	public static void main(String[] args) {
+		final ResourceBundle WarningAPI = ResourceBundle.getBundle("lang/WarningAPI", Locale.getDefault(), new ResourceBundle.Control() {


we prefer name the local var in lower camel like warningApi

williambl · 2021-01-26T15:19:11Z

src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

+					e.printStackTrace();
+				}
+
+					return super.newBundle(baseName, locale, format, loader, reload);


Indentation

Suggested change

return super.newBundle(baseName, locale, format, loader, reload);

return super.newBundle(baseName, locale, format, loader, reload);

Should be good? Unless you mean a different area

Co-authored-by: liach <7806504+liach@users.noreply.github.com>

teddyxlandlee · 2022-08-22T01:05:13Z

Buddy, this made me laugh 😆

Is this really necessary? I believe 95%+ of players know this should be dragged into mods directory. Other mod APIs, including Forge, Quilt & LiteLoader haven't shown up a warning like this.

If players don't know Fabric API is a mod instead of an executable library, you can add a tip in the installer, noticing them download Fabric API in CurseForge/Modrinth and put it into mods directory. Besides, can't those players who download Fabric API in CurseForge/Modrinth realize such a thing from such a website should be treated as a mod? I think it's not our duty to add a dumb Swing app & make Fabric API fatter and fatter.

LambdAurora · 2022-08-22T10:31:46Z

@teddyxlandlee

Accessibility features make you laugh? sad

While, yes, a large user base should know this should be put into the mods directory, there's also the question of new users.
In one of my most recent user support I've encountered an user who seemed to be a computer novice, which made the user support quite more intense. I don't think being hostile to new users and features facilitating support is a good approach.

This comment honestly comes off as a rather elitist take and hostile towards new users. I would rather not have the same issue as Linux here in Fabric or its alternatives.

apple502j · 2022-08-22T11:05:56Z

This feature looks good, but I believe it should belong in Loom so that everyone can use it (with optout ofc). Also the branch is 1.16, which is way outdated.

teddyxlandlee · 2022-08-22T14:30:34Z

This feature looks good, but I believe it should belong in Loom so that everyone can use it (with optout ofc). Also the branch is 1.16, which is way outdated.

Great idea!

However, I think the class should be shrunk as small as possible. Using proguard and package-less class name can shrink it in a specific way.

Also, add a boolean toggle in remapJar. If it is set to true, the already-shrunk class binary will be dumped into the jar along with Main-Class manifest (if not set).

To make it short:

The class may be mod-insensitive, which means Fabric API uses the same class & the same warning text as other mods.
No resource bundles, if possible. Texts are stored inside the class directly. Also, it's a bad idea to let the class trying to understand fabric.mod.json.
Loom copies the already-configured class binary into your remapped jar. This means you don't need to compile it again, because the binary has been stored in Loom.

IMS212 · 2022-08-22T16:16:36Z

This was made as my first PR ever. I am now a developer for many mods, and can likely recreate this much better, so as such, I'll close this.

IMS212 · 2022-08-22T16:17:08Z

This feature looks good, but I believe it should belong in Loom so that everyone can use it (with optout ofc). Also the branch is 1.16, which is way outdated.

How would it be included in Loom? Would it just embed itself into the jar?

teddyxlandlee · 2022-08-23T00:36:54Z

How would it be included in Loom? Would it just embed itself into the jar?

To store the class file in Loom, and dumps it into remapJar along with Main-Class manifest attribute.

IMS212 added 4 commits December 1, 2020 19:37

Add warning when trying to run API

1728f16

API warning should actually work now when built

4db66cd

make class final

bf48558

(Hopefully) final commit: Make warning work after remap

2719b5f

i509VCB added enhancement New feature or request small change labels Dec 2, 2020

i509VCB requested review from a team December 2, 2020 05:39

OroArmor approved these changes Dec 2, 2020

View reviewed changes

OverlordsIII approved these changes Jan 4, 2021

View reviewed changes

liach reviewed Jan 8, 2021

View reviewed changes

Added Resource Bundles and changed build.gradle

96629d9

Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

IMS212 requested review from liach and removed request for a team January 12, 2021 01:21

i509VCB requested review from a team January 12, 2021 01:27

i509VCB reviewed Jan 12, 2021

View reviewed changes

liach reviewed Jan 12, 2021

View reviewed changes

AlexIIL mentioned this pull request Jan 12, 2021

Fix headless exception, and use the system look and feel. IMS212/fabric#1

Merged

AlexIIL and others added 2 commits January 11, 2021 19:19

Fix headless exception, and use the system look and feel. (#1)

421f382

* Fix headless exception. (This seems to work for me locally?) * Spaces -> Tabs. * msg -> message. * Fix uppercase variable name (by inlining it).

Added different method of resource bundles, and headless mode works t…

8557083

…hanks to @AlexIIL Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

Add message about Fabric Installer

43a85a6

Signed-off-by: IMS <31803019+IMS212@users.noreply.github.com>

liach reviewed Jan 12, 2021

View reviewed changes

Rename WarningAPI to warningApi

92aea92

liach approved these changes Jan 12, 2021

View reviewed changes

YTG1234 approved these changes Jan 12, 2021

View reviewed changes

nnym approved these changes Jan 12, 2021

View reviewed changes

i509VCB added the priority:low Low priority PRs that don't immediately need to be resolved label Jan 19, 2021

williambl reviewed Jan 26, 2021

View reviewed changes

Update src/main/java/net/fabricmc/fabric/impl/launch/APIWarning.java

a034eac

Co-authored-by: liach <7806504+liach@users.noreply.github.com>

LambdAurora requested a review from a team April 10, 2021 10:47

IMS212 changed the base branch from 1.16 to 1.17 July 12, 2021 21:36

IMS212 changed the base branch from 1.17 to 1.16 July 12, 2021 21:36

Juuxel approved these changes Oct 7, 2021

View reviewed changes

IMS212 changed the base branch from 1.16 to 1.17 October 7, 2021 14:13

IMS212 changed the base branch from 1.17 to 1.16 October 7, 2021 14:14

williambl approved these changes Jan 14, 2022

View reviewed changes

IMS212 closed this Aug 22, 2022

teddyxlandlee mentioned this pull request Aug 23, 2022

Add warning when trying to run a mod as an executable FabricMC/fabric-loom#705

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add warning when trying to run Fabric API as an executable #1196

Add warning when trying to run Fabric API as an executable #1196

IMS212 commented Dec 2, 2020 •

edited

modmuss50 commented Dec 2, 2020

IMS212 commented Dec 2, 2020

liach Jan 8, 2021

liach Jan 8, 2021

IMS212 Jan 12, 2021

IMS212 commented Jan 12, 2021

i509VCB Jan 12, 2021

AlexIIL Jan 12, 2021

IMS212 Jan 12, 2021

liach Jan 12, 2021

IMS212 commented Jan 12, 2021

OroArmor commented Jan 12, 2021

IMS212 commented Jan 12, 2021

liach Jan 12, 2021

IMS212 Jan 12, 2021

williambl Jan 26, 2021

liach Jan 26, 2021

IMS212 Jan 26, 2021

teddyxlandlee commented Aug 22, 2022

LambdAurora commented Aug 22, 2022

apple502j commented Aug 22, 2022

teddyxlandlee commented Aug 22, 2022

IMS212 commented Aug 22, 2022

IMS212 commented Aug 22, 2022

teddyxlandlee commented Aug 23, 2022 •

edited

	return super.newBundle(baseName, locale, format, loader, reload);
	return super.newBundle(baseName, locale, format, loader, reload);

Add warning when trying to run Fabric API as an executable #1196

Add warning when trying to run Fabric API as an executable #1196

Conversation

IMS212 commented Dec 2, 2020 • edited

modmuss50 commented Dec 2, 2020

IMS212 commented Dec 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMS212 commented Jan 12, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMS212 commented Jan 12, 2021

OroArmor commented Jan 12, 2021

IMS212 commented Jan 12, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

teddyxlandlee commented Aug 22, 2022

LambdAurora commented Aug 22, 2022

apple502j commented Aug 22, 2022

teddyxlandlee commented Aug 22, 2022

IMS212 commented Aug 22, 2022

IMS212 commented Aug 22, 2022

teddyxlandlee commented Aug 23, 2022 • edited

IMS212 commented Dec 2, 2020 •

edited

teddyxlandlee commented Aug 23, 2022 •

edited