nintendo(1) improvements

nintendo(1) improvements

[rgl]

[-- Attachment #1: Type: text/plain, Size: 33 bytes --]

is it OK to commit this?

-rodri

[-- Attachment #2: Type: text/plain, Size: 1161 bytes --]

diff -r 287d82efe5f2 sys/man/1/nintendo
--- a/sys/man/1/nintendo	Mon Jan 13 23:22:35 2020 +0000
+++ b/sys/man/1/nintendo	Mon Jan 27 22:30:13 2020 +0100
@@ -55,15 +55,25 @@
 .I snes
 are emulators for the Nintendo Game Boy and Game Boy Color (GB and GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES), and Super Nintendo Entertainment System (SNES).
 They execute the romfile given as an argument.
-The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw\fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
+The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
 Other keys:
 .TP
+F1
+Enter framestep mode.  Every key press will advance one video frame at
+a time until Esc is pressed.
+.TP
 F5
 Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
 F6
 Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
+F12
+Toggle the profiler.
+.TP
+`
+Reach speeds no man has reached before.
+.TP
 Esc
 Pause the emulator.
 .TP

Re: [9front] nintendo(1) improvements

[qwx]

On Mon, Jan 27, 2020 at 10:34:37PM +0100, rgl@antares-labs.eu wrote:
> is it OK to commit this?
> 
> -rodri

Hello,

Thanks for spotting that typo and making these additions.

I'm not sure it's worth documenting the extra keys, but if we do, 
we have to do it for more than just the nintendo(1) emulators, 
since there's now a body of common code for these.

These function keys should also work for 2600(1), sega(1) and games/c64.

If I may make some suggestions, should we decide to go through with this:

- F1 just pauses the game, you can either resume normal operation with the
space key, or press F1 again to step 1 frame, other key presses are ignored.
There's no real "framestep mode".

- to be more precise, F12 prints the emulation speed (ratio between the
expected and observed time it took to draw 60 frames), outside the
drawing area.

- there's also 't', which toggles tracing of the entire emulation
for debugging.

- ` is an unauthorized toggle, deemed dangerous and unsportsmanlike
by starfleet engineers.  However, if you really must document it,
please state exactly what it does, all jokes aside: it uncaps the frame
rate and lets emulation go as fast as possible.  And maybe mention in
BUGS that it is unadvisable and unsportsmanlike?  Dunno.

Just my 2 cents.

Thanks!

qwx

> diff -r 287d82efe5f2 sys/man/1/nintendo
> --- a/sys/man/1/nintendo	Mon Jan 13 23:22:35 2020 +0000
> +++ b/sys/man/1/nintendo	Mon Jan 27 22:30:13 2020 +0100
> @@ -55,15 +55,25 @@
>  .I snes
>  are emulators for the Nintendo Game Boy and Game Boy Color (GB and GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES), and Super Nintendo Entertainment System (SNES).
>  They execute the romfile given as an argument.
> -The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw\fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
> +The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
>  Other keys:
>  .TP
> +F1
> +Enter framestep mode.  Every key press will advance one video frame at
> +a time until Esc is pressed.
> +.TP
>  F5
>  Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
>  .TP
>  F6
>  Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
>  .TP
> +F12
> +Toggle the profiler.
> +.TP
> +`
> +Reach speeds no man has reached before.
> +.TP
>  Esc
>  Pause the emulator.
>  .TP

Re: [9front] nintendo(1) improvements

[Rodrigo G. López]

that's good input, thanks qwx!

i'd like to add these changes in the afternoon. i'll contact you then. :)

On January 27, 2020 10:34:55 PM UTC, qwx <qwx@sciops.net> wrote:
>On Mon, Jan 27, 2020 at 10:34:37PM +0100, rgl@antares-labs.eu wrote:
>> is it OK to commit this?
>> 
>> -rodri
>
>Hello,
>
>Thanks for spotting that typo and making these additions.
>
>I'm not sure it's worth documenting the extra keys, but if we do, 
>we have to do it for more than just the nintendo(1) emulators, 
>since there's now a body of common code for these.
>
>These function keys should also work for 2600(1), sega(1) and
>games/c64.
>
>If I may make some suggestions, should we decide to go through with
>this:
>
>- F1 just pauses the game, you can either resume normal operation with
>the
>space key, or press F1 again to step 1 frame, other key presses are
>ignored.
>There's no real "framestep mode".
>
>- to be more precise, F12 prints the emulation speed (ratio between the
>expected and observed time it took to draw 60 frames), outside the
>drawing area.
>
>- there's also 't', which toggles tracing of the entire emulation
>for debugging.
>
>- ` is an unauthorized toggle, deemed dangerous and unsportsmanlike
>by starfleet engineers.  However, if you really must document it,
>please state exactly what it does, all jokes aside: it uncaps the frame
>rate and lets emulation go as fast as possible.  And maybe mention in
>BUGS that it is unadvisable and unsportsmanlike?  Dunno.
>
>Just my 2 cents.
>
>Thanks!
>
>qwx
>
>> diff -r 287d82efe5f2 sys/man/1/nintendo
>> --- a/sys/man/1/nintendo	Mon Jan 13 23:22:35 2020 +0000
>> +++ b/sys/man/1/nintendo	Mon Jan 27 22:30:13 2020 +0100
>> @@ -55,15 +55,25 @@
>>  .I snes
>>  are emulators for the Nintendo Game Boy and Game Boy Color (GB and
>GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System
>(NES), and Super Nintendo Entertainment System (SNES).
>>  They execute the romfile given as an argument.
>> -The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw\fRreturn and
>shift keys correspond to B, A, Y, X, L1, L2, Start and Select,
>respectively.
>> +The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and
>shift keys correspond to B, A, Y, X, L1, L2, Start and Select,
>respectively.
>>  Other keys:
>>  .TP
>> +F1
>> +Enter framestep mode.  Every key press will advance one video frame
>at
>> +a time until Esc is pressed.
>> +.TP
>>  F5
>>  Save the current state in \fBgb.save\fR / \fBgba.save\fR /
>\fBnes.save\fR / \fBsnes.save\fR.
>>  .TP
>>  F6
>>  Load the current state from \fBgb.save\fR / \fBgba.save\fR /
>\fBnes.save\fR / \fBsnes.save\fR.
>>  .TP
>> +F12
>> +Toggle the profiler.
>> +.TP
>> +`
>> +Reach speeds no man has reached before.
>> +.TP
>>  Esc
>>  Pause the emulator.
>>  .TP

-rodri

Re: [9front] nintendo(1) improvements

[rgl]

[-- Attachment #1: Type: text/plain, Size: 104 bytes --]

ok, how about this one?

i also removed the inexistent T option from the respective emulators.


-rodri

[-- Attachment #2: Type: text/plain, Size: 1587 bytes --]

diff -r 287d82efe5f2 sys/man/1/nintendo
--- a/sys/man/1/nintendo	Mon Jan 13 23:22:35 2020 +0000
+++ b/sys/man/1/nintendo	Tue Jan 28 19:26:04 2020 +0100
@@ -4,7 +4,7 @@
 .SH SYNOPSIS
 .B games/gb
 [
-.B -acdT
+.B -acd
 ]
 [
 .B -C
@@ -17,7 +17,7 @@
 .br
 .B games/gba
 [
-.B -aT
+.B -a
 ] [
 .B -b
 .I biosfile
@@ -41,7 +41,7 @@
 .br
 .B games/snes
 [
-.B -ahmsT
+.B -ahms
 ] [
 .B -x
 .I scale
@@ -55,15 +55,29 @@
 .I snes
 are emulators for the Nintendo Game Boy and Game Boy Color (GB and GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES), and Super Nintendo Entertainment System (SNES).
 They execute the romfile given as an argument.
-The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw\fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
+The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
 Other keys:
 .TP
+F1
+Pause the emulator. If already paused it will step one video frame.
+.TP
 F5
 Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
 F6
 Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
 .TP
+F12
+Toggle the emulator's speedometer.  It shows in the upper left,
+off-viewport corner, the ratio between the expected and observed time it
+took to draw 60 frames.
+.TP
+t
+Toggle tracing of the emulator.
+.TP
+`
+It uncaps the 60fps frame rate and lets emulation go as fast as possible.
+.TP
 Esc
 Pause the emulator.
 .TP

Re: [9front] nintendo(1) improvements

[qwx]

On Tue, Jan 28, 2020 at 07:32:58PM +0100, rgl@antares-labs.eu wrote:
> ok, how about this one?
> 
> i also removed the inexistent T option from the respective emulators.
> 
> 
> -rodri

LGTM!  Could you do the same for the remaining manpages?

Thanks!

qwx