本文适合有C语言基础的朋友
这里是HelloGitHub推出的《讲解开源项目》系列,本期为您讲解的是80、90后的儿时记忆,诞生于1978年经典街机游戏《太空侵略者》也叫“小蜜蜂”的C语言复刻版——si78c。
这款游戏在当时可谓是风靡一时,相信很多朋友小时候都玩过。现在长大了,不知道有多少朋友对它的源码感兴趣呢!
原版的《太空侵略者》由大约2k行的8080汇编代码写成,但汇编语言太过底层不方便阅读,今天讲解的开源项目si78c是按照原版汇编代码用C语言重写了一遍,并最大程度还原了原版街机硬件的中断、协程逻辑,在运行时其内存状态也几乎与原始版本相同几乎达到了完美的复刻,着实让我眼前一亮!
下面就请跟着HelloGitHub一起抽丝剥茧,运行这个开源项目、阅读源码,穿越历史感受40年前游戏设计的精妙之处!
一、快速开始本文的实验环境为Ubuntu20.04LTS,GCC版本大于GCC3
1.准备工作首先si78c使用SDL2绘制游戏窗口,所以需要安装依赖:
$sudoapt-getinstalllibsdl2-dev然后从仓库下载源码:
$gitclonehttps://github.com/loadzero/si78c.git此外,该项目会从原版的ROM中提取原版游戏的图片、字体,所以还需要下载原版的ROM文件
2.文件结构在si78c源码文件夹中新建名为inv1和bin的文件夹
$cdsi78c-master$mkdirinv1bin然后将invaders.zip中的内容解压到inv1中,最后目录结构如下:
si78c-master├──bin├──inv1│├──invaders.e│├──invaders.f│├──invaders.g│└──invaders.h├──Makefile├──README.md├──si78c.c└──si78c_proto.h3.编译与运行使用make进行编译:
$make之后会在bin文件夹中生成可执行文件,运行即可启动游戏:
$./bin/si78c游戏操控按键如下:
aLEFT(左移)dRIGHT(右移)11P(单人)22P(双人)jFIRE(射击)5COIN(投币)tTILT(结束游戏)二、前置知识2.1简介《太空侵略者》原版代码运行在8080处理器之上,其内容全部由汇编代码写成并涉及一些硬件操作,为了模拟原版街机代码逻辑以及效果,si78c尽最大可能将汇编代码转换为C语言并使用一个Mem的结构体模拟了原版街机的硬件,所以有些代码从纯软件的角度来讲是比较奇怪甚至是匪夷所思的,但限于篇幅原因作者无法将代码全部贴进文章进行解释,所以请读者配合本人详细注释代码阅读此文。
2.2什么是协程si78c使用了ucontex库的协程模拟原版街机的进程调度和中断操作。
协程:协程更加轻便快捷、节省资源,协程对于线程就相当于线程对于进程。
其中ucontext提供了getcontext()、makecontext()、swapcontext()以及setcontext()函数实现协程的创建和切换,si78c中的初始化函数为init_thread。下面我们直接来看源码中的例子:
如果这里不够直观可以看后面状态转移图,图文结合更加直观。
代码2-1
//切换协程时用的中间变量staticucontext_tfrontend_ctx;//游戏主要逻辑协程staticucontext_tmain_ctx;//游戏中断逻辑协程staticucontext_tint_ctx;//用于切换两个协程staticucontext_t*prev_ctx;staticucontext_t*curr_ctx;//初始化游戏协程staticvoidinit_threads(YieldReasonentry_point){//获取当前上下文,存储在main_ctx中intrc=getcontext(&main_ctx);assert(rc==0);//指定栈空间main_ctx.uc_stack.ss_sp=main_ctx_stack;//指定栈空间大小main_ctx.uc_stack.ss_size=STACK_SIZE;//设置后继上下文main_ctx.uc_link=&frontend_ctx;//修改main_ctx上下文指向run_main_ctx函数makecontext(&main_ctx,(void(*)())run_main_ctx,1,entry_point);/**以上内容相当于新建了一个叫main_cxt的协程,运行run_main_ctx函数,frontend_ctx为后继上下文*(run_main_ctx运行完毕之后会接着运行frontend_ctx记录的上下文)*协程对于线程,就相当于线程对于进程*只是协程切换开销更小,用起来更加轻便*///获取当前上下文存储在init_ctx中rc=getcontext(&int_ctx);//指定栈空间int_ctx.uc_stack.ss_sp=&int_ctx_stack;//指定栈空间大小int_ctx.uc_stack.ss_size=STACK_SIZE;//设置后继上下文int_ctx.uc_link=&frontend_ctx;//修改上下文指向run_init_ctx函数makecontext(&int_ctx,run_int_ctx,0);/**以上内容相当于新建了一个叫int_ctx的协程,运行run_int_ctx函数,frontend_ctx为后继上下文*(run_int_ctx运行完毕之后会接着运行frontend_ctx记录的上下文)*协程对于线程,就相当于线程对于进程*只是协程切换开销更小,用起来更加轻便*///给pre_ctx初始值,在第一次调用timeslice()时候能切换到main_ctx运行prev_ctx=&main_ctx;//给curr_ctx初始值,这时候frontend_ctx还是空的//frontend_ctx会在上下文切换的时候用于保存上一个协程的状态curr_ctx=&frontend_ctx;}之后每次调用yield()都会使用swapcontext()进行两个协程间切换:
代码2-2
staticvoidyield(YieldReasonreason){//调度原因yield_reason=reason;//调度到另一个协程上switch_to(&frontend_ctx);}//协程切换函数staticvoidswitch_to(ucontext_t*to){//给co_switch包装了一层,简化了代码量co_switch(curr_ctx,to);}//协程切换函数staticvoidco_switch(ucontext_t*prev,ucontext_t*next){prev_ctx=prev;curr_ctx=next;//切换到next指向的上下文,将当前上下文保存在prev中swapcontext(prev,next);}具体用法请见后文
由于文章篇幅有限,下面只展示的关键源码部分。更详细的源码逐行中文注释:
地址:https://github.com/AnthonySun256/easy_games
2.3模拟硬件前文讲过,si78c是原版街机游戏像素级的复刻,甚至大部分的内存数据也是相等的,为了做到这一点si78c模拟了街机的一部分硬件:RAM、ROM和显存,它们在代码中被封装成了一个名为Mem的大结构体,内存分配如下:
0000-1FFF8KROM2000-23FF1KRAM2400-3FFF7KVideoRAM4000-RAMmirror可以看出当年机器的RAM只有可怜的1kb大小,每一个比特都弥足珍贵需要程序认真规划。这里有张RAM分配情况表,更多详情
2.4从模拟显存到屏幕在详细解释游戏动画显示原理以前,我们需要先了解一下游戏的素材是怎么存储的:
图2-1
图片来自于街机汇编代码解读
在街机原版ROM中,游戏素材直接以二进制格式保存在内存中,其中每一位二进制表示当前位置像素是黑还是白
比如图2-1中显示0x1BA0位置的内存数据为000304781413081A3D68FCFC683D1A00八位一行排列和出来就是一个外星人带着一个颠倒字母“Y”的图片(图中的内容看起来像是旋转了90度这是因为图片是一列一列存储的,每8bit代表一列像素)。
si78c的作者在显示图片的时候直接将XY轴进行了交换以达到旋转图片的效果。
我们可以找到名为Mem的结构体,其中的m.vram(0x2400到0x3FFF)模拟了街机的显存,这里面每一个bit代表一个像素的黑(0)白(1),从左下角向右上角进行渲染,其对应关系如图2-2:
图2-2
游戏中所有跟动画绘制有关的代码都是在修改这部分区域的数据,例如DrawChar()、ClearPlayField()、DrawSimpSprite()等等。那么怎么让模拟现存的内容显示到玩家的屏幕上呢?注意看代码3-1中在循环的末尾调用了render()函数,它负责的就挨个读取模拟显存中的内容并在窗口上有像素块的地方渲染一个像素块。
仔细想想不难发现,这种先修改模拟显存再统一绘制的***其实没有多省事,甚至有些怪异。这是因为si78c模拟了街机硬件的显示过程:修改相应的显存然后硬件会自动将显存中的内容显示到屏幕上。
2.5按键检测代码3-1中的input()函数负责检测并存储用户的按键信息,其底层依赖SDL库。
三、首次启动si78c和所有的C程序一样,都是从main()函数开始运行:
代码3-1
intmain(intargc,char**argv){//初始化SDL和游戏窗口init_renderer();//初始化游戏init_game();intcredit=0;size_tframe=-1;//开始游戏协程调度与模拟触发中断while(1){frame++;//处理按键输入input();//如果退出标志置位推出循环清理游戏内存if(exited)break;//preservestimingcompatibilitywithMAME//保留与MAME(一种街机)的时序兼容性if(frame==1)credit--;/***执行其他进程大概CRED1的时间*(为什么是这个数我也不知道,应该是估计值)*(原作者也说这种定时***不是很准确但不影响游戏效果)*/credit+=CRED1;loop_core(&credit);//设置场中间中断标志位,在下面的loop_core()中会切换到int_ctx执行一次,然后清除标志位irq(0xcf);//道理同上credit+=CRED2;loop_core(&credit);//设置垂直消隐中断标志位,下个循环时候loop_core()中会切换到int_ctx执行一次,然后清除标志位irq(0xd7);//绘制游戏界面render();}fini_game();fini_renderer();return0;}启动过程如图所示:
图3-1
游戏原版代码(8080汇编)使用的是中断驱动(这种编程方式和硬件有关,具体内容可以自行了解什么是中断)配合协程多任务操作。为了模拟原版游戏逻辑作者以main()中大循环作为硬件行为模拟中心(实现中断管理、协程切换、屏幕渲染)。游戏大约三分之一的时间在运行主线程,主线程会被midscreen和vblank两个中断抢占,代码3-1中两个irq()就实现了对中断的模拟(设置对应的变量作为标志位)。
在第一次进入loop_core()时其流程如下:
图3-2
因为yield_rason这个变量是static类型其默认值为零
代码3-2
//根据游戏状态标志切换到相应的上下文staticintexecute(intallowed){int64_tstart=ticks;ucontext_t*next=NULL;switch(yield_reason){//刚启动时yield_reason是0表示YIELD_INITcaseYIELD_INIT://当需要延迟的时候会调用timeslice()将yield_reason切换为YIELD_TIMESLICE//模拟时间片轮转,这个时候会切换回上一个运行的任务(统共就俩协程),实现时间片轮转caseYIELD_TIMESLICE:next=prev_ctx;break;caseYIELD_INTFIN://处理完中断后让int_ctx休眠,重新运行main_ctxnext=&main_ctx;break;//玩家死亡、等待开始、外星人入侵状态caseYIELD_PLAYER_DEATH:caseYIELD_WAIT_FOR_START:caseYIELD_INVADED:init_threads(yield_reason);enable_interrupts();next=&main_ctx;break;//退出游戏caseYIELD_TILT:init_threads(yield_reason);next=&main_ctx;break;default:assert(FALSE);}yield_reason=YIELD_UNKNOWN;//如果有中断产生if(allowed&&interrupted()){next=&int_ctx;}switch_to(next);returnticks-start;}需要注意的是,在execute()中进行了协程的切换,这个时候execute()的运行状态就被保存在了变量frontend_ctx之中,指针prev_ctx更新为指向frontend_ctx,指针curr_ctx更新为指向main_ctx,其过程如图所示:
图3-3
实现解释请见代码2-2
当execute()返回时他会按照正常的执行流程返回到loop_core(),就像它从未被暂停过一样。
仔细观察main_init中主循环我们可以发现其多次调用timeslice()函数(例如OneSecDelay()中),通过这个函数我们就可以实现main_ctx与frontend_ctx间的时间片轮转操作,其过程如下:
图3-4
在main_init()中主要做了如下事情:
在玩家投币前,游戏会依靠main_init()循环播放动画吸引玩家
如果只翻看main_init()中出现的函数我们会发现代码中并未涉及太多的游戏逻辑,例如外星人移动、射击,玩家投币检查等内容好像根本不存在一样,更多的时候是在操纵内存、设置标志位。那么有关游戏游戏逻辑处理相关的函数又在哪里呢?这部分内容将在下面揭秘。
四、模拟中断在代码3-1中loop_core()函数被两个irq()分隔了开来。我们之前提到main()中的大循环本质上是在模拟街机的硬件行为,在真实的机器上中断是只有在触发时才会执行,但在si78c上我们只能通过在loop_core()之间调用irq()来模拟产生中断并在execute()中轮询中断状态来判断是不是进入中断处理函数,过程如下:
这时它的协程状态如下:
有两种中断:midscreen_int()与vblank_int()这两种中断会轮流出现。
代码4-1
//处理中断的函数staticvoidrun_int_ctx(){while(1){//0xcf=RST1opcode(call0x8)//0xd7=RST2opcode(call0x16)if(irq_vector==0xcf)midscreen_int();elseif(irq_vector==0xd7)vblank_int();//使能中断enable_interrupts();yield(YIELD_INTFIN);}}我们先来看midscreen_int():
代码4-2
/***在光将要击中屏幕中间(应该是模拟老式街机的现实原理)时由中断触发*主要处理游戏对象的移动、开火、碰撞等等的检测更新与绘制(具体看函数GameObj0到4)*以及确定下一个将要绘制哪个外星人,检测外星人是不是入侵成功了*/staticvoidmidscreen_int(){//更新vblank标志位m.vblankStatus=BEAM_MIDDLE;//如果没有运动的游戏对象,返回if(m.gameTasksRunning==0)return;//在欢迎界面且没有在演示模式,返回(只在游戏模式和demo模式下继续运行)if(!m.gameMode&&!(m.isrSplashTask&0x1))return;//运行gameobjects但是略过第一个入口(玩家)RunGameObjs(u16_to_ptr(PLAYER_SHOT_ADDR));//确定下一个将要绘制的外星人CursorNextAlien();}在这一部分中RunGameObjs()函数基本上包括了玩家的移动和绘制,玩家子弹和外星人子弹的移动、碰撞检测、绘制等等所有游戏逻辑的处理,CursorNextAlien()则找到要绘制的下一个活着的外星人设置标志位等待绘制,并且检测外星飞船是否碰到了屏幕底端。
运行结束后会返回到run_int_ctx()继续运行直到yield(YIELD_INTFIN)表示协程切换回execute(),并在execute()中重新将next设定为main_ctx使main_init()能够继续运行(详情见代码3-2)。
接下来是vblank_int():
代码4-3
/***当光击中屏幕最后一点(模拟老式街机原理)时触发*主要处理游戏结束、投币、游戏中各种事件处理、播放演示动画*/staticvoidvblank_int(){//更新标志位m.vblankStatus=BEAM_VBLANK;//计时器减少m.isrDelay--;//看看是不是结束游戏CheckHandleTilt();//看看是不是投币了vblank_coins();//如果游戏任务没有运行,返回if(m.gameTasksRunning==0)return;//如果在游戏中的话if(m.gameMode){TimeFleetSound();m.shotSync=m.rolShotHeader.TimerExtra;DrawAlien();RunGameObjs(u16_to_ptr(PLAYER_ADDR));TimeToSaucer();return;}//如果投币过了if(m.numCoins!=0){//xref005dif(m.waitStartLoop)return;m.waitStartLoop=1;//切换协程到等待开始循环yield(YIELD_WAIT_FOR_START);assert(FALSE);//不会再返回了}//如果以上事情都没发生,播放演示动画ISRSplTasks();}其主要作用一是检测玩家是否想要退出游戏或是进行了投币操作,如果已经处于游戏模式中则依次播放舰队声音、绘制在midscreen_int()中标记出的外星人、运行RunGameObjs()处理玩家和外星人开火与移动事件、TimeToSaucer()随机生成神秘飞碟。如果未在游戏模式中则进入ISRSplTasks()调整当前屏幕上应该播放的动画。
我们可以注意到,如果玩家进行了投币会进入if(m.numCoins!=0)里,并调用yield(YIELD_WAIT_FOR_START)后面会提示这个函数不会再返回。在si78c的代码中许多地方都会有这样的提示,这里并不是简单的调用一个不会返回的函数进行套娃。
观察代码3-2可以发现在YIELD_PLAYER_DEATH、YIELD_WAIT_FOR_START、YIELD_INVADED、YIELD_TILT这四种分支中都调用了init_threads(yield_reason),在这个函数里会重置int_ctx与main_ctx的堆栈并重新绑定调用run_main_ctx时的参数为yield_reason,这样在下一次执行的时候run_main_ctx就会根据中断的指示跳转到合适的分支去运行。
五、巧妙地节省RAM开篇的时候提到过,当年街机的RAM只有可怜的1kb大小,这样小的地方必定无法让我们存储屏幕上每个对象的信息,但是玩家的位置、外星人的位置以及它们的子弹、屏幕上的盾牌损坏情况都是会实时更新的,如何做到这一点呢?
我发现《太空侵略者》游戏区域内容分布还是很有规律的,特殊飞船(飞碟)只会出现在屏幕上端,盾牌和玩家的位置不会改变,只有子弹的位置不好把握,所以仔细研读代码,从DrawSpriteGeneric()可以看出,游戏对于碰撞的检测只是简单的判断像素块是否重合,对于玩家子弹到底击中了什么在PlayerShotHit()函数进行判断时,则只需要判断子弹垂直方向坐标(Y坐标),如果>=216则是撞到上顶,>=206则是击中神秘飞碟,其他则是击中护盾或者外星人的子弹。且由于外星飞船的是成组一起运动,只需要记住其中一个的位置就能推算出整体每一个外星飞船的坐标。
这样算下来,程序只需要保存外星飞船的存活状态、当前舰队的相对移动位置、玩家和外星人子弹信息,在需要检测碰撞时则去读取显存中的像素信息进行对比然后反推当前时哪两样物体发生了碰撞即可,这种***相比存储每一个对象的信息节省了不少资源。
六、结语si78c不同于其他代码,它本质上是对硬件和汇编代码的仿真,希望通过本文的源码讲解,让更多人看到当年程序员们在有限资源下***出优秀游戏的困难,还有代码设计的精妙。
最后,感谢本项目作者所做的一切,没有他的付出也就不会有这篇文章。如果您觉得这篇文章还不错,欢迎分享给更多人。