app-request: game documentation

[bell07]

I think we need documentation for dev's and for users. The dev's docu is the API.md in repository. For users I propose to write small documentation on for hardware, system and existing apps from users perspective

EDIT: this issue was hijacked to "ingame documentation"

[Gerold55]

Agreed. How should it be setup though? Should it read like an actual laptop manual or just as a mod description?

[bell07]

Laptop manual could be an ingame app oO ;-) I think it should be an overview as showcase for mod capabilities

[Gerold55]

:)

[Crosszover]

ingame user manual available :)

[bell07]

;-) Thanks.. But only the icon, the content still missing ;-(

[bell07]

What you are thinking about the "Help" app that just display the content of existing "README.txt" ? So the player can see the new version ingame and some other basic informations.

[Gerold55]

Under the documentation/wiki needs to be a crafting guide for this mod and add-ons. I hope we can get this part of the mod working soon so we'll be able to make the recipes soon.

[Gerold55]

@Grizzly-Adam what do you think?

[bell07]

The initial idea for this usse was more documentation about the mod for users or developers using github wiki and/or pages.

You mean ingame help like the Wuzzy's documentation system? https://forum.minetest.net/viewtopic.php?f=9&t=15912

and/or https://forum.minetest.net/viewtopic.php?f=11&t=14088

Such mods are usually active in players inventory, if installed so there is no added value if we have them as laptop app

[Gerold55]

I still like the idea of the recipes and about the computer being in the game as a book/wiki

[Grizzly-Adam]

Other than crafting recipes (which we don't have) what information are you thinking of adding? It all seems pretty self explanatory other than CS-BOS which has its own help system built in.

[bell07]

Agree with crafting guide, the information could be generated. But additional documentation needs to be written. Do you like to see a generic guide about all items found in system or a guide that shows laptop related data only? Maybe some "factoids" for doc-system?

[Grizzly-Adam]

Ah, I could write a quirky manual for the end users.

[Gerold55]

The recipes are currently being worked on by @Crosszover & I we have some images of components for the crafting recipes.

[Grizzly-Adam]

I have begun writing a manual for CS-BOS. Also, I writing it in CS-BOS! I will also cover the "shell" in that file.

Do we have a name for our GUI? It is currently known as launcher, but is that official? And what company makes it? That will be my next target for documentation.

[bell07]

Do we need an help app that reads appname_help.txt-file from mod directory and show them in laptop? And a help button in window bar for each app?

[bell07]

I called the ui "ModernOS" or "LaptopOS" but there is no official names. So you can take proposals too

[Grizzly-Adam]

I think that an in-game help button would be good, and one for the GUI as well. I mocked up a couple pictures of where I think the help button should be placed. In the GUI, I think it should become either part of the clock element or be able to be placed anywhere the theme needs it to be, like we did with the clock. I think the later would probably be better.

The button should be able to be made square or circular at the very least.

[bell07]

Agree the help button on launcher should be themes-configurable like the clock.

The position like you propose for text editor cannot proper applied to all apps. My idea was to add the "?" button to the window bar like "back" and "exit" buttons, and manage the functionality fully in launcher. If a "appname_help.txt" exists, show the button... The other way is to introduce "buttons-bar" and adjust all apps to use them

[Grizzly-Adam]

The CS-BOS manual is created and released as a PDF. Do we want to make it an in-game book as well?

[Grizzly-Adam]

re: "?" on menu bar. Pretty soon we will end up needing an actual menu. Maybe we should stop a moment and think if we will be needing to add anything us in the near future.

-HELP -ABOUT -RUN?

[bell07]

Drop-down menus are to dynamic for formspecs :-( There is a simple "drop down" but looks not nice..

Do we really need Help and about? We cannot take "popup window" for about. What should "RUN" do? Trying to keep it simple, may I should just add a mtos:show_help_dialog('app_name') and the help button needs to be added to each app that supports help on individual place.

Where I can see the PDF?

[Grizzly-Adam]

We really need help. The others was me just trying to be forward thinking. If its just the help, we cwn do the ? Wediscussed before.

https://github.com/Grizzly-Adam/Minetest-Laptop-Manuals

[bell07]

I meant do we need both? Agree the "help" is usefull, but unsure about "About". The manual looks good ;-) Can you add the "pdf-source" to the github too? Unsure if DIR FDD does work in the last version. I think I changed it to "VFS-Style", that means DIR FDD: or DIR FDD:* (or dos-like DIR FDD:*.*). The prevous DIR FDD search for a file called FDD :-(

[Grizzly-Adam]

Skip about, just do help. I will upload the odt in the near future.

On Mon, Mar 12, 2018 at 7:41 AM, bell07 notifications@github.com wrote:

I meant do we need both? Agree the "help" is usefull, but unsure about "About". The manual looks good ;-) Can you add the "pdf-source" to the github too? Unsure if DIR FDD does work in the last version. I think I changed it to "VFS-Style", that means DIR FDD: or DIR FDD: (or dos-like DIR FDD:.*). The prevous DIR FDD search for a file called FDD :-(

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Gerold55/minetest-laptop/issues/48#issuecomment-372296158, or mute the thread https://github.com/notifications/unsubscribe-auth/AhktCd3_Fi4ihj1gIii_zlOvhHMxfVNdks5tdmzegaJpZM4Q9euc .

[Gerold55]

Should we have a wiki/documentation app?

[Gerold55]

I think that there should be the question mark but how would we get it to go to the correct page of the wiki?

[Grizzly-Adam]

I am thinking we just hard code each app to look up its own info.

On Tue, Mar 13, 2018 at 1:58 PM, Gerold55 notifications@github.com wrote:

I think that there should be the question mark but how would we get it to go to the correct page of the wiki?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Gerold55/minetest-laptop/issues/48#issuecomment-372780622, or mute the thread https://github.com/notifications/unsubscribe-auth/AhktCUndNmqcE_nA7UJCHZ02IUH39Hlaks5teBbZgaJpZM4Q9euc .

[Gerold55]

Yeah we could do that also.

[bell07]

I think that there should be the question mark but how would we get it to go to the correct page of the wiki?

It is possible to write "selected_page" to the app data before calling the app

[bell07]

Did some draft work for testing and tech-demo in my docu_app branch. The dialog is an app, called from launcher the app show text from apps/launcher_doc.txt file. From other apps the call is possible as implemented in file selection dialog:

            mtos:show_documentation(laptop.modpath.."/apps/os_dialogs_file_selection_help.txt",
                    "Help about file selection dialog")

Because I like how the text view is solved in mail app in last changes, the development requires #102 so the themes enhancement needs to be finalized first

[bell07]

The "Ingame documentation" discussion should be in "Browser" idea issue #67. The documentation could be the first "Website" in app

Back to the initial idea for this issue

Is someone feels missioned to create the first wiki page in real-life at https://github.com/Gerold55/minetest-laptop/wiki ?