Gens KMod Help · log/watcher name ok when loading from history rom (fix) spy bad read (68K Byte, 68K Word) spy bad write (68K Byte, 68K Word) Version 0.1 scroll tiles by line pal

Introduction

WhatisGens?GensisaverygoodSegaGenesis/Megadrive,SegaCD/MegaCD,32XemulatorbyStef.Stefmadeitopensourcesomeyearsago.

WhatisKMod?AmodoftheoriginalGenssourcecodetoadddevelopment/debugging/hackingfeatures.ItisareplacementtoveryusefulbutbuggyGenecystfeatures.

WhatisNOTKMod?KModisNOTanewemulator,IusedGensengine.Tobehonestit'sevenworstthanoriginalGensbecauseitslowsdownit.

WhoisbehindKMod?MynicknameisKaneda,sometimesKanedaFr.I'mmakingsomedevelopmentonSegaMegadrive/Genesissince'98.Someofmyknowndemos/gamesareOogaBoogaandOldSkill.Ialsomadealotoftechdemosandtools.

Copyright©2007Kaneda

ThishelpfilehasbeengeneratedbythefreewareversionofHelpNDoc

http://www.ibe-software.com/products/software/helpndoc/

History

Version0.7bBetterwatcherswithstructureshandlingVersion0.7bBetterwatchers

Version0.7FIX:createfileanddirectoriesatROMplacewhen'openedfrom..'(Pascal/TmEE)FIX:badredrawwhenshadow/highlightandlayerhide(GrayLight)FIX:wrongredrawofS68KPRamadressesinRAMmode(Fonzie)FIX:screenshot32XnotworkingFIX:pause32Xunperfect(sinceKMod0.3!)changeddebugfontforW98userbetterPSGdebugwindowbyEdgeDACfrequencyinfoMSH2ROM/RAM/cacheviewerandlinkeddisassembly(thxFonzie)SSH2ROM/RAM/cacheviewerandlinkeddisassembly(thxFonzie)32xregisters32xVDP(s)CPUsdebugwindowsareonthesametemplateSpyCDBioscallAutologmessagetofile,sonomorelimitedtomemoryaddtfidump(Shiru)5thpalfordebug(GrayLight)

