From 6f6697072366e6b3419c257415280d9c270824d6 Mon Sep 17 00:00:00 2001 From: kattakavya Date: Tue, 14 Apr 2020 17:26:13 +0530 Subject: [PATCH] setup --- Getting-started.md | 132 +++++++++++++----------- images/Thumbs.db | Bin 44032 -> 49664 bytes images/{system error.png => syserr.png} | Bin 3 files changed, 71 insertions(+), 61 deletions(-) rename images/{system error.png => syserr.png} (100%) diff --git a/Getting-started.md b/Getting-started.md index 6954992..90acd6b 100644 --- a/Getting-started.md +++ b/Getting-started.md @@ -1,51 +1,61 @@ -#Getting Started: +# Getting Started: -####Introduction: +#### Introduction: Heaps is an open source and multi-platform toolkit to create 2D and 3D games. -####Installation: - • To use Heaps.io, you need to install Haxe 3.4+ - • Later, Download the Heaps, +#### Installation: +• To use Heaps.io, you need to install Haxe 3.4+ + +• Later, Download the Heaps, [install](https://www.microsoft.com/en-ph/download/details.aspx?id=48145&751be11f-ede8-5a0c-058c-2ee190a24fa6=True). - For windows 8: (incase you are facing with error) - • If you are using windows 8, download Windows installer/Windows Binaries +For windows 8: (incase you are facing with error) + +• If you are using windows 8, download Windows installer/Windows Binaries Check in the heaps folder whether its running fine or not. - • If you are getting this error, -(/images/system error.png) - • Then please follow this link and download ,in your heap directory, manually we are installing it + +• If you are getting this error, + +![](images/syserr.png) + +• Then please follow this link and download ,in your heap directory, manually we are installing it (https://www.sts-tutorial.com/download/api-ms-win-crt-heap-l1-1-0). -####Setup: +#### Setup: Run in the command prompt - #####haxelib install heaps + haxelib install heaps + +#### Editor - Installation & Setup : +• The recommended editor for creating Heaps applications is Visual Studio Code: +The recommended editor for creating Heaps applications is Visual Studio Code:download +[Visual Studio Code](https://code.visualstudio.com/download) -####Editor - Installation & Setup : - • The recommended editor for creating Heaps applications is Visual Studio Code: -[Download](Visual Studio Code). - #####Install Haxe Extension Pack: - Click on the #####Extension panel (fourth icon on the left side bar of VSCode), search haxe and install Haxe Extension Pack that will contain everything you need for Haxe support. -(/images/extensions.png) - If your VSCode is up to date (after v1.31), you're good to go. Otherwise, restart VSCode once installation is complete (you can click the Reload label that should be showing) +• Install Haxe Extension Pack: + Click on the Extension panel (fourth icon on the left side bar of VSCode), search haxe and install Haxe Extension Pack that will contain everything you need for Haxe support. +![](images/extensions.png) + + If your VSCode is up to date (after v1.31), you're good to go. Otherwise, restart VSCode once installation is complete (you can click the Reload label that should be showing) -####Project creation & compilation: - • Create a new directory helloHeaps - • Create into it a file compile.hxml: this file will contain your Haxe compilation parameters and the libraries you are using. - • Edit the compile.hxml (with VSCode or any other text editor) to set the following content: +#### Project creation & compilation: +• Create a new directory helloHeaps + +• Create into it a file compile.hxml: this file will contain your Haxe compilation parameters and the libraries you are using. + +• Edit the compile.hxml (with VSCode or any other text editor) to set the following content: -lib heaps -js hello.js -main Main -debug - - • This will tell the compiler that we are using the library Heaps, that we will compile to JavaScript hello.js output, and that our main class should be Main.hx file. - • The -debug file allows generation of source maps in order to be able to debug your JS application. -####Open with VSCode: +• This will tell the compiler that we are using the library Heaps, that we will compile to JavaScript hello.js output, and that our main class should be Main.hx file. +• The -debug file allows generation of source maps in order to be able to debug your JS application. +#### Open with VSCode: At this point, you can open the helloHeaps folder with VSCode by launching VSCode and navigating the main menu File > Open Folder -#####Example: +##### Example: Creating Hello World Create a new Main.hx in the directory and put the following content - class Main extends hxd.App { + + class Main extends hxd.App { override function init() { var tf = new h2d.Text(hxd.res.DefaultFont.get(), s2d); tf.text = "Hello World !"; @@ -53,47 +63,47 @@ Create a new Main.hx in the directory and put the following content static function main() { new Main(); } - } + } - • This example creates a Heaps Text component, adds it to the 2D scene s2d and set its text. +• This example creates a Heaps Text component, adds it to the 2D scene s2d and set its text. -####Compile Output: +#### Compile Output: - • In order to compile, you need to create a Build task with VSCode, this can be done by going into the VSCode menu and select Terminal > Configure Default Build Task - Or ( you can use the command to get the Terminal: #####Ctrl+Shift+P ) +• In order to compile, you need to create a Build task with VSCode, this can be done by going into the VSCode menu and select Terminal > Configure Default Build Task + Or ( you can use the command to get the Terminal:Ctrl+Shift+P) Select haxe : active configuration - • You can now compile with #####Shift-Ctrl+B  (or by going Terminal > Run Build Task) +• You can now compile with Shift-Ctrl+B  (or by going Terminal > Run Build Task) - • If everything works well, you should now have both hello.js and hello.js.map files created in your helloHeaps folder: -(/images/content.png) +• If everything works well, you should now have both hello.js and hello.js.map files created in your helloHeaps folder: +![](images/content.png) -####Run in Browser: +#### Run in Browser: In order to run our example, we need to embed it into a web page. Create a file named index.html with the following content: - - - - Hello Heaps - - - - - - - - -In order to Run with Chrome, you need #####Chrome Debugger VSCode extension. Open again the Extension manager and search for Chrome to install it: - -(/images/chrome.png) - - • Once installed, press F5 or do Debug > Start Debugging. This should give you the choice to Debug with Chrome. If not, restart VSCode so the extension is activated. - • If you click on Chrome label, it will open you a .vscode/launch.json similar to the tasks.json we had earlier for compiling. + + + + Hello Heaps + + + + + + + + +In order to Run with Chrome, you need Chrome Debugger VSCode extension. Open again the Extension manager and search for Chrome to install it: + +![](images/chrome.png) + +• Once installed, press F5 or do Debug > Start Debugging. This should give you the choice to Debug with Chrome. If not, restart VSCode so the extension is activated. +• If you click on Chrome label, it will open you a .vscode/launch.json similar to the tasks.json we had earlier for compiling. { "version": "0.2.0", @@ -111,7 +121,7 @@ You can either setup a web server on localhost:8080 to display the content, or "url": "file://${workspaceFolder}/index.html", Now Run again (through the menu or F5) and the browser should open and display Hello World -(/images/hello.png) +![](images/hello.png) -####Reference:https://heaps.io/ +#### Reference:https://heaps.io/ diff --git a/images/Thumbs.db b/images/Thumbs.db index 05727662c9a4e0ef6d4aabed7c90727b0dd4e3ee..dba7bdd0c89737ffb76b801853ae44e027d1b934 100644 GIT binary patch delta 4740 zcmb7Hc{r6@+g~zfCPIj!$&@+b*r~9aOqn9lKx8TolHt)LUib7oYpweZ?%5Umgz=LZ<1q^WfF%Me z1XmDPBd|em6@e{+YY6NR&|^#<$1=Gx8@pB3n&jVOvSeUmMras$a1Ys}^VgUocO6j% zYCs(kcLYk{22cc=2pqsopo~BTc~?VtO`w81z$Ah@#iq()j%eT!z_qfS&p*4n+KG2_ z4*|J&dx=<_{7XFj=cq={oxBv_?9@9&pIjr?Q6wS|o3Ii3J zYYmX?MK>Q9Ui-<_ewbQn~=&+qWQ)ggI;<(TShc59CE zp>vkaUge_JQeyTH=bPabKh`j{T!A-xXVBxsnE9lqhy5-)_wl?!_n~jxV@l%wH zRW8qq1cc^paQV{xFTfzsfG!aD*cJwF+h9O3fx%PrJZhMmw@%l?E+Ho-gQLP*4WtRq z#@!<2=txY}A;Dm2t4{5E`@`ov+#GpX?{}T;s|fYheFzot>Ub3u=|=B*QJ>ZVgIq1> zmC!+Y84P~-_NY;|=8x~JOHfUIF)OGSbZn|k06MZM7Bn-#UA7p!4`okk6zezIj=zA>(cDxe@=uY*LLMAjSh zEy7@O#*XF%gRq=Cv(;@jv!AAS^*LhD<2NNw>zgMVn@#Sw;xAmqaQFM>glE0}`QvIj z^y{jWd0!Z;t{Aaz86@750 z6L8abyc%eJ&>y~-9RJnZj|Iz)vq?_J6^L<4AuBdbgUak%gLe36-K!qk<++0+1Q$VV z9aBA&6R!SB-;lwR+6hO`6K(@UFMiDyMU_7sPx1XV;tt<^`0p>x8Vj4Y-GCPjQP^-|%Qq-;h!S3$RQnd1eQ&FFXf zZcl~5sOO3RHa^H+5wn67X^s7Nj8FJ7{sXgy0*5J95qlwqAet%Y~ z<}e)kmSQwmxIm^AY6W{W6&;xvIIxu{r|bF&n}m-{*uP&h=bX#D=YM=QOVx%no2)j{=9={UV$9K)bM}E8 zxA-BgU1t=feWZQWJo512Im_JF$mh*|R6B z?kGDykf}WUsM9^6IhFQpZYoAU8GTB+nmpzVsn->2XSvsd>9c5Q<)`~^g4E9qjMBRT z862hBk95Ue84Y&F;|;QSQEwdY+g&d0QjPGRrKW_8ILNiu9BhneDCa*W0|N!+@}Yzw z?nkNfqt;d*-lfOd_Ma2D7q2tp*TSdLFT=u=IaI=VYi~WFm^1@}rRqXg$oUGg#hj4* zFMg)0{@>`2f!f32OFn_NZ$(Lm_4&d~(I(M?3d{Igo^$V2&xZ7$VJsIl47#?=f4}FB zkX@dG!mQ{`gDQ6k90(#cpweZOD+8_D;jnG zR-$a8+M2~Bn`_y2t+t8w(65&N(~YI(lao6HwQi#Tww;$8f=UByBCBEj&JtFo7MJpVE1)Jx# z)@*Sk_q34w?VV?vHQogU{sUPGP)RmVA&Kx2IbjIUCh|k=L;X6Sz8IXW>+ULCbj}@A z8>?P;xNyicg)a{uSYzeqRXbmD{VJZ}7}>jBew~1j#6&Y zTv#nIvJsC}m8&a)>jzVqIDK_GSB~LESf;PjDJ6R!RQ$;-g)g3rDw5y&d;0flbnH?VMz>d+bUc?KM*uFhnB!Yp5_LIQ?;v;5)~3Ao zG!de-XK%~|+Pgk4ihk)EYFMPSx z?ZGI#SyMP-VX0-?7$W!X32(i4`-80D1YAvo2i0n|VH|QFaKBs0MZC->o5j|vd&uXh z4}0^r!SCFf0xMb`8g$h7>Y7o09>(umfhMFi-5yvnops^bY_ZPAZ6!Jl+FVA}V)G>y z>tF!wp}CBexGaY9_gmNg-0ALJ$QdE<*LlkhzwbLo#-k1vzhKJQ-GjbcaXZ8))RM1u zi5l+N7DEutC_hk&l?##N85B(qW_52fq=CEI7>YXzyXB`Ow*iBd1-l0;tE+a9-?~RH zc5@U4q%gW_;7b?;p|+`sqgM^)7Q7qga>u%J$4Nfwi+uROQ|VJJshrOw(UFn5=2Aeh zezcE9pij}VChnQx*)c*B<1+-q>E9G`yXxA8T~4lb%r|`t+@F1=Ae%7l74dhW5mwrv z?Ua?2CZh#x;}^}ibr^7Z_a@l=okO;1FA@hN@VBTD7Pc(a0}(z63uf%E^+j4b6|BnLaa`zj1F`>6EU47&aYdQBO9lCF)a{pfTucv&s1D3+1AS?-21 z7nFK2W2OGbC+Sk%3S%p-9!U&a)~mP0s@W`o?q?Mw3tb*Xbj+U~H~4TbawBQ;RB1D5 z&Sr4|8m*!^{i(CGsR|`ndgV|{gzrb2FNCfmPPZcFV$Z(VZjtZP?1@o~3G!(Px;iR6 zIe5q29AmV-cY8aLx`b>s)g}>WZoMa9oLt;BD)zW_c}BD0hFUY3 zXv6hWhE|bvUp2}-D}o=5($BmgtD_W~fjrBs@aJpot+Us=J zxdX2^asBAewXb7ZeYK*qzQmi|iu?>b^}J4?_LT_?R&H$Wmu|fkq9-#2br+6bL02#d zRWRMv&5_z@EdHEN{VnT4hQ4EAvyAc0LvK%o>e^SFFOg;Kt6}RGh-RR*d|5_S4Rq&O zPv>C0n13Fy&k-EQTX%fCy_+FKvY}W(-$0PZVaMAco02<)?TUb+5;^3rqYo^rW2B-^ zr*8+a0#1h5u>^*Wg!WV_L|H1l->0d4DdoAnu7tNnhHXEd+Qp|n%O4e~ar)>V%;q+;cYzoH0e}^7gO9V=NQl!~MBb*_TD<0c ze6y!rxe_i`XLT3!W$ZSyzZe6y=DZB<(<_uSVKFk1V-4?+->rIf(6iZFL*ylfWx`Re zM~oBqu)I81@avB;bb$&&^ft@P(?;BhO0G z7AQf)LUR8|wf*#nT&9AHTU$59MIw#=zW?z1MhiRfo+3#ogOYBoen!zNwi@?BPx>v| zn5U^mjdo(GbCYqDd@1)>d~ip0u=1W*Dp%ANSg7@6)wZ0tBuL)*9J)w7zM=u;DZ-$M z+C=-_Zm>kGVtv^X;CoBjQ32iIX3%^uR$aR zp@pr*cM{TY6qyaV-aol|FdQNaV<%{PDR)Vqk=@ZWSxQ{|^3y@+30;U>e<-5P$62yg z#9P+>{&c$uN*0Xk65ysDv@J zE)%9YhPLKn-FB&;IErLI<4}nHoS2gI?Ih{-!zAUYG$a9ZkBSEyi|NqKVHm_M$E5|; zO;=I&DD3=&1b)LbcSEyrKg!$P^=sPUVF9vBHN5&|+WBnk(J7{djIvQ_qMspr zPtjUm(Uj6wyq?4#@e6HnY)kOaNRh>h9XmeMnkV@Px?73x}b!lcp%Y%l6jj#9@-{fOvT9fuE z8HdE!$j|%wejS`oEQFTI==&k)M@2FWh8ig}r@zxfgPQv&U5R5sy+|*)P4$Dp z8I}kbJeGx)GdD@1IwCX1qAuUO&b(rg%+pD6Z}f?-l1vce<>nEy97z@MQfOL+fg*7| zZA+qHFG-j#Og`m0AE29LZS(oYS;!K(jH-RrJ2^8`!=#BB@{bH%jOaohmEUC>VDKbP zUum99pxDGj-V~;^i`^jc9eqDg8?&vHO6?wcf%O*e%nc=!RwN!g(P@EBs;^kN;b*N; zB+V7Bo*`3Ys`oom>wVP`hJJiUdg7q~37Tz?q=~7@#vpn0L}i3J{@pTkIP$}7<#Q2K zo!gSfZmzCZKCDZ1n$po;B1Wn8bXPq{eVc4wkkBZvAobeb_nAA=<-K;F&n9ZLv|~a@ zT(b)j)Wbwt)cylV=Xw;i=A35{fxdl z8wOGaq0nq2&(1!V;hDcukPF&l1;VMkrKoMCO!JUa=x7YG#1<(?*FK!2VRE}A{)>CR zVb^V;R}9fV#u0FEIF(nHq8FxwYiWboRQ-{6ijC1RN4H6wTEePIH${G7tTGC Z6F6NqAK`S#n9NZkuvzfH3&uqy76A3^Ar=4t diff --git a/images/system error.png b/images/syserr.png similarity index 100% rename from images/system error.png rename to images/syserr.png