1
0
mirror of https://github.com/fadden/6502bench.git synced 2024-07-07 07:28:57 +00:00
6502bench/SourceGen/RuntimeData
Andy McFadden adf5726f62 Add daily tips to start screen
The initial screen is largely blank, with just the four large buttons
for new/open/recent1/recent2.  It now also has a "tip of the day" box,
with text and an optional image.

The tips and images are kept in the RuntimeData directory.  They're
small enough that they could have been baked into the binary, but
there's enough other stuff going on there that it didn't seem
necessary.  Also, if the tips annoy you, removing the tips file will
hide the tip UI.

The index of the tip shown is based on the day of the year, modulo
the number of defined tips.  So it will be different every day (with
a bit of hand-waving at the end of the year).
2021-10-16 09:15:28 -07:00
..
Apple Fix lastOffset calculations in Apple II hi-res visualizer 2021-05-17 17:28:13 -07:00
Atari Add simple SGEC reader 2020-04-13 17:33:34 -07:00
Commodore Various minor tweaks 2019-12-07 11:42:26 -08:00
Nintendo Fixes that reflect feedback. 2021-07-29 23:46:05 +09:00
Oric Modifying errors after feedback 2021-07-03 22:57:33 +02:00
TestData Initial file commit 2018-09-28 10:05:11 -07:00
Tips Add daily tips to start screen 2021-10-16 09:15:28 -07:00
ExportTemplate.html Update HTML export to use HTML 5 2021-05-23 11:27:42 -07:00
LegalStuff.txt Mention VS2017 icon library usage 2020-09-04 18:20:26 -07:00
README.md Updated the RuntimeData README 2020-01-01 18:06:59 -08:00
RuntimeData.csproj Initial file commit 2018-09-28 10:05:11 -07:00
SGStyle.css ORG rework, part 9 2021-10-07 12:39:30 -07:00
SystemDefs.json Clarify 2021-08-09 16:22:17 -07:00

Runtime Data

Symbol files and analyzer scripts are split into directories by platform manufacturer.

The Visual Studio project (RuntimeData.csproj) exists so you can edit scripts with IntelliSense and error highlighting. Everything here is distributed as source, not in compiled form; all compilation occurs at run time.

SystemDefs.json

This file defines the systems available in the "new project" screen. The following fields are mandatory:

  • Name - Short name that identifies the system.
  • GroupName - Short string used to group common items together in the UI.
  • CPU - Type of CPU used. The string must be part of the known set (see CpuDef.cs)
  • Speed - Clock rate, in MHz, of the CPU on the system. When multiple speeds are possible, use the most common, favoring NTSC over PAL.
  • SymbolFiles - List of platform symbol file identifiers (see below).
  • ExtensionScripts - List of extension script file identifiers (see below).
  • Parameters - List of optional parameters (see below).

The currently-supported parameters are:

  • load-address=<addr> - Specify the initial load address. The default is 0x1000.
  • entry-flags=<flag-set> - Specify the processor status flag values to use at entry points. This is intended for use on the 65802/65816, and may be one of "emulation", "native-short", and "native-long". The default is "emulation".
  • undocumented-opcodes={true|false} - Enable or disable undocumented opcodes. They are disabled by default.
  • first-word-is-load-addr={true|false} - If true, the first two bytes of the file contain the load address.
  • default-text-encoding=<mode> - Specify default character encoding. Use "c64-petscii" for PETSCII. The default is low/high ASCII.

All of these things can be changed after the project has begun, but it's nice to have them configured in advance.

SymbolFiles and ExtensionScripts use file identifiers, which look like "RT:Apple/ProDOS8.sym65". The "RT:" means that the file lives in the RuntimeData directory, and the rest is a partial pathname. Files that live in the same directory as the project file are prefixed with "PROJ:". All symbol files and extension scripts must live in the RuntimeData directory or project file directory, or they will not be loaded.

All "RT:" identifier paths are relative to the RuntimeData directory. The Group Name is not automatically added.

Platform Symbol Files and Extension Scripts

These are described in the "Advanced Topics" section of the manual (here).

Misc Files

ExportTemplate.html and SGStyle.css are used by SourceGen's HTML export feature.

LegalStuff.txt is displayed in the About box.