BootOpts.grfon - Revision history

Redspark at 02:07, 30 January 2025

2025-01-30T02:07:59Z

JoeStrout: added ignorePrefs

2022-03-20T17:03:13Z

added ignorePrefs

JoeStrout at 15:48, 7 April 2020

2020-04-07T15:48:54Z

JoeStrout at 15:48, 7 April 2020

2020-04-07T15:48:08Z

JoeStrout at 23:13, 6 April 2020

2020-04-06T23:13:47Z

JoeStrout: Created page with "bootOpts.grfon is a file which Mini Micro looks for upon startup, which controls several options about the appearance and behavior of the machine. You may want to..."

2020-04-06T23:10:18Z

Created page with "<c>bootOpts.grfon</c> is a file which Mini Micro looks for upon startup, which controls several options about the appearance and behavior of the machine. You may want to..."

New page

<c>bootOpts.grfon</c> is a file which [[Mini Micro]] looks for upon startup, which controls several options about the appearance and behavior of the machine. You may want to tweak and include this file when [[How to package a Mini Micro game|packaging your game for distribution]].

The file is a plain text file in [http://luminaryapps.com/blog/announcing-grfon-a-kinder-gentler-serialization-format/ GRFON] format, which basically means key:value pairs surrounded by whitespace and comments. Here are the keys supported.

{| class="wikitable"
|-
! Key !! Default Value !! Meaning
|-
| startupChime || true || Whether to play the startup chime when the machine boots
|-
| welcome || true || Whether to show the welcome text (including a handy tip!) on boot
|-
| queryCmd || true || Whether to allow a "cmd=" query parameter (web builds only)
|-
| controlC || true || Whether to allow control-C to interrupt a running program
|-
| diskSlots || true || Whether to show disk slots below the screen (desktop builds only)
|-
| logoSticker || true || Whether to show the "Mini Micro" sticker below the screen
|-
| hasBezel || true || Whether to have a bezel around the screen at all
|-
| bezelImage || 3DBezel.png || 3DBezel.png, FlatBezel.png, or the name of your own PNG file
|-
| bezelTint || #FFFFFF || tint color to apply to the bezel image (in HTML color format, no alpha)
|-
| loadingTint || #FFFFFFFF || color for the "loading, please wait image" (alpha OK)
|}

A reasonable bootOpts.grfon file is included in the StreamingAssets folder of the WebGL template.

← Older revision		Revision as of 02:07, 30 January 2025
Line 77:		Line 77:
	// (use #00000000 if you don't want it to show at all).		// (use #00000000 if you don't want it to show at all).
	loadingTint: #FFFFFF</nowiki>		loadingTint: #FFFFFF</nowiki>
		+
		+	[[Category:Mini Micro]]

@@ Line 1: / Line 1: @@
-<c>bootOpts.grfon</c> is a file which [[Mini Micro]] looks for upon startup, which controls several options about the appearance and behavior of the machine.  You may want to tweak and include this file when [[How to package a Mini Micro game|packaging your game for distribution]].
+''bootOpts.grfon'' is a file which [[Mini Micro]] looks for upon startup, which controls several options about the appearance and behavior of the machine.  You may want to tweak and include this file when [[How to package a Mini Micro game|packaging your game for distribution]].
 The file is a plain text file in [http://luminaryapps.com/blog/announcing-grfon-a-kinder-gentler-serialization-format/ GRFON] format, which basically means key:value pairs surrounded by whitespace and comments.  Here are the keys supported.
@@ Line 31: / Line 31: @@
 == Custom Keys ==
-All the key-value pairs in the <c>bootOpts.grfon</c> file are also loaded into the <c>[[env]]</c> global map as <c>env.bootOpts</c>.  You may add your own custom key-value pairs to the file, and then look them up in <c>env.bootOpts</c> at runtime.
+All the key-value pairs in the ''bootOpts.grfon'' file are also loaded into the <c>[[env]]</c> global map as <c>env.bootOpts</c>.  You may add your own custom key-value pairs to the file, and then look them up in <c>env.bootOpts</c> at runtime.
 == Example ==

← Older revision		Revision as of 15:48, 7 April 2020
Line 29:		Line 29:

	A reasonable bootOpts.grfon file is included in the StreamingAssets folder of the WebGL template.		A reasonable bootOpts.grfon file is included in the StreamingAssets folder of the WebGL template.
		+
		+	== Custom Keys ==
		+	All the key-value pairs in the <c>bootOpts.grfon</c> file are also loaded into the <c>[[env]]</c> global map as <c>env.bootOpts</c>. You may add your own custom key-value pairs to the file, and then look them up in <c>env.bootOpts</c> at runtime.

	== Example ==		== Example ==

← Older revision		Revision as of 23:13, 6 April 2020
Line 29:		Line 29:

	A reasonable bootOpts.grfon file is included in the StreamingAssets folder of the WebGL template.		A reasonable bootOpts.grfon file is included in the StreamingAssets folder of the WebGL template.
		+
		+	== Example ==
		+	<nowiki>// Machine options (read when Mini Micro boots, before disks are loaded).
		+
		+	// Whether to play the startup chime when the machine boots.
		+	startupChime: true
		+
		+	// Whether to show the welcome text (including a handy tip!) on boot.
		+	welcome: true
		+
		+	// Whether to allow a "cmd=" query parameter (web builds only).
		+	queryCmd: true
		+
		+	// Whether to allow control-C to interrupt a running program. CAUTION:
		+	// if you set this to false, and your program enters an infinite loop,
		+	// then your only recourse will be to restart Mini Micro.
		+	controlC: true
		+
		+	// Whether to show the disk slots in the bezel below the screen.
		+	// NOTE: this is ignored in web builds (where disk slots are never shown).
		+	diskSlots: true
		+
		+	// Whether to show the "Mini Micro" sticker in the lower-right corner of the bezel.
		+	logoSticker: true
		+
		+	// Whether to have a bezel at all. Note that if you set this to false, then
		+	// you will get no disk slots or logo sticker regardless of the settings above.
		+	hasBezel: true
		+
		+	// What image to use for the bezel. This can be the name of one of the
		+	// built-in bezels ("3DBezel.png" or "FlatBezel.png"), or the name of a
		+	// PNG file located in the Streaming Assets folder next to this file.
		+	bezelImage: ScratchedBezel.png
		+
		+	// Tint color for the bezel. Specify in HTML color format (same as Mini Micro
		+	// color literals): #RRGGBB, where RR, GG, and BB are hex values from 00 to FF.
		+	// Leave unspecified to get the standard Mini Micro beige bevel.
		+	// Note that alpha is not supported.
		+	//bezelTint: #8888FF
		+
		+	// Color to use for the "loading, please wait" image
		+	// (use #00000000 if you don't want it to show at all).
		+	loadingTint: #FFFFFF</nowiki>

@@ Line 26: / Line 26: @@
 |-
 | loadingTint || #FFFFFFFF || color for the "loading, please wait image" (alpha OK)
 |}