Custom level creation/meta.txt - Revision history

Gelthor: /* Dialogue */ Include a simple example

2025-07-12T14:18:56Z

Dialogue: Include a simple example

@@ Line 67: / Line 67: @@
 === Dialogue ===
-The <Dialogue> format is TODO.
+Dialogue describes a list of pages. Each page consists of an image and some formatted text.
 == Hints ==
 To disable all custom components specify <code>components_available</code> with all of the allowed built-in components, excluding the IO pins.

Gelthor: /* Fields */ copy_solution_to_factory repalces save_solution_as_custom

2025-04-23T13:48:45Z

Fields: copy_solution_to_factory repalces save_solution_as_custom

← Older revision		Revision as of 13:48, 23 April 2025
Line 49:		Line 49:
	** Note: Potentially broken parsing code, might copy stuff to weird locations on small mistakes		** Note: Potentially broken parsing code, might copy stuff to weird locations on small mistakes
	* <code>copy_solution_to_architecture: String</code>		* <code>copy_solution_to_architecture: String</code>
	* <code>~~save_solution_as_custom~~: String</code>		* <code>copy_solution_to_factory: String</code>
	* <code>unlocks_info: String</code>		* <code>unlocks_info: String</code>
	* <code>input_labels: [(String,)\|(String,String)\|(String,String,String)]</code>		* <code>input_labels: [(String,)\|(String,String)\|(String,String,String)]</code>

Gelthor: /* Fields */ Fix formatting

2025-04-09T07:42:36Z

Fields: Fix formatting

← Older revision		Revision as of 07:42, 9 April 2025
Line 42:		Line 42:
	* <code>tick_past_fail: SInt</code>		* <code>tick_past_fail: SInt</code>
	** Run this number of ticks, even after detecting a failure.		** Run this number of ticks, even after detecting a failure.
	** `check_output() must return win on the last tick or the level cannot be completed. An early return win ignores this and can cause the level to succeed before then.		** <code>check_output()</code> must <code>return win</code> on the last tick or the level cannot be completed. An early return win ignores this and can cause the level to succeed before then.
	* <code>output_history_pins: SInt</code>		* <code>output_history_pins: SInt</code>
	** Legacy, '''DO NOT USE''' for new levels.		** Legacy, '''DO NOT USE''' for new levels.

Gelthor: Describe output_history_pins and tick_past_fail

2025-03-22T12:51:28Z

Describe output_history_pins and tick_past_fail

← Older revision		Revision as of 12:51, 22 March 2025
Line 18:		Line 18:
	* <code>tests: SInt</code>		* <code>tests: SInt</code>
	** Number of tests to run, defaults to 1		** Number of tests to run, defaults to 1
			** Will stop after first time <code>check_output()</code> returns <code>fail</code>.
	* <code>title: String</code>		* <code>title: String</code>
	** Pretty name for display in game		** Pretty name for display in game
Line 40:		Line 41:
	** Exclude these Components from the build menu		** Exclude these Components from the build menu
	* <code>tick_past_fail: SInt</code>		* <code>tick_past_fail: SInt</code>
			** Run this number of ticks, even after detecting a failure.
			** `check_output() must return win on the last tick or the level cannot be completed. An early return win ignores this and can cause the level to succeed before then.
	* <code>output_history_pins: SInt</code>		* <code>output_history_pins: SInt</code>
			** Legacy, '''DO NOT USE''' for new levels.
			** For older levels that do not use [[Custom_level_creation/ui.txt\|ui.txt]] configures the display of IO pins on the bottom panel.
	* <code>copy_solution_to_level: [String]</code>		* <code>copy_solution_to_level: [String]</code>
	** Note: Potentially broken parsing code, might copy stuff to weird locations on small mistakes		** Note: Potentially broken parsing code, might copy stuff to weird locations on small mistakes

Altrag at 10:00, 19 February 2025

2025-02-19T10:00:36Z

← Older revision		Revision as of 10:00, 19 February 2025
Line 1:		Line 1:
	~~{{Breadcrumbs\|Alpha Branch\|Custom level creation}}~~
	{{Early-access-version\|0\|1346\|save_breaker}}		{{Early-access-version\|0\|1346\|save_breaker}}

Gelthor: Initial draft

2025-01-19T22:57:30Z

Initial draft

New page

{{Breadcrumbs|Alpha Branch|Custom level creation}}
{{Early-access-version|0|1346|save_breaker}}

<code>meta.txt</code> is a text file that lists a number of fields that describe the level, each field should start on a new line. While most of these are optional you should set at least:
* <code>kind</code>
* <code>size</code>
* <code>title</code>
* <code>dialogue</code>

==Fields==
* <code>kind: LevelKind</code>
** One of <code>misc</code>, <code>combinational</code>, <code>sequential</code>, <code>architecture</code>, <code>factory</code>
* <code>immutable_program: Bool</code>
** Player cannot edit the program in assembley enabled RAM & ROM
* <code>immutable_spec: Bool</code>
** Player cannot edit the <code>spec.isa</code>
* <code>overwrite_assembly: Bool</code>
* <code>no_score: Bool</code>
* <code>tests: SInt</code>
** Number of tests to run, defaults to 1
* <code>title: String</code>
** Pretty name for display in game
* <code>default_isa_spec: String</code>
* <code>default_assembly: String</code>
* <code>no_panel: Bool</code>
* <code>no_state_ui: Bool</code>
* <code>no_controls: Bool</code>
* <code>size: (S16,S16,S16,S16)</code>
** Coordinates of the edges of the allowed draw area <code>(left, top, right, bottom)</code>
** Ignored for architecture levels
* <code>unlocks_components: [ComponentKind]</code>
* <code>components_available: {ComponentKind: SInt}</code>
** This overrides the default component list based on the level progression
** Maximum number of allowed instances of <code>ComponentKind</code>
** -1 means unlimited
** If this option is specified then custom components will NOT be available unless the IO pins (<code>com_cc_input: -1, com_cc_output: -1</code>) are also listed.
* <code>add_components: {ComponentKind: SInt}</code>
** This adds to the default component list based on the level progression
** -1 means unlimited
* <code>remove_components: [ComponentKind]</code>
** Exclude these Components from the build menu
* <code>tick_past_fail: SInt</code>
* <code>output_history_pins: SInt</code>
* <code>copy_solution_to_level: [String]</code>
** Note: Potentially broken parsing code, might copy stuff to weird locations on small mistakes
* <code>copy_solution_to_architecture: String</code>
* <code>save_solution_as_custom: String</code>
* <code>unlocks_info: String</code>
* <code>input_labels: [(String,)|(String,String)|(String,String,String)]</code>
** Same Note, but less danger, just messed up names
* <code>output_labels: [String]</code>
** Same Note
* <code>unlocks_pages: [String]</code>
** Same Note
* <code>unlocks_special: [String]</code>
** Same Note
* <code>background: UInt</code>
* <code>arch_input_word_size: SInt</code>
* <code>next_level: String</code>
* <code>dialogue: Dialogue</code>
* <code>post_mortem_first_win: Dialogue</code>
* <code>post_mortem: Dialogue</code>

=== Dialogue ===
The <Dialogue> format is TODO.

== Hints ==
To disable all custom components specify <code>components_available</code> with all of the allowed built-in components, excluding the IO pins.