Skip to content

Commit

Permalink
Updated README and ran lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
JetSetIlly committed Jul 25, 2021
1 parent ae6e8ac commit eac6941
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 26 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Although if want to pass flags to the run mode you'll need to specify it.

## Hand Controllers

Stick, paddle and keyboard inputs are supported. Currently, only sitck and
Stick, paddle and keyboard inputs are supported. Currently, only stick and
paddles for the left player are available but keyboard input is available for
both players.

Expand Down Expand Up @@ -250,7 +250,8 @@ In playmode, the additional keys are available:
In the debugger, the additional keys are available:

* `ESC` toggle mouse capture for debugging TV screen
* ` (backtick) start/stop emulation

The `Pause` key will toggle pausing in both playmode and in the debugger

### Screenshots

Expand Down
10 changes: 5 additions & 5 deletions debugger/debugger.go
Original file line number Diff line number Diff line change
Expand Up @@ -264,27 +264,27 @@ func NewDebugger(tv *television.Television, scr gui.GUI, term terminal.Terminal,
return dbg, nil
}

// VCS implementes the emulation.Emulation interface.
// VCS implements the emulation.Emulation interface.
func (dbg *Debugger) VCS() emulation.VCS {
return dbg.vcs
}

// Debugger implementes the emulation.Emulation interface.
// Debugger implements the emulation.Emulation interface.
func (dbg *Debugger) Debugger() emulation.Debugger {
return dbg
}

// UserInput implementes the emulation.Emulation interface.
// UserInput implements the emulation.Emulation interface.
func (dbg *Debugger) UserInput() chan userinput.Event {
return dbg.events.UserInput
}

// State implementes the emulation.Emulation interface.
// State implements the emulation.Emulation interface.
func (dbg *Debugger) State() emulation.State {
return dbg.state
}

// Pause implementes the emulation.Emulation interface.
// Pause implements the emulation.Emulation interface.
func (dbg *Debugger) Pause(set bool) {
if set {
dbg.state = emulation.Paused
Expand Down
2 changes: 1 addition & 1 deletion gui/requests.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type PlusROMFirstInstallation struct {
// Note that, like the name suggests, these are requests, they may or may not
// be satisfied depending other conditions in the GUI.
const (
// set the underlying emulation for the gui
// set the underlying emulation for the gui.
ReqSetEmulation FeatureReq = "ReqSetEmulation" // emulation.Emulation

// notify GUI of emulation state. the GUI should use this to alter how
Expand Down
2 changes: 1 addition & 1 deletion gui/sdlimgui/lazyvalues/lazy.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func NewLazyValues() *LazyValues {
}

// SetEmulationState makes sure the lazy system can respond to an emulation in
// a parituclar state.
// a particular state.
func (val *LazyValues) SetEmulationState(state emulation.State) {
switch state {
case emulation.Initialising:
Expand Down
9 changes: 4 additions & 5 deletions hardware/memory/cartridge/harmony/arm7tdmi/arm7.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ type ARM struct {

// rather than call the cycle counting functions directly, we assign the
// functions to these fields. in this way, we can use stubs when executing
// in immediate mode (when cycle counting isn't necesary)
// in immediate mode (when cycle counting isn't necessary)
//
// other aspects of cycle counting are not expensive and can remain
Icycle func()
Expand All @@ -158,11 +158,11 @@ type disasmLevel int
const (
disasmNone disasmLevel = iota

// update entry only if the UpdateExecution is true
// update entry only if the UpdateExecution is true.
disasmUpdateOnly

// update all disassembly fields (operator, operands, etc.). this doesn't
// need to happen unless the entry is not in the disasm cache
// need to happen unless the entry is not in the disasm cache.
disasmFull
)

Expand Down Expand Up @@ -674,7 +674,7 @@ func (arm *ARM) Run(mamcr uint32) (uint32, float32, error) {
arm.Scycle(prefetch, arm.registers[rPC])
}

// default to an S cycle for prefetch unless an instruction explicitely
// default to an S cycle for prefetch unless an instruction explicitly
// says otherwise
arm.prefetchCycle = S

Expand Down Expand Up @@ -2193,7 +2193,6 @@ func (arm *ARM) executeConditionalBranch(opcode uint16) {
}
case disasmNone:
}

}

func (arm *ARM) executeSoftwareInterrupt(opcode uint16) {
Expand Down
8 changes: 4 additions & 4 deletions hardware/memory/cartridge/harmony/arm7tdmi/cycles.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const (
BranchTrailFlushed
)

// the bus activity during a cycle
// the bus activity during a cycle.
type busAccess int

const (
Expand All @@ -72,7 +72,7 @@ func (bt busAccess) isDataAccess() bool {
return bt == dataRead || bt == dataWrite
}

// the type of cycle being executed
// the type of cycle being executed.
type cycleType rune

const (
Expand Down Expand Up @@ -248,14 +248,14 @@ func (arm *ARM) nCycle(bus busAccess, addr uint32) {
}
}

// called whenever PC changes unexpectedly (by a branch instruction for example)
// called whenever PC changes unexpectedly (by a branch instruction for example).
func (arm *ARM) fillPipeline() {
arm.Ncycle(branch, arm.registers[rPC])
arm.Scycle(prefetch, arm.registers[rPC]+2)
}

// the cycle profile for store register type instructions is funky enough to
// need a specialist function
// need a specialist function.
func (arm *ARM) storeRegisterCycles(addr uint32) {
arm.Ncycle(dataWrite, addr)
arm.prefetchCycle = N
Expand Down
4 changes: 2 additions & 2 deletions hardware/memory/cartridge/harmony/arm7tdmi/disasm.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type DisasmEntry struct {
CyclesSequence string
}

// Key implements the CartCoProcDisasmEntry interface
// Key implements the CartCoProcDisasmEntry interface.
func (e DisasmEntry) Key() string {
return e.Address
}
Expand Down Expand Up @@ -71,7 +71,7 @@ func (s DisasmSummary) String() string {
return fmt.Sprintf("N: %d I: %d S: %d", s.N, s.I, s.S)
}

// add cycle order information to summary
// add cycle order information to summary.
func (s *DisasmSummary) add(c cycleOrder) {
for i := 0; i < c.idx; i++ {
switch c.queue[i] {
Expand Down
2 changes: 1 addition & 1 deletion hardware/tia/video/player.go
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ func (ps *PlayerSprite) resetPosition() {
} else if ps.tia.hmove.Latch {
// HMOVE has been activated this scanline but not currently rippling.
//
// maybe surprisingly, this is comparitively unusual. many ROMs if
// maybe surprisingly, this is comparatively unusual. many ROMs if
// the reset the player during the HBLANK at all will have called
// HMOVE straight after the WSYNC, as advised by the Stella
// Programmer's Guide.
Expand Down
10 changes: 5 additions & 5 deletions playmode/play.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,27 +53,27 @@ type playmode struct {
rawEvents chan func()
}

// VCS implementes the emulation.Emulation interface.
// VCS implements the emulation.Emulation interface.
func (pl *playmode) VCS() emulation.VCS {
return pl.vcs
}

// Debugger implementes the emulation.Emulation interface.
// Debugger implements the emulation.Emulation interface.
func (pl *playmode) Debugger() emulation.Debugger {
return nil
}

// UserInput implementes the emulation.Emulation interface.
// UserInput implements the emulation.Emulation interface.
func (pl *playmode) UserInput() chan userinput.Event {
return pl.userinput
}

// State implementes the emulation.Emulation interface.
// State implements the emulation.Emulation interface.
func (pl *playmode) State() emulation.State {
return pl.state
}

// Pause implementes the emulation.Emulation interface.
// Pause implements the emulation.Emulation interface.
func (pl *playmode) Pause(set bool) {
if set {
pl.state = emulation.Paused
Expand Down

0 comments on commit eac6941

Please sign in to comment.