Language reference/wiki of some kind

[XDuskAshes]

I might just be blind, but I can't find a reference for the SFM language (what even is the actual name?) anywhere, and I feel like it would be good to have somewhere (especially for new players).

Yes I know the examples exist, but having formal documentation somewhere would be very useful for people to discover various things about the language and the mod by extension.

[TeamDman]

there's also the deepwiki which is autogenerated
https://deepwiki.com/TeamDman/SuperFactoryManager

[XDuskAshes]

I see.

I understand this is a quick way to have good documentation (and strangely accurate for AI generation), however there should be some kind of thinking put toward a hand-made one. Insert the same hundred-times-restated issues with AI not only for the environment and other people's lives but also how inaccurate it can be quite often etc etc.

[TeamDman]

I'd like to do an in-game tutorial similar to the video game Portal so that you don't have to leave the game to learn more.

Right now there's the example system, can you comment on what the examples experience is lacking?

There's also the grammar file that isn't viewable in-game yet which might be closer to what you're looking for in terms of a language reference

https://github.com/TeamDman/SuperFactoryManager/blob/1.19.2/src/main/antlr/sfml/SFML.g4

[XDuskAshes]

Right now there's the example system, can you comment on what the examples experience is lacking?

From the typical standpoint of a new player, most people who try to use this are playing a modpack (i.e. ATM 10) and likely don't have any experience programming whatsoever. While I'll admit the examples are good, quite a few feel like they require people to have a deeper knowledge of things in programming. Speaking from experience, when I started out with the mod a while ago I could hardly understand stuff from the Examples tab and had to go out of my way to find a video that went over the mod.

I'd like to do an in-game tutorial similar to the video game Portal so that you don't have to leave the game to learn more.

This could be where the Examples tab fits, or perhaps a separate tab labeled "Tutorial" organized to teach people how to use the mod.

TLDR the examples tab is good, but I wouldn't say good enough for most newbies, and a dedicated and organized tutorial is good so people don't have to hop out of the mod to learn.

You may also want to invest in word/line wrapping or a proper way of scrolling left and right, as some examples have comments extending past the screen. I also apologize if my tone comes off wrong here, I really do not mean to come off like an ass or a robot.

[TeamDman]

Thank you for the feedback! I want to make the mod accessible to everyone, so it's valuable to hear what isn't working and can be improved.

The line wrapping is a tricky thing; the original scrollable text area code from Minecraft supports line wrapping, but in my efforts to add syntax highlighting and support for super long text streams for the logs the line wrapping was dropped.

Right now the editor and gui scale behave a bit silly, I think horizontal scrolling would be an easy addition, and it would be even better to make the font size and screen size adjustable independently of the gui scale.

[XDuskAshes]

Of course :D
This is an amazing mod and I want more people to know about it, especially since when paired with other mods it can do a ton of powerful stuff like a giant megafurnace setup that smelts everything from a single mining trip in a single second

[TeamDman]

My current brainstorm for the tutorial would be some kind of /sfm tutorial command that would teleport you to a voidworld with generated test chambers that walk the user through every aspect of the mod.

The old witchery dream world had a your-inventory-must-be-empty-to-enter constraint which was fun to see all the workarounds for. If people find a way to ferry a pickaxe into the tutorial and mine the machines then that's just funny lol

Maybe some kind of linear hub world that lets you jump around if you want but still provides a clear starting point