From b4bc29d5c6dff071bd3f4c428b0d4227e09ec6c8 Mon Sep 17 00:00:00 2001 From: Marco Cawthorne Date: Mon, 3 Oct 2022 14:38:54 -0700 Subject: [PATCH] Add Documentation/CodeOverview.md --- .dir.tiff | Bin 0 -> 9479 bytes Documentation/.dir.tiff | Bin 0 -> 9476 bytes Documentation/CodeOverview.md | 36 ++++++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 .dir.tiff create mode 100644 Documentation/.dir.tiff create mode 100644 Documentation/CodeOverview.md diff --git a/.dir.tiff b/.dir.tiff new file mode 100644 index 0000000000000000000000000000000000000000..1acb88112e7ecf0cd8f0c8f2238bd685ad57f6bd GIT binary patch literal 9479 zcmdT~3tY|TAO4$GG=a@>ljIL z3*{CzVKc1evKf-Jjfr~x&wDOA$8i`P`^)L0-rukHJw3nY_q@;d`Tmaf?dwQ!S9zG% zOiscR`ltSOVP9Lg@JZn||GNsy!@gQ_qWSuwa;&gD=oQFc78R`b!=W%*dKG2f&9BAM zeK4O>)Q?T?K~dVP56heBo_^RhMQxtC2mcp;cd1w$?OxQNZ|C;#3m5=zzhJcL6%3EA z!Km4`-~D-M5(s(K58~bvQr8FK)*j;83R1F?T2pB3B{YI2P6Gdz1kp_dt2znN`wRXG zvqAohs=ybGfpy-%o)N&2=|G}C#xxe>{c#H?F9BPB=9Ck_q%@%4nqMsA_uzGXlnt4j z2^s$#By<;K&_+n$GRyM|>75?W3MMuc?D7-jMwABT)B?V00c`369Ebo8PQ*)gkdBd-=NA$`@8f;n zZ}wT_$Npb{HK%}?-vT32fIeFQkB<)Cizn`P$W-bog4Z^BKV;|@$a||GuMfO; z?jv9~zZUc3W-j)K^{=k| zV)6*Ju@>2%*Y>h5`_*Zc@$V5iekcp=tW78lXY$Nx)zTUHpa~^=5_EGBL@Lks5u70Z zS<&TjXMO{2%yvLhAh2&daA*p!ycu#cGmvqm0K4cp%YOi-9|nf*2D&B!t-b*otp>^k zd}_ot<2pU(93=c0WMm3tNCKq)SCH~<#yM8tuRz`RX3d({MsO^M+KDPgLA%fpo08z} zK=Ke`k73;!j+FQ8kb6B3N6G!BpJ+|Tfbji5;C7%xJkX5X*INmc?m5kfE%q`b`ZQ$R zA;_>Dkl^)@ev6F1w*vb=-J8mewixwRBP7iZ#I+@@F}$t@=d$vVavoTD68Pu{Fl-Od zlia^a?i-W)nqLCNI*!xf3t(NHdY+zn0y1hZx!(*4TFKntZ54idW`)`%1>W@hsjmsv z`3g?b^ZyFBXA!LiENKF)?*i-?#63F+*gF=P;~a4&VGWM|MhndV79Iy84*)?sfKHo$ z*VoZE$$j;ufNk?&9ln|L{OF&U6^=lL?}QBe2J+4ltFW7M?p{_9#jLQ$Uyw7g3<}Ka zmC8EtJu$d0ukZIf?7P5i@uRL@QO@X1&up^+XtIXB`4#u>53P1$!PhRc~{CHWP(@g6Xx%XTP)F$^;7jy4^M*MX;>2v1K#+>#ZbDGcOf0g?N zRqXI#KR4`&^Fh|OaVSU~gN(6`$VmDI7r1ZtQacOiIa=K_D|9r`{R`B+(?V*0F7eOI zCHEI}`}SYby+J1$`d52b8_euc9?206aba0Eg%iv=Tc{nC(}pMC z`djxN)V&)$r!u)OrMRDco7`tXCNV>g|JJDcmhW55eVYo@O?|-k7CXb$93v{@2n}fc=Zkrko&c#*q<<`)$cXJqVDbH5r5nt%sSM4 zIq>o5-oUq|pFQe3Af~4?){Se5!wdT2Vp14x#``18Q*b-?CQdTrZ~GZo%zdkJnoS8O zcq!eJd#Ia=M%zN6QDrheb?zy4VZ(N&WTx zRWxqTt%KFUKDff1d5HCPJ^QO!?615gdG8dQUBiIG(^$7c z@OfwI{z?|kko%oyfo04(Q`uiB9u$6+(_W_MIFozF1w8+0zAk5~{%S(HK4)%%yfw!v z?B={%I&NRz5s`iCVbvrb99$fN8w;D@;}(^W!<_l;MPMVd&K%~8A zHFnox0zc;Cs8^YfI|z>SV?G|vdKK+JL01P>d(jvJv>6A7r!pM0#mM?L_#-zD>Eu3v zS!X^yKY}^4MCBSf{S+FDpFlPoVwi>@By_lXW zX|KU+Zsiae^ac(sd>f}ml}6@{1e|BRN+tIznRPy9&K$b!Pa_uM*VZd$1zo*Ty}7<# zjZ#^M{iDj6O@oYUtjx)(zwPBJ_>9jzj)vGGXIfPnB6H?uf8BEhmD4tM$Do%5H<{B; zFlTNd_bO*jr02V~4KQLMepRnZYPrwT*DFKLOxEX2lOC*)*k7b}I#$v3whLPe_R)88 zMp8Rd%d+{X&F3Pm07JdnKY`a&1qbHEYIE9teZ7if))|>XeVbw+{&M8rPGtpEuT)Mm z)T^OM^!(M34&isNFUvwiu6WbfLOlEPIr!U1Vy>IREMRk?RBBurT}4(i(%m-xs5ku(}AJiikV^X-vj89NY2S zW&STATm5-8&p|(CM=VYnJMG%y9G5eh^PGOH)>qJvBRQ_9pD%pRDjIw3+EW}?)sN3{ z>}>Kr&ueVt8LrFYc{lxeTOM~cnbVD9JD$ts9QEpwc#hwT|NXN#$LdR?|MGn&bVN}9 M>Yd&h8#G-02hY)lcmMzZ literal 0 HcmV?d00001 diff --git a/Documentation/.dir.tiff b/Documentation/.dir.tiff new file mode 100644 index 0000000000000000000000000000000000000000..2358f7f694d2bf6e1ac2bd10ef19a41e463b659b GIT binary patch literal 9476 zcmeI2e@I7M`;pPga*@nR z!Vp3XT&*c{qukBxhm4WS%(9^Q16K17-N?`ybNv&m`R#qrJoPT3b@ z9A4NLOC0lMzn*cJ*(WC_!4JZiPgYizj2TxKcEx8Q4^=aJetv!ow^b~0;iUx&6^EJK ziZkAvgc(;&WE_cLr`W>ba9nnIf$+`udLB;M(|nP8pmt+KUfjb_oR_5RuioBX8Pitx z8iSd=yu4h=Q@DzuD4SuRl41V?sX$vH8bfyhKfHl=pSo4K&lX(2=!M_R-q6qx!%&$Q z$@SnCh7~CcXw1Q`06%xWdIl4pRb%$VOYCwjl(ALD%P! znZ3Ka+whxzV}yD4dWJ`G7-}{#%r@nssWJ~ZwF}*iTQS|}$HnpUI5P7F9RXhI2P!@XHhnCy7rhGh))ZLHFxbkq$jHdB#MjtE5q78jV`dkIMXnyq zVz}pKhUW_yMxI-S@QyXWC#7h8aWgPbgVWp7arx2}d~-g+UEK$i>D;%s>FoFI1grlY z?3FWMyH9~V%g>eMbWBfA$MBoko#fw&o%pHVXuTW19WKK^eJ=y2_u~DnMY!pw+F7qIa-aNA)Zqva~tzJ9Q}39$V?fmMA8w(XG7J1s3Oj@aYnU&U_b7jc}Z zDa1g>5uD@qWcVCV|0A$rTdl^l{wR?BA+Wre=lq>ZV6TsXReuMzGYnSow!tmzw70ig zv+MmXm_*)%3 znTA!rNAey*u0KF_qWGP%%dYzSc`r-cQF>Jm*waV&b)RxgUmw4*O+(Edgny2`Lx%Ul zF1wB5R>fnQudAz*O=!BtuIP6u?}FXnpD()%;WUoX(NTHZ9J_tLi#mE@C$1Q$iV0e8 zC9SrodnT&iJ+aIFh)15Y(`RO8(An9E;o)KBGBtZlzZ*TnIoN#q#%&xbcrX1f*u~KH z>dym}eVXUXwKIgilT^*qbvtRFckO(S>36|RgZBFa0pq!5=TBVYdlM1|`4&?20m(o> z-S5OrQta{jb8+xsGlKlS5Ad^U^?HU`klB*ihbfatl8sw zb#o++MASnShvv)W`A)oM8R5^>>PIyca|=}uja`}d`2B9pKbLCeFt%PsfT7eLH%wKgNS*Me_X}kv>x_( zci-<8{9=mgHs&@CyLzbEz4yCA->c$2BfCyH=DUvkIjRRSlXUYwGhfg+`za3FddT^A`#uxL zf1)l^9G3N%%lkF&cen9T98vXH1pV$c4x=92fc8A(l45jg^Lnf&R#6YqglwGX+Lx;B{e|mmbbW&B*^-?cUlO~4@4Le1*Xr}h{QG0lnhLI`@VU!;jTq%$Oz_`n XhD_tS`0?pK{tX59-nn;sD8&8)B1vci literal 0 HcmV?d00001 diff --git a/Documentation/CodeOverview.md b/Documentation/CodeOverview.md new file mode 100644 index 00000000..4408f2c2 --- /dev/null +++ b/Documentation/CodeOverview.md @@ -0,0 +1,36 @@ +# Code: Overview + +## Getting started +Most developers probably only want to get their hands on the game-logic component. + +In Nuclide we have 3 main modules supplied to the engine: + +- **Client** +- **Server** +- **Menu** + +When we build these with the **fteqcc** compiler, we will get three files: + +- csprogs.dat +- progs.dat +- menu.dat + +In the source code tree of Nuclide itself, you'll find all the core entry functions that +the engine calls in a file called `entry.qc` which exists in each sub-module its directory. + +However, you probably don't want to modify the Nuclide `./src/...` tree directly (unless you got a good reason) and want to focus on your own tree. + +A minimal basis you can copy and paste can be found under `./base/` which implements a very minimal game. You can walk around, jump and even shoot a projectile or two. + +This is an example codebase implementing the minimum required to get going with Nuclide. +So make a copy of it and play around there to get a feel for what you can do. + +There are some other example games, such as **FreeHL** which you may want to look at too. Some games (usually not provided by us) have a different **license** so watch out as you don't want to step on anyones toes. + +However if it's provided by us (**Vera Visions, L.L.C.**) then you can usually assume it's under some sort of **free license**. Wouldn't hurt to check however. + +## Example: Base + +To be written. + +