Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ the game as it's made.
**Status:** Mission mode's Script view works. It opens a mod's missions, a mission file or one of
the game's own missions as source, colours it with the game's commands, checks it as it's typed,
offers the game's commands and conditions as you type, explains them on hover and in the Reference
panel, builds the mission, and plays it in OpenReliant, from its start or from a part. The rest of
the [design](design/README.md) is in place and greyed out, each part with the issue that plans it.
panel, builds the mission, and plays it in OpenReliant, from its start or from a part. Linked to the
game, it holds the mission's script at breakpoints, steps through it, and shows its threads and
values ([Debugging a mission](docs/debugging.md)). The rest of the [design](design/README.md) is in
place and greyed out, each part with the issue that plans it.
The plan is OpenReliant's [#1126](https://github.com/OpenReliant/openreliant/issues/1126).

![The Script view of a mission, held at a breakpoint](design/images/mission-script.png)
Expand Down
4 changes: 2 additions & 2 deletions build.zig.zon
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
.minimum_zig_version = "0.17.0",
.dependencies = .{
.openreliant = .{
.url = "git+https://github.com/OpenReliant/openreliant.git#fd5d7dec75b2d9a3748c39f203699d82918b254e",
.hash = "openreliant-0.14.0-0BXqcn9DEAGMfVU3sRjik-iid3jrPhuvcGUVgqUSJcTc",
.url = "git+https://github.com/OpenReliant/openreliant.git#70b3beab1484b3eb511dd64aaf959d3a8b5f5c15",
.hash = "openreliant-0.14.0-0BXqcnShEAG_H5YxFly2WGyqTSBGL6SZFbbnz4JPkD9b",
},
.sdl = .{
.url = "git+https://github.com/castholm/SDL.git?ref=v0.5.4+3.4.16#b72b3671502a70e109350ecac90afdc480dcfcc6",
Expand Down
16 changes: 15 additions & 1 deletion design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ catalogue's descriptions, and the command's reference. The game keeps playing th

[Page](screens/mission-debugging.html). The script listing beside the source, breakpoints with
conditions and log points, which the editor checks each time the game holds, watches, and a
timeline of the run on the script clock.
timeline of the run on the script clock ([The debugger](#the-debugger)).

### Command palette

Expand Down Expand Up @@ -178,6 +178,20 @@ Cmd for Ctrl. Changed keys are saved for each system on its own.

[Page](screens/keys-macos.html). The same settings on macOS.

### Editor link

![The Editor link settings](images/settings-link.png)

[Page](screens/settings-link.html). Linking when playing, the game's port, how often the state
comes while the script runs, the breakpoints kept, and live changes once OpenReliant takes them,
with the linked game beside them.

## The debugger

[debugger.md](debugger.md) designs the debugger and its link to the game: what it does and shows,
the link's messages, what the editor checks itself, what OpenReliant still needs, and the stages to
make it in.

## Libraries

| Part | Library |
Expand Down
270 changes: 270 additions & 0 deletions design/debugger.md

Large diffs are not rendered by default.

Binary file modified design/images/keys-macos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified design/images/keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified design/images/mission-blocks-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified design/images/mission-blocks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified design/images/mission-script.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/images/settings-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion design/screens/keys-macos.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<div class="kr"><span class="act"><span class="dot diff"></span>Run to cursor</span><span class="kc-off"><span class="key">Ctrl+F10</span></span><span class="kc-on"><span class="key">Ctrl+Cmd+C</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Breakpoint on or off</span><span class="kc-off"><span class="key">F9</span></span><span class="kc-on"><span class="key">Cmd+\</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Pause mission</span><span class="kc-off"><span class="key">F6</span></span><span class="kc-on"><span class="key">F8</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Let the script go</span><span class="kc-off"><span class="key">Shift+F5</span></span><span class="kc-on"><span class="key">Cmd+.</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Unlink</span><span class="kc-off"><span class="key">Shift+F5</span></span><span class="kc-on"><span class="key">Cmd+.</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>

<div class="kg sect">Build and play</div>
<div class="kr"><span class="act"><span class="dot"></span>Build</span><span class="kc-off"><span class="key">Ctrl+B</span></span><span class="kc-on"><span class="key">Cmd+B</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
Expand Down
2 changes: 1 addition & 1 deletion design/screens/keys.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<div class="kr"><span class="act"><span class="dot diff"></span>Run to cursor</span><span class="kc-on"><span class="key">Ctrl+F10</span></span><span class="kc-off"><span class="key">Ctrl+Cmd+C</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Breakpoint on or off</span><span class="kc-on"><span class="key">F9</span></span><span class="kc-off"><span class="key">Cmd+\</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Pause mission</span><span class="kc-on"><span class="key">F6</span></span><span class="kc-off"><span class="key">F8</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Let the script go</span><span class="kc-on"><span class="key">Shift+F5</span></span><span class="kc-off"><span class="key">Cmd+.</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
<div class="kr"><span class="act"><span class="dot diff"></span>Unlink</span><span class="kc-on"><span class="key">Shift+F5</span></span><span class="kc-off"><span class="key">Cmd+.</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>

<div class="kg sect">Build and play</div>
<div class="kr"><span class="act"><span class="dot"></span>Build</span><span class="kc-on"><span class="key">Ctrl+B</span></span><span class="kc-off"><span class="key">Cmd+B</span></span><button class="edit" type="button" aria-label="Change the key"><svg class="i i12" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 20h4L19 9l-4-4L4 16z"></path></svg></button></div>
Expand Down
4 changes: 2 additions & 2 deletions design/screens/mission-blocks-flow.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,13 @@
<button class="tb tbi" type="button" aria-label="Pause the mission">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><path d="M9 5v14"></path><path d="M15 5v14"></path></svg>
</button>
<button class="tb tbi" type="button" aria-label="Let the script go">
<button class="tb tbi" type="button" aria-label="Unlink">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><rect x="6" y="6" width="12" height="12" rx="1.5"></rect></svg>
</button>
<div style="margin-left: auto; display: flex; flex-wrap: wrap; align-items: center; gap: 8px">
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border-radius: 13px; background: #2a1a0d; color: #ffd2a6; font-size: 12px">
<span aria-hidden="true" style="width: 7px; height: 7px; border-radius: 50%; background: #f08a2c"></span>
Held before Set AI
Held · Set AI
<span class="mono" style="color: #c79a73">41.8 s</span>
</span>
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border: 1px solid #1f3b37; border-radius: 13px; background: #0f1d1c; color: #bfeee5; font-size: 12px">
Expand Down
4 changes: 2 additions & 2 deletions design/screens/mission-blocks.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,13 @@
<button class="tb tbi" type="button" aria-label="Pause the mission">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><path d="M9 5v14"></path><path d="M15 5v14"></path></svg>
</button>
<button class="tb tbi" type="button" aria-label="Let the script go">
<button class="tb tbi" type="button" aria-label="Unlink">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><rect x="6" y="6" width="12" height="12" rx="1.5"></rect></svg>
</button>
<div style="margin-left: auto; display: flex; flex-wrap: wrap; align-items: center; gap: 8px">
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border-radius: 13px; background: #2a1a0d; color: #ffd2a6; font-size: 12px">
<span aria-hidden="true" style="width: 7px; height: 7px; border-radius: 50%; background: #f08a2c"></span>
Held before Set AI
Held · Set AI
<span class="mono" style="color: #c79a73">41.8 s</span>
</span>
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border: 1px solid #1f3b37; border-radius: 13px; background: #0f1d1c; color: #bfeee5; font-size: 12px">
Expand Down
2 changes: 1 addition & 1 deletion design/screens/mission-debugging.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
<button class="tb tbi" type="button" aria-label="Pause the mission">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><path d="M9 5v14"></path><path d="M15 5v14"></path></svg>
</button>
<button class="tb tbi" type="button" aria-label="Let the script go">
<button class="tb tbi" type="button" aria-label="Unlink">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><rect x="6" y="6" width="12" height="12" rx="1.5"></rect></svg>
</button>
<div style="margin-left: auto; display: flex; flex-wrap: wrap; align-items: center; gap: 8px">
Expand Down
4 changes: 2 additions & 2 deletions design/screens/mission-script.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@
<button class="tb tbi" type="button" aria-label="Pause the mission">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><path d="M9 5v14"></path><path d="M15 5v14"></path></svg>
</button>
<button class="tb tbi" type="button" aria-label="Let the script go">
<button class="tb tbi" type="button" aria-label="Unlink">
<svg class="i" viewBox="0 0 24 24" aria-hidden="true"><rect x="6" y="6" width="12" height="12" rx="1.5"></rect></svg>
</button>
<div style="margin-left: auto; display: flex; flex-wrap: wrap; align-items: center; gap: 8px">
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border-radius: 13px; background: #2a1a0d; color: #ffd2a6; font-size: 12px">
<span aria-hidden="true" style="width: 7px; height: 7px; border-radius: 50%; background: #f08a2c"></span>
Held before line 46
Held · line 46
<span class="mono" style="color: #c79a73">41.8 s</span>
</span>
<span style="display: inline-flex; align-items: center; gap: 7px; height: 26px; padding: 0 11px; border: 1px solid #1f3b37; border-radius: 13px; background: #0f1d1c; color: #bfeee5; font-size: 12px">
Expand Down
Loading
Loading