Version0.6FIX:badredrawwhenshadow/highlightandlayerhideFIX:correctDACvalueFIX:screenshottakesthemessagetooShow/Hide32XlayerZ80memoryviewerandlinkeddisassembly(nomore'current'PC)M68KROM/RAMviewerandlinkeddisassembly(nomore'current'PC)S68KPRAM/WRAMviewerandlinkeddisassembly(nomore'current'PC)debug.s/.hupdaded(warning!funcnameupdatedtoo...sorryforthat,butit'snowmore'pro')DumpCDWordRAMtoBMP

ChangescrollbuttonwithtruescrollbaronCDGFXChangescrollbuttonwithscrollbaronVDP(andremoveup/downbitmapresource)

Version0.5FIX:bad68kmemorydump(swap)FIX:badMCDreglistFIX:renames68kbuttonsSpyunpausedZ80accessRegister29:morecontrolsthanonlyPauseDebug.supdatedGMVrecord/playGMVToolstocompressGMVforuseindemosreplayPauseonmenuRenderframeperframeAutoscreenshot

Version0.4FIX:memoryfaultonspritedump(thxRedAngel)FIX:badtileselectionFIX:notilesrefreshwhilepaused(thxtomman)Spy/MessageonseparatewindowdebugCD68kdebugCDCDCdebugCDRegdebugCDGFXdebugVDPRegistersmorereadablespyDMAtohackgfxspyDMAlimiterror(thxCMD)dumpM68Krom(interestingwhenCDor32Xgame)dumpS68Krom(interestingwhenCDor32Xgame)Register31:TimerRegister30:MessageRegister29:PauseGensspecialregisterscallsinzipfileavailableinDebug...

Version0.3FIX:onpausemode,ifdebugwindowcalled,noredraw(blackscreen)FIX:YM2612nowupdatedwhilegamepaused

FIX:palredarrownowcenteredFIX:correctYM2612TimerBvalueVDPredrawoptimized(thxFonzie)Spriteredrawoptimized'bluepause'optionnel(Fonziereq)dumpVDPtilestobmpdumpspritetobmpdumpym2612instr(y12orff)suppkeytodeleteawatcher(Varciesreq)inskeytodeleteawatcheractive/desactiveanypal(colororblack)spritezoomtilezoom

Version0.2Debugconfigwindowspecialconfigfile(gens_kmod.cfg)autoloadwatchers(thxFonzie!)spylog(<gamename>.log)spystrangeregisterdata(knownasCharlesMDpatch)spyfullspritelimitlog/watchernameokwhenloadingfromhistoryrom(fix)spybadread(68KByte,68KWord)spybadwrite(68KByte,68KWord)

Version0.1scrolltilesbylinepalindicator(redarrow)selectcurrentpalinVDPdebugbyclickshow/hidelayers(knownasGenecystpatch)save/loadwatcher(<gamename>.wch)createwatchersdirctoryoninit

Version0.0-privatereleasereplaceDebug==XbyDebug==DMODE_XXXXXforeasierreadingcalldebug=screenminimize(iffullscreen)changeCPU->DebugandOptionsmenudebugM68Kdebugz80

debugVDP(pal/tile)debugVDPRegistersdebugspritesdebugym2612debugPSGwatchers




Changes

WhenIstartedGensKMod,mymaingoalwastohaveaseparatewindowforeachofthedebugscreenwhilethegameisplaying.Sincethecodewasverywelldocumented,Iwasabletoaddseveralnonexistingfeatures.Checkthemall.

PleasenotethatthewayGenswaswrittendoesn'tallowmetoaddbreakpointsandtracefeatureswithouthugerewrite,sodon'texpectthesefeatures.

DebugMegadrive/GenesisGame

-Genesis68Kstatus-Z80status-VDP-VDPRegisters-VDPSprites-YM2612status-PSGstatus

DebugMegaCD/SegaCDGame

-CD68Kstatus-CDRegisters-CDControler-CDWordRAM

Debug32XGame

-MasterSH2status-SlaveSH2status-32Xregisters-32XVDP

Developmentfeatures-Newregister31:Timer

-Newregister30:Message-Newregister29:TakeGenscontrol-Watchers-Spy

Miscchanges-Configuration-Messagewindow-Layers-ExtendedFeatures-GMV




Genesis




Genesis68K

ThecurrentGenesis68Kstatusisnowonaseparatewindow.Youcannowviewanydisasmcodeatanyaddressandnotcurrentcode,whichwasunuseful.Useitonlyforitsmemoryfeatures.

DumpROMDumpthefullROMinbinaryformat.ThisfeatureisinterestingwhilerunningaMegaCD/SegaCDor32Xgames,elseitworkslikeaSMDtoBINconvertor

ViewROM/ViewDisasmSwitchbetweenhexaviewanddisasmview(seepicturebelow)oftheROM.

ViewRAMViewRAMdump.

DumpRAMDumpthefullRAMinbinaryformat.UsefulltosavemultipleRAMstatesandcomparethemorcheckmemorystatus

PC=xxxxxInDisasmview,jumptocurrentPC




Z80

ThecurrentZ80statusisnowonaseparatewindow.Useitmainlyforitsmemoryfeatures.

ViewMemory/DisasmSwitchbetweenhexaviewanddisasmview(seepicturebelow)oftheZ80memory.

DumpMemoryDumptheZ80memoryinbinaryformat.UsefulltocheckZ80sounddriver





VDP

Oneofthemostimportantparttocheckifyourloadingisdoneorgethelptohack

Thepictureatthetopisthe4palettesoftheGenesis+1forus,tospytilesevenwhennopaletteisloaded.YoucanchoosebyclickthecurrentonefortheVDPdebugWiththecheckboxes,youcanalsoactive/desactivethepalyoudon'twant,soyoucanseeonscreenwhatpalanytile/spriteuse.

ThepictureattheleftisthecurrentVRAM,drawnwiththecurrentselectpal.YoucanscrollittoseeallthetilesyouwantYoucanselectaspecifictilebyclicktoseeitindetails.Warning,forrefreshspeedneed,allthetilesaren'trefreshedeveryframe.

Thepictureattherightisthezoomedselectedtile(0bydefault)

DumpVRAMDumpthefullVideoRAMinbinaryformat

DumpCRAMDumpthefullColorsRAMinbinaryformat

TilestoBitmapSavethefullVideoRAMinaBitmapfileYes,youcaneasilyrip8x8tiles




VDPRegisters

CheckthestatusoftheVDPregisters.Nothingmore,youshouldknowwhattheGenesis'registersare.

PleasenoteIdidn'taddCharlesmoreaccurateregistersinformation,butIhopetodoit...someday




VDPSprites

Checkthespriteslist.

Num:spritenumberYPos/XPos:positioninpixelsSize:sizeinpixels(32x32max)Link:nextsprite(seeSega2.docformoredetails)Pal:palusedTile:firsttileusedFlags:Prioity/VerticalFlip/HorizontalFlip

Selectbyclickthespriteyouwanttosee

Thepictureattheleftisthespriteinoriginalsize.Thepictureattherightisthezoomedsprite.

Dump

DumptheselectedspriteinaBitmapfileYes,youcaneasilyripsprites




YM2612

Themostdetailledwindow.

LetyoucheckeachchanneloftheYM2612soundchipSeeSega2.docformoredetails.

DumpChannelDumpthechannelinfoinFF(Uchuusen'sformat),TFI(TFM'uckerinstrument)orY12(Kaneda'sformat)




PSG

CheckthevalueandvolumeofeachPSGchannel

ThankstoEdgewhorewritethiswindow




SegaCD




Sub68k

ThecurrentCD68Kstatusisnowonaseparatewindow.Youcannowviewanydisasmcodeatanyaddressandnotcurrentcode,whichwasunuseful.Useitonlyforitsmemoryfeatures.

DumpPrgmRAMDumpthefullProgramRAMinbinaryformat.

ViewPrgmRAM/ViewDisasmSwitchbetweenhexaviewanddisasmviewoftheProgramRAM.

ViewWordRAMViewWordRAM(mode2)dump.

DumpWordRAMDumpthefullWordRAM(mode2)inbinaryformat.UsefulltosavemultipleRAMstatesandcomparethemorcheckmemorystatus





CDRegisters

CheckthestatusoftheCDregisters.Nothingmore,youshouldknowwhattheCDregistersare.

I'mcurrentlynoteaCDpromyselfsoperhapsthereareerrorsonthisscreen.




CDControler

CheckthestatusoftheCDC.Nothingmore,youshouldknowwhattheCDcontroleris.

I'mcurrentlynoteaCDpromyselfsoperhapsthereareerrorsonthisscreen.




CDWordRAM

SeethetilesintheWordRAM.UsethepaletteselectoroftheGenesisVDPtochangecolor.

Word-RAMtoBitmapSavetheWordRAMasbitmap,usingthecurrentselectedpalette.

DumpWord-RAMSeeCD68k




32X




MSH2

ThecurrentMasterSH2status.


DumpROMDumpthefullROMinbinaryformat.

ViewRAM/ViewDisasmSwitchbetweenhexaviewanddisasmview(seepicturebelow)oftheRAM.

DumpRAMDumpthefullRAMinbinaryformat.

ViewCacheViewthecache

DumpCacheDumpthefullcacheinbinaryformat.

PC=xxxxx

JumptocurrentPC(switchtoRAMorROMifneeded)




SSH2

ThecurrentSlaveSH2status.(samewindowasMasterSH2)


DumpROMDumpthefullROMinbinaryformat.

ViewRAM/ViewDisasmSwitchbetweenhexaviewanddisasmview(seepicturebelow)oftheRAM.

DumpRAMDumpthefullRAMinbinaryformat.

ViewCacheViewthecache

DumpCacheDumpthefullcacheinbinaryformat.

PC=xxxxx

JumptocurrentPC(switchtoRAMorROMifneeded)




32Xregisters

CheckthestatusoftheVDPregisters.You'reabletoseeGenesisand32Xsideregisters




32XVDP

Thecomplex32XVDPwindow

RawdataarawwriteoftheselectedFramebuffer(withoutlinetable)

AccordingLinetabletheselectedFramebufferdrawnlikethelinetabledefineit

ColorPalettefor256colorsgames,thecolorsused.thestrokeshelpyoutosee'priority'

WhichFB?SelecttheFByouwanttospy

DumpCRAMdumptherawdataofcolorram(256colorsmode)

DumpFBdumprawdataofthefullframebuffers




Dev:Register31

Register31:Timer!WARNING:thisregisterdoesn'tworkduringVInt!Asanyaddedregister,theoriginalMegadrive/Genesisshouldskipthem(aswrittenintheDevKitdocumentation)

Timerregisterstart/resetandoutputatimer(basedonm68kcycles)

Valueissr000000wheres=0CounteroutputonMessagewindows=1Counterstartr=0<undefined>r=1resetcounter

Imadeitforoptimizingissue:youcanknowhowcyclesacalltakeandoptimizeit.




Dev:Register30

RegisterMessage30Asanyaddedregister,theoriginalMegadrive/Genesisshouldskipthem(aswrittenintheDevKitdocumentation)

MessageregisteroutputanytextontheMessagewindow

Valueisaprintablecharor0foroutputUsealooptoinputafullstringbutbeawareMessageregisterwillautomaticallyouputa255charsstringandstartanewone




Dev:Register29

RegisterGenscontrol29Asanyaddedregister,theoriginalMegadrive/Genesisshouldskipthem(aswrittenintheDevKitdocumentation)

GenscontrolregistertakecontrolofGensthroughtyourrom

Valueisoneofthesecontrolcodes0x00pause0x01showdebug68kwindow0x02showdebugz80window0x03showdebugVDPwindow0x04showdebugsub68kwindow0x05showdebugCDCwindow0x06showdebugCDGfxwindow0x07showdebug32Xmainwindow0x08showdebug32Xsubwindow0x09showdebug32XVDPwindow0x0AshowdebugVDPregisterwindow0x0BshowdebugSpritewindow0x0CshowdebugYM2612window0x0DshowdebugPSGwindow0x0Eshowwatcherswindow0x0FshowLayerswindow0x10showmessagewindow0x11showdebugCDregisterwindow0x50dump68kram0x51dumpZ80ram0x52dumpS68kram0x60takescreenshot0x62startrecordgmv0x63stoprecordgmv0x64startgmv0x65stopgmv

0x00/Pauseisthemoreusefulone:pauseyourgameatanimportantpointandcheckwhatyouwant




Dev:Watchers

Spyanyvalueofthememoryspace.

It'sagreatfeaturefordeveloppersbecause,withthehelpofnm2wchtool,youcangeneratewatcherslistfromsourcefile!Forhackers,itletsyouspymemoryspaceforpoints,life,score...

Ialsoaddedstructuressupport.Forthatyouneedtoadda.strfilewith1ormorestructuredefinition.Inthescreenshot,str_Levelisdefinedlikethis:STRUCTstr_LevelCHARidxCHAR_pad_SHORTwidthSHORTheightCHARpalCHAR_pad_LONGdataEND

http://gendev.spritesmind.net/?page=nm2wch

so,anystructuremuststartby'STRUCT'keywordfollowedmystructname(20charmax)thenyouaddanyelementyouwantusing'CHAR','SHORT'or'LONG'keywordsfollowedbyelementname(20charmax)it'sagoodusetoaddthe'END'keywordbutit'soptionnal.Anyotherkeywordsorstrings(like//orotherscommentskeywords)areignored.

On"Watchers"listview,rowinitalicaresubelementofawatcher,youcan'tchangeitstypeandifyoudeleteit,youdeletethewatcher(andallitssubelements).

Asidenoteonthe'CHAR'type,likeyoucanseeonthesample,Iaddedto_pad_elementbecauseM68Kcan'treadwordofoddaddress.It'sinteresting:this10bytesstructureusesinfact12bytesinmemory!

Address(hex)InputtheaddresstowatchinhexadecimalOnrightclick,apopupmenuallowsyoutojumptomemoryviewatthisplace(RAMonly).Changeitsvalueondoubleclick.

NameNameofthewatcher(iffromanm2wchconvertion).Youcan'tchangeityourself(sorry,needtofindhowfirst,WinAPIdoesn'thandlethisbydefault)

ValueValueofthewatcher,inselectformat.Onrightclick,apopupmenuletyouchoosetheformatofoutput.Forcompleximportedwatchers,youcanchooseoneofyourdefinedstructure.

TypeTellyouwhatyou'relookingfor(upto0x00400000ROM

upto0x00800000Sega1upto0x00A00000Sega2upto0x00A10000Z80upto0x00A11000IOupto0x00A12000Controlupto0x00B00000Sega3upto0x00C00000Sega4upto0x00E00000VDPfrom0x00FF0000RAMIt'sdangerous,butpossible,towatchbetween0x00E00000and0x00FF000,soyou'llsee!!WARNING!!

InsertwatcherAtanewwatcherat0x00000000Edittheaddressyouwanttowatch

DeletewatcherDeletecurrenthighlightedwatcher

SavewatchersSaveallthewatchers(seeAutoloadwatcheroption)StructureinformationARENOTsavedtoavoidstrangebehaviorifyoudelete,addorchangeorderofstructuresdefinitioninthe.strfile.

LoadwatchersLoadanewsetofwatchers(thecurrentonesaredeleted)




Dev:Spy

Enableornotthroughttheconfiguration,thespiesletyouknowifyoumadecodeerrororifagameisfullofbugsIaddedaspecialonewhichwillhelpyoutohackgametoo

Badregister'svalue:SpyifabadvalueisgiventoaVDPregister.Checkerrorsorunknownregistervalue

Spritelimit:Spyifthe80spritesperscreenlimitisreached.Checkerrorsorspritesavailableonlyonemulator.

Read/Writeforbidden:Spybadmemoryaccess.Checkerrorsandbugs

DMAaccess:SpyANYDMA.Usefulltofindwherearestoredtiles,colorsorscrollvalue




Misc:Configuration

YoucanopenthisKMod'sconfigurationthroughtOptions>Debug...

Autoloadwatchers&strucutresLoadwatcherswithsamenameasgamewhenloadinggame.GensKModfirstlooksforawacher(.wch)incurrentgamefolder.Ifnotfound,itthenlooksinGensKMod's'watchers'folder.Samethingforstructures(.str)

SpystrangebehaviorsEnablecodespies,theresultiswroteontheMessagebox

SpyCDBioscallDumpallCDBioscallontheMessagebox(youcandesactivatetheoftencalledfunctions)

BlueScreenpausePauseinblue?JustdisablethisGensfeature:Ididn'twanttoremoveitsoImadeitoptionnal.It'snowmoreeasytocaptureapausedscreen

ActiveDevelopmentFeaturesActiveornotGensonlycodelikespecialsregistersandGenscontrolbytherom

itself

GetDebug.zipDownloadthelastversionoftheGens-onlydebuggingcodeforyourdemosandgames




Misc:Message

IfSpyand/orDevspecialfeaturesareactivated,readtheresultshereorinthelogfile(deleteittimetotime)

ClearOnlyamaximumnumberoflinesiswrotesocleartimestotimes

OpenOpenthelogfilewithnotepad

BrowseSelectthepathandfilenameofthelogfile




Misc:Layers

Selectwhichfield(s)youwanttobedrawn.Interestingforscreenshotwithoutspritesforexample.

ImissedthisGenecyst'sfeaturesomuch!!!




Misc:ExtendedFeatures

Pauseonmenu:CPU>PauseAverylittlemod,forpeoplewhodon'tknowhowtopauseGensor/anddon'treadthemanualPauseupdate:CPU>FrameStepUsingShift-Escormenu,youcanupdateframeperframe,toseeallthedetailsdrawneachframe.

Screenshotupdate:Graphic>ScreenshoteachframeIfyouwanttocaptureeachframe.EasierthanCPU>FramestepthenGraphic>ScreenshotthenCPU>Framestep....Usedtorecordanimation.




Misc:GMV

GensMoVieAGMVisnotavideofile,it'sarecordofalltheinputswhileplaying.Youcanrecorditthenreplayit

SeeNesVideosformoredetails

GMV>GMVPlayLoadthecurrentstatethenstarttoplaytheGMVfile(samenamethanromloaded)

GMV>GMVRecordSavethecurrentstatethenstarttorecordtheGMVfile(samenamethanromloaded)

GMV>GMVStopStoptheGMVcurrentlyplayedorrecorded

GMV>GMVTools...OpentheGMVtoolswindow



http://bisqwit.iki.fi/nesvideos/GMV.html


GMVTools

TheGMVtoolsisawaytoconvertaGMVfiletowhatyouneedforyourgames(intoaGMCfile).Usingtheresultfile,youcanaddreplayorattractivedemotoyourgames.

Ifagameisloaded,theinputandoutputfilesareautomaticalydefined,elseusetheBrowsebuttons

CompressSelectifyouwanttheGMCfiletobecompressed(forsizeissue)

Player1Includeplayer1input?

Player2Includeplayer2input?

6ButtonsIncludeplayers6buttons?

ConvertConverttheGMVfiletoacompressedornotGMCfilewiththedataselected

CloseQuitGMVtools

-----------------------------------

-GMCFileDescription------------------------------------ucharFormat//whatisontheGMCFile,addtheneededvalues//0x01->player1input//0x02->player2input//0x04->boutons6added//0x80->compresseducharreserved[0x0E]//futuruseuchardata

ifcompressedthefirstcharisthenumberofframesoftheinputthesecondcharisthefirstinput(ifneeded)thethirdcharisthesecondinput(ifneeded)the4thcharisthethirdinput(ifneeded)elsethefirstcharisthefirstinput(ifneeded)thesecondcharisthesecondinput(ifneeded)thethirscharisthethirdinput(ifneeded)




Links

HerearethelinksyoushouldchecktimestotimesComeonKModhomepagetojumptotheforumandgivesyoufeedback/reportbugs




Documents

Gens KMod Help · log/watcher name ok when loading from history rom (fix) spy bad read (68K Byte, 68K Word) spy bad write (68K Byte, 68K Word) Version 0.1 scroll tiles by line pal