Skip to content

Commit

Permalink
Readme updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
maziac committed Jan 2, 2021
1 parent 5e241a2 commit 321fa9e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you like the "ZX NEX File Viewer" please consider supporting it.


This extension adds a readonly file viewer for ZX Spectrum NEX files.
It is a special file format for loading ZX Next programs.
.nex is a special file format for loading ZX Next programs.
The viewer shows registers, a memory dump and the included screen images.

The NEX file format specification can be found [here](https://wiki.specnext.dev/NEX_file_format).
Expand All @@ -30,10 +30,10 @@ The file is opened and shown in the text editor area.

![](assets/usage.gif)

Alternatively you can open a SNA file via "Open With...":
Alternatively you can open a NEX file via "Open With...":

![](assets/usage-open-with.gif)

When hovering over a value or register name you will get additional info like the offset or the value in decimal:
When hovering over a value you can get additional info like the offset or the value in decimal:

![](assets/hovering.gif)
Binary file added assets/hovering.gif
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 assets/usage-open-with.gif
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 assets/usage.gif
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 src/editorprovider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export class EditorProvider implements vscode.CustomReadonlyEditorProvider {
mainHtml = mainHtml.replace('${vscodeResPath}', vscodeResPath);

// Add a Reload and Copy button for debugging
mainHtml = mainHtml.replace('<body>', '<body><button onclick="parseStart()">Reload</button><button onclick="copyHtmlToClipboard()">Copy HTML to clipboard</button>');
//mainHtml = mainHtml.replace('<body>', '<body><button onclick="parseStart()">Reload</button><button onclick="copyHtmlToClipboard()">Copy HTML to clipboard</button>');

return mainHtml;
}
Expand Down
12 changes: 6 additions & 6 deletions src/html/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function parseRoot() {
}
createNode('RAM_REQUIRED', ramReqValue, 'The required RAM.');
addDescription('0 = 768k, 1 = 1792k');
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());

read(1);
createNode('NUM_BANKS', decimalValue(), 'Number of 16k Banks to Load: 0-112');
Expand All @@ -94,16 +94,16 @@ Only Layer2, Tilemap and Lo-Res screens expect the palette block (unless +128 fl

read(1);
createNode('BORDER_COLOR', zxColorValue(), 'Border Color: 0-7');
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());

read(2);
createNode('SP', hex0xValue(), 'Stack pointer');
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());

read(2);
createNode('PC', hex0xValue(), 'Program counter');
addDescription("0 = don't run, just load");
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());

read(2);
createNode('NUM_FILES', decimalValue(), 'Number of extra files');
Expand Down Expand Up @@ -167,7 +167,7 @@ When screens 320x256x8 or 640x256x4 are used, this byte is re-used as palette of
read(2);
createNode('FILE_HANDLE_ADDR', hexValue(), 'File handle address');
addDescription('0 = NEX file is closed by the loader, 1..0x3FFF values (1 recommended) = NEX loader keeps NEX file open and does pass the file handle in BC register, 0x4000..0xFFFF values (for 0xC000..0xFFFF see also "Entry bank") = NEX loader keeps NEX file open and the file handle is written into memory at the desired address.');
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());
// End of version 1.2 header
assert(lastOffset + lastSize == 142);

Expand Down Expand Up @@ -195,7 +195,7 @@ When screens 320x256x8 or 640x256x4 are used, this byte is re-used as palette of
read(4);
createNode('BANKS_OFFSET', hexValue(), 'File offset of first bank data');
addDescription('File offset of first bank data (when loader is parsing known version, it should know where the banks start without this value, but it may use it for extra check whether the parsing of optional blocks between header and first bank was done correctly for files V1.3+, or it may even try to partially-load unknown future versions of NEX files by skipping unknown blocks between header and banks data, although that may lead to unexpected state for the app)');
addHoverValue(decimalValue());
addHoverValue('Dec: ' + decimalValue());

read(2);
createNode('CLI_BUFFER_ADDR', decimalValue(), 'CLI buffer address');
Expand Down

0 comments on commit 321fa9e

Please sign in to comment.