Skip to content

Latest commit

 

History

History

cfg

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 

README.md

rugby-cfg

This library contains (de)serializable configuration schema usable by various rugby frontends. This is intended to allow for configuration files to be shared between frontends enabling consistent behaviour throughout.

Hierarchy

Configurable fields are arranged hierarchically as such:

.
├── app: object
│  ├── log: string
│  ├── pal: enum
│  └── spd: enum
└── emu: object
   ├── boot: object
   │  ├── rom:  path
   │  └── skip: bool
   └── cart: object
      ├── rom:   path
      ├── check: bool
      ├── force: bool
      └── save:  enum

Options

Fields

The following is a table of supported configurable fields:

Field Description Flag Type Clap Serde Notes
app.log Logging filter. -l/--log string ✓ ✓ 1
app.pal 2-bit color palette. -p/--palette enum ✓ ✓ 2
app.spd Simulated clock speed. -s/--speed enum ✓ ✓
emu.boot.rom Boot ROM image file. -b/--boot path ✓ ✓
emu.boot.skip Skip running boot ROM. --no-boot bool ✓
emu.cart.rom Cartridge ROM image file. path ✓
emu.cart.check Check cartridge integrity. -c/--check bool ✓ ✓
emu.cart.force Force cartridge construction. -f/--force bool ✓ ✓
emu.cart.save Cartridge RAM persistence. -S/--save enum ✓ ✓ 3

Types

All the expected primitive types for options are supported:

  • bool: boolean value, specified as true or false.
  • float: floating-point number, can be in scientific notation.
  • [u]int: integer number, may be unsigned.
  • string: string of characters encoded in UTF-8.

Additionally, there are more advanced types:

  • enum: enumerated choice from a predefined set of values.
  • path: filesystem path to a file or directory.

These may be combined into an object, which is simply a collection of fields.

Enums

All enumerated types are described below:

  • palette: color palette selection, see variants; can be customized as an array of 4 colors (parsed in hex).
  • speed: simulated clock frequency, see variants; can be specified either as a frame rate (fps) or frequency (hz).
  • when: choice of when to enable an option, variants are: never, auto, and always.

License

For information regarding licensure, please see the project's README.

Footnotes

  1. Must be a valid log filter as parsed by the frontend. See filter directives using tracing as an example. ↩

  2. Only applicable on the DMG model. On CGB, the palette will be ignored. ↩

  3. Specifies when the cartridge RAM should be loaded/saved to disk. ↩