-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
1050 lines (923 loc) · 31 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>@font-face {
font-family: octicons-anchor;
src: url(https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/font/octicons.woff) format('woff');
}
* {
box-sizing: border-box;
}
body {
width: 980px;
margin-right: auto;
margin-left: auto;
color:#333;
background:#fff;
}
body .markdown-body {
padding: 45px;
border: 1px solid #ddd;
border-radius: 3px;
word-wrap: break-word;
}
pre {
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
}
.markdown-body {
-webkit-text-size-adjust: 100%;
text-size-adjust: 100%;
color: #333;
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 16px;
line-height: 1.6;
word-wrap: break-word;
}
.markdown-body a {
background-color: transparent;
}
.markdown-body a:active,
.markdown-body a:hover {
outline: 0;
}
.markdown-body strong {
font-weight: bold;
}
.markdown-body h1 {
font-size: 2em;
margin: 0.67em 0;
}
.markdown-body img {
border: 0;
}
.markdown-body hr {
box-sizing: content-box;
height: 0;
}
.markdown-body pre {
overflow: auto;
}
.markdown-body code,
.markdown-body kbd,
.markdown-body pre {
font-family: monospace, monospace;
font-size: 1em;
}
.markdown-body input {
color: inherit;
font: inherit;
margin: 0;
}
.markdown-body html input[disabled] {
cursor: default;
}
.markdown-body input {
line-height: normal;
}
.markdown-body input[type="checkbox"] {
box-sizing: border-box;
padding: 0;
}
.markdown-body table {
border-collapse: collapse;
border-spacing: 0;
}
.markdown-body td,
.markdown-body th {
padding: 0;
}
.markdown-body input {
font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
}
.markdown-body a {
color: #4078c0;
text-decoration: none;
}
.markdown-body a:hover,
.markdown-body a:active {
text-decoration: underline;
}
.markdown-body hr {
height: 0;
margin: 15px 0;
overflow: hidden;
background: transparent;
border: 0;
border-bottom: 1px solid #ddd;
}
.markdown-body hr:before {
display: table;
content: "";
}
.markdown-body hr:after {
display: table;
clear: both;
content: "";
}
.markdown-body h1,
.markdown-body h2,
.markdown-body h3,
.markdown-body h4,
.markdown-body h5,
.markdown-body h6 {
margin-top: 15px;
margin-bottom: 15px;
line-height: 1.1;
}
.markdown-body h1 {
font-size: 30px;
}
.markdown-body h2 {
font-size: 21px;
}
.markdown-body h3 {
font-size: 16px;
}
.markdown-body h4 {
font-size: 14px;
}
.markdown-body h5 {
font-size: 12px;
}
.markdown-body h6 {
font-size: 11px;
}
.markdown-body blockquote {
margin: 0;
}
.markdown-body ul,
.markdown-body ol {
padding: 0;
margin-top: 0;
margin-bottom: 0;
}
.markdown-body ol ol,
.markdown-body ul ol {
list-style-type: lower-roman;
}
.markdown-body ul ul ol,
.markdown-body ul ol ol,
.markdown-body ol ul ol,
.markdown-body ol ol ol {
list-style-type: lower-alpha;
}
.markdown-body dd {
margin-left: 0;
}
.markdown-body code {
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 12px;
}
.markdown-body pre {
margin-top: 0;
margin-bottom: 0;
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
}
.markdown-body .select::-ms-expand {
opacity: 0;
}
.markdown-body .octicon {
font: normal normal normal 16px/1 octicons-anchor;
display: inline-block;
text-decoration: none;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.markdown-body .octicon-link:before {
content: '\f05c';
}
.markdown-body:before {
display: table;
content: "";
}
.markdown-body:after {
display: table;
clear: both;
content: "";
}
.markdown-body>*:first-child {
margin-top: 0 !important;
}
.markdown-body>*:last-child {
margin-bottom: 0 !important;
}
.markdown-body a:not([href]) {
color: inherit;
text-decoration: none;
}
.markdown-body .anchor {
display: inline-block;
padding-right: 2px;
margin-left: -18px;
}
.markdown-body .anchor:focus {
outline: none;
}
.markdown-body h1,
.markdown-body h2,
.markdown-body h3,
.markdown-body h4,
.markdown-body h5,
.markdown-body h6 {
margin-top: 1em;
margin-bottom: 16px;
font-weight: bold;
line-height: 1.4;
}
.markdown-body h1 .octicon-link,
.markdown-body h2 .octicon-link,
.markdown-body h3 .octicon-link,
.markdown-body h4 .octicon-link,
.markdown-body h5 .octicon-link,
.markdown-body h6 .octicon-link {
color: #000;
vertical-align: middle;
visibility: hidden;
}
.markdown-body h1:hover .anchor,
.markdown-body h2:hover .anchor,
.markdown-body h3:hover .anchor,
.markdown-body h4:hover .anchor,
.markdown-body h5:hover .anchor,
.markdown-body h6:hover .anchor {
text-decoration: none;
}
.markdown-body h1:hover .anchor .octicon-link,
.markdown-body h2:hover .anchor .octicon-link,
.markdown-body h3:hover .anchor .octicon-link,
.markdown-body h4:hover .anchor .octicon-link,
.markdown-body h5:hover .anchor .octicon-link,
.markdown-body h6:hover .anchor .octicon-link {
visibility: visible;
}
.markdown-body h1 {
padding-bottom: 0.3em;
font-size: 2.25em;
line-height: 1.2;
border-bottom: 1px solid #eee;
}
.markdown-body h1 .anchor {
line-height: 1;
}
.markdown-body h2 {
padding-bottom: 0.3em;
font-size: 1.75em;
line-height: 1.225;
border-bottom: 1px solid #eee;
}
.markdown-body h2 .anchor {
line-height: 1;
}
.markdown-body h3 {
font-size: 1.5em;
line-height: 1.43;
}
.markdown-body h3 .anchor {
line-height: 1.2;
}
.markdown-body h4 {
font-size: 1.25em;
}
.markdown-body h4 .anchor {
line-height: 1.2;
}
.markdown-body h5 {
font-size: 1em;
}
.markdown-body h5 .anchor {
line-height: 1.1;
}
.markdown-body h6 {
font-size: 1em;
color: #777;
}
.markdown-body h6 .anchor {
line-height: 1.1;
}
.markdown-body p,
.markdown-body blockquote,
.markdown-body ul,
.markdown-body ol,
.markdown-body dl,
.markdown-body table,
.markdown-body pre {
margin-top: 0;
margin-bottom: 16px;
}
.markdown-body hr {
height: 4px;
padding: 0;
margin: 16px 0;
background-color: #e7e7e7;
border: 0 none;
}
.markdown-body ul,
.markdown-body ol {
padding-left: 2em;
}
.markdown-body ul ul,
.markdown-body ul ol,
.markdown-body ol ol,
.markdown-body ol ul {
margin-top: 0;
margin-bottom: 0;
}
.markdown-body li>p {
margin-top: 16px;
}
.markdown-body dl {
padding: 0;
}
.markdown-body dl dt {
padding: 0;
margin-top: 16px;
font-size: 1em;
font-style: italic;
font-weight: bold;
}
.markdown-body dl dd {
padding: 0 16px;
margin-bottom: 16px;
}
.markdown-body blockquote {
padding: 0 15px;
color: #777;
border-left: 4px solid #ddd;
}
.markdown-body blockquote>:first-child {
margin-top: 0;
}
.markdown-body blockquote>:last-child {
margin-bottom: 0;
}
.markdown-body table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all;
}
.markdown-body table th {
font-weight: bold;
}
.markdown-body table th,
.markdown-body table td {
padding: 6px 13px;
border: 1px solid #ddd;
}
.markdown-body table tr {
background-color: #fff;
border-top: 1px solid #ccc;
}
.markdown-body table tr:nth-child(2n) {
background-color: #f8f8f8;
}
.markdown-body img {
max-width: 100%;
box-sizing: content-box;
background-color: #fff;
}
.markdown-body code {
padding: 0;
padding-top: 0.2em;
padding-bottom: 0.2em;
margin: 0;
font-size: 85%;
background-color: rgba(0,0,0,0.04);
border-radius: 3px;
}
.markdown-body code:before,
.markdown-body code:after {
letter-spacing: -0.2em;
content: "\00a0";
}
.markdown-body pre>code {
padding: 0;
margin: 0;
font-size: 100%;
word-break: normal;
white-space: pre;
background: transparent;
border: 0;
}
.markdown-body .highlight {
margin-bottom: 16px;
}
.markdown-body .highlight pre,
.markdown-body pre {
padding: 16px;
overflow: auto;
font-size: 85%;
line-height: 1.45;
background-color: #f7f7f7;
border-radius: 3px;
}
.markdown-body .highlight pre {
margin-bottom: 0;
word-break: normal;
}
.markdown-body pre {
word-wrap: normal;
}
.markdown-body pre code {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0;
}
.markdown-body pre code:before,
.markdown-body pre code:after {
content: normal;
}
.markdown-body kbd {
display: inline-block;
padding: 3px 5px;
font-size: 11px;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
.markdown-body .pl-c {
color: #969896;
}
.markdown-body .pl-c1,
.markdown-body .pl-s .pl-v {
color: #0086b3;
}
.markdown-body .pl-e,
.markdown-body .pl-en {
color: #795da3;
}
.markdown-body .pl-s .pl-s1,
.markdown-body .pl-smi {
color: #333;
}
.markdown-body .pl-ent {
color: #63a35c;
}
.markdown-body .pl-k {
color: #a71d5d;
}
.markdown-body .pl-pds,
.markdown-body .pl-s,
.markdown-body .pl-s .pl-pse .pl-s1,
.markdown-body .pl-sr,
.markdown-body .pl-sr .pl-cce,
.markdown-body .pl-sr .pl-sra,
.markdown-body .pl-sr .pl-sre {
color: #183691;
}
.markdown-body .pl-v {
color: #ed6a43;
}
.markdown-body .pl-id {
color: #b52a1d;
}
.markdown-body .pl-ii {
background-color: #b52a1d;
color: #f8f8f8;
}
.markdown-body .pl-sr .pl-cce {
color: #63a35c;
font-weight: bold;
}
.markdown-body .pl-ml {
color: #693a17;
}
.markdown-body .pl-mh,
.markdown-body .pl-mh .pl-en,
.markdown-body .pl-ms {
color: #1d3e81;
font-weight: bold;
}
.markdown-body .pl-mq {
color: #008080;
}
.markdown-body .pl-mi {
color: #333;
font-style: italic;
}
.markdown-body .pl-mb {
color: #333;
font-weight: bold;
}
.markdown-body .pl-md {
background-color: #ffecec;
color: #bd2c00;
}
.markdown-body .pl-mi1 {
background-color: #eaffea;
color: #55a532;
}
.markdown-body .pl-mdr {
color: #795da3;
font-weight: bold;
}
.markdown-body .pl-mo {
color: #1d3e81;
}
.markdown-body kbd {
display: inline-block;
padding: 3px 5px;
font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
.markdown-body .plan-price-unit {
color: #767676;
font-weight: normal;
}
.markdown-body .task-list-item {
list-style-type: none;
}
.markdown-body .task-list-item+.task-list-item {
margin-top: 3px;
}
.markdown-body .task-list-item input {
margin: 0 0.35em 0.25em -1.6em;
vertical-align: middle;
}
.markdown-body .plan-choice {
padding: 15px;
padding-left: 40px;
display: block;
border: 1px solid #e0e0e0;
position: relative;
font-weight: normal;
background-color: #fafafa;
}
.markdown-body .plan-choice.open {
background-color: #fff;
}
.markdown-body .plan-choice.open .plan-choice-seat-breakdown {
display: block;
}
.markdown-body .plan-choice-free {
border-radius: 3px 3px 0 0;
}
.markdown-body .plan-choice-paid {
border-radius: 0 0 3px 3px;
border-top: 0;
margin-bottom: 20px;
}
.markdown-body .plan-choice-radio {
position: absolute;
left: 15px;
top: 18px;
}
.markdown-body .plan-choice-exp {
color: #999;
font-size: 12px;
margin-top: 5px;
}
.markdown-body .plan-choice-seat-breakdown {
margin-top: 10px;
display: none;
}
.markdown-body :checked+.radio-label {
z-index: 1;
position: relative;
border-color: #4078c0;
}
@media print {
body .markdown-body {
padding: 0;
border: none;
}
}
</style><title>README</title></head><body><article class="markdown-body"><p><a href="https://gitter.im/orx/orx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" rel="nofollow"><img src="https://camo.githubusercontent.com/da2edb525cde1455a622c58c0effc3a90b9a181c/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667" alt="Join the chat at https://gitter.im/orx/orx" data-canonical-src="https://badges.gitter.im/Join%20Chat.svg" style="max-width:100%;"></a>
<a href="https://travis-ci.org/orx/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/dea1a9fd7fae03601ad3c5bec31c2034dabfe57c/68747470733a2f2f7472617669732d63692e6f72672f6f72782f6f72782e7376673f6272616e63683d6d6173746572" alt="Travis build" data-canonical-src="https://travis-ci.org/orx/orx.svg?branch=master" style="max-width:100%;"></a>
<a href="https://ci.appveyor.com/project/iarwain/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/2ce3ea8bf2415f5a5b63fcf3e89e7831cb2602c1/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f616c776d34696c377831773667316f343f7376673d74727565" alt="Build status" data-canonical-src="https://ci.appveyor.com/api/projects/status/alwm4il7x1w6g1o4?svg=true" style="max-width:100%;"></a></p>
<h1>
<a id="user-content-orx---portable-game-engine-version-110" class="anchor" href="#orx---portable-game-engine-version-110" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Orx - Portable Game Engine (Version 1.10)</h1>
<p>Email iarwain [at] orx-project.org to contact the author; or, better,
check <a href="https://orx-project.org" rel="nofollow">orx's homepage</a> for the most up-to-date contact information.
You can also come <a href="https://gitter.im/orx/orx" rel="nofollow">chat with us</a>
if you have any questions or comments.</p>
<p>This engine is licensed under the very permissive <a href="https://en.wikipedia.org/wiki/Zlib_License" rel="nofollow">zlib license</a>,
see the <a href="https://bitbucket.org/orx/orx/src/default/LICENSE" rel="nofollow">LICENSE</a> file for details.</p>
<h2>
<a id="user-content-summary" class="anchor" href="#summary" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Summary</h2>
<p><a href="https://orx-project.org" rel="nofollow">Orx</a> is a 2D-oriented, data-driven, portable game engine focused primarily on ease of use and powerful features.
See below for a list of supported platforms.</p>
<p>This is a release candidate for orx v1.10. If you find any bugs,
please report them on the <a href="https://forum.orx-project.org" rel="nofollow">forum</a>, in the "Bug report - Feature request" board,
or via orx's <a href="https://bitbucket.org/orx/orx/issues?status=new&status=open" rel="nofollow">issue page/tracker</a>.</p>
<p>Some notable features of the engine are:</p>
<ul>
<li>hardware-accelerated rendering that provides: translation, anisotropic scale, rotation,
transparency (alpha blending), different blending modes, coloring, tiling and mirroring</li>
<li>advanced rendering features such as MRT (Multiple Render Targets) support and easy compositing</li>
<li>powerful config system that makes orx data-driven and provides an easy to use load/save system</li>
<li>powerful resource management allowing for easy multi-platform data support and patching</li>
<li>automatic hotloading of resources upon modification on disk shortens drastically iteration times</li>
<li>timelines and commands modules allow for config-driven scripting-like features</li>
<li>interactive console can execute commands at runtime (very useful for tweaking/debug purposes)</li>
<li>advanced animation engine (including a chaining graph & custom animation events for synchronization)</li>
<li>fragment (pixel) shader support</li>
<li>visual FXs based on curve combinations</li>
<li>integrated runtime profiler (with graphical display) to easily spot which parts of your game need to be optimized</li>
<li>collision handling and rigid body physics</li>
<li>camera/viewport scheme allowing multiple views displayed with camera translation, zoom and rotation</li>
<li>generic input system that abstracts keyboard, mouse, joystick, touch and accelerometer inputs</li>
<li>powerful localization module</li>
<li>spawners (provides an easy way to create particles or projectiles)</li>
<li>3D positioning using "scene nodes"</li>
<li>custom bitmap font support</li>
<li>automatic differential scrolling and depth scaling upon request</li>
<li>music and spatialized sound support</li>
<li>clock system that provides time consistency and allows time stretching + high precision timers</li>
<li>event manager</li>
<li>unicode support with UTF-8 encoding</li>
<li>plugin system</li>
<li>screenshot capture tool (supports bmp, png, jpg, tga and dds)</li>
</ul>
<p>See <a href="https://orx-project.org/wiki" rel="nofollow">orx's wiki</a> for detailed information, including:</p>
<ul>
<li>initial setup</li>
<li>beginner's guide</li>
<li>tools</li>
<li>samples</li>
<li>detailed tutorials (both official and community-made ones)</li>
</ul>
<p>See the <a href="https://bitbucket.org/orx/orx/src/default/doc/html" rel="nofollow">doc/html</a> directory for the doxygen documentation of orx's API.
The documentation for the latest release version is <a href="https://orx-project.org/orx/doc/html" rel="nofollow">available here</a> at orx's homepage.</p>
<h2>
<a id="user-content-supported-platforms" class="anchor" href="#supported-platforms" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Supported Platforms</h2>
<p>The engine compiles and is tested for:</p>
<ul>
<li>Linux (x86/x86-64 with codelite, codeblocks and GNU makefile)</li>
<li>Windows (x86/x86-64 with vs2015, vs2017 & vs2019, x86/x86-64 mingw-w64 (8.1.0) with codelite, codeblocks and GNU makefile)</li>
<li>MacOS X (x86/x86-64 with xcode or x86/x86-64 with codelite, codeblocks and GNU makefile), version 10.6+</li>
<li>iOS (iPhone/iPod Touch/iPad, simulator & device with xcode)</li>
<li>Android (NDK build files, simulator & device)</li>
</ul>
<h2>
<a id="user-content-versions" class="anchor" href="#versions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Versions</h2>
<p>Those are not revision versions but link/run versions.
Orx library can be compiled as a static or a dynamic library.
In addition to these modes, orx can be compiled as an embedded version or not.</p>
<p>Orx's core is basically platform-independent. All the platform/OS-dependent features
are implemented via plugins. These plugins can be loaded at runtime (hotplug) or
they can be embedded at linktime.</p>
<p>If you use the non-embedded versions, you'll have to specify which plugins to use.
This is more flexible but also requires additional files (the plugins themselves).
The embedded version will store everything in orx's library, meaning you won't be able
to choose which plugin to use at runtime, but will also be more compact. This will
also make orx run considerably faster.</p>
<p>From the download page you'll find precompiled binaries for Windows (x86), Linux (x86/x86-64), MacOS X (ppc/x86/x86-64),
iOS and Android, using the dynamic embedded versions only.
If you want to use the non-embedded versions (to use with your own plugins), you'll need to compile orx yourself from the source.
Everything compiles out-of-the-box for the hardware platforms cited above.</p>
<p>The embedded versions currently use:</p>
<ul>
<li>GLFW-based (+SOIL) plugins for display, joystick, keyboard and mouse for all non-iOS/non-Android platforms</li>
<li>OpenAL-based (+libsndfile/stb_vorbis/tremor) plugins for sound for all platforms</li>
<li>Box2D-based plugin for physics</li>
<li>homemade plugin for 2D rendering</li>
<li>OpenGL ES plugins for display on iOS and Android</li>
<li>Touch/MultiTouch-based plugin for mouse on iOS and Android</li>
<li>Accelerometer-based plugin for joystick on iOS and Android</li>
</ul>
<p>All the 11 basic and advanced official tutorials are shipped with the dev packages, including precompiled release binaries.</p>
<p>Some tools (precompiled binaries only) are also shipped with the dev packages:</p>
<ul>
<li>
<code>orxCrypt</code> : command line tool to encrypt/decrypt/merge multiple config files</li>
<li>
<code>orxFontGen</code>: command line tool (based on FreeType2) to generate custom bitmap fonts (.tga texture & .ini config file) from TrueType fonts</li>
</ul>
<h2>
<a id="user-content-packages" class="anchor" href="#packages" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Packages</h2>
<p>You can download all the packages from <a href="https://orx.sf.net" rel="nofollow">sourceforge</a> or <a href="https://github.com/orx/orx/releases">github</a>.
Here is a list with a small description for each package.</p>
<ul>
<li>
<code>orx-doc-1.10.zip</code> : orx's API doxygen documentation</li>
<li>
<code>orx-src-1.10.zip</code> : orx's source code, ready for compile after running the setup script</li>
<li>
<code>orx-dev-linux32-1.10.tar.bz2</code> : dynamic embedded binaries for Linux (x86), release/profile/debug + tools.</li>
<li>
<code>orx-dev-linux64-1.10.tar.bz2</code> : dynamic embedded binaries for Linux (x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-dev-mac-1.10.zip</code> : dynamic embedded binaries for MacOS X (x86/x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-dev-mingw-32-1.10.zip</code> : dynamic embedded binaries for Windows (mingw/x86), release/profile/debug + tools.</li>
<li>
<code>orx-dev-mingw-64-1.10.zip</code> : dynamic embedded binaries for Windows (mingw/x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2015-32-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2015, x86), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2015-64-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2015, x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2017-32-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2017, x86), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2017-64-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2017, x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2019-32-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2019, x86), release/profile/debug + tools.</li>
<li>
<code>orx-dev-vs2019-64-1.10.zip</code> : dynamic embedded binaries for Windows (Visual Studio 2019, x86-64), release/profile/debug + tools.</li>
<li>
<code>orx-full-ios-1.10.zip</code> : static embedded binaries for iOS, release/profile/debug, simulator/device + doc + source + XCode project file.</li>
<li>
<code>orx-dev-android-1.10.zip</code> : static embedded binaries for Android, release/profile/debug (device).</li>
<li>
<code>orx-dev-android-native-1.10.zip</code> : static embedded binaries for Android Native, release/profile/debug (device).</li>
<li>
<code>orx-tutorial-linux32-1.10.tar.bz2</code> : tutorials for Linux (x86)</li>
<li>
<code>orx-tutorial-linux64-1.10.tar.bz2</code> : tutorials for Linux (x86-64)</li>
<li>
<code>orx-tutorial-mac-1.10.zip</code> : tutorials for MacOS X (x86/x86-64)</li>
<li>
<code>orx-tutorial-mingw-32-1.10.zip</code> : tutorials for Windows (mingw/x86)</li>
<li>
<code>orx-tutorial-mingw-64-1.10.zip</code> : tutorials for Windows (mingw/x86-64)</li>
<li>
<code>orx-tutorial-vs2015-32-1.10.zip</code> : tutorials for Windows (Visual Studio 2015, x86)</li>
<li>
<code>orx-tutorial-vs2015-64-1.10.zip</code> : tutorials for Windows (Visual Studio 2015, x86-64)</li>
<li>
<code>orx-tutorial-vs2017-32-1.10.zip</code> : tutorials for Windows (Visual Studio 2017, x86)</li>
<li>
<code>orx-tutorial-vs2017-64-1.10.zip</code> : tutorials for Windows (Visual Studio 2017, x86-64)</li>
<li>
<code>orx-tutorial-vs2019-32-1.10.zip</code> : tutorials for Windows (Visual Studio 2019, x86)</li>
<li>
<code>orx-tutorial-vs2019-64-1.10.zip</code> : tutorials for Windows (Visual Studio 2019, x86-64)</li>
</ul>
<p>All the <code>*-dev-*</code> packages above include:</p>
<ul>
<li>orx release/profile/debug libraries used for linking</li>
<li>runtime release/profile/debug orx libraries</li>
<li>headers to include at compile time</li>
<li>template files exposing which properties can be accessed using the config system (for user reference only, not needed by orx)</li>
</ul>
<p>All the <code>*-tutorial-*</code> packages above include:</p>
<ul>
<li>heavily commented source code for 11 basic and advanced tutorials</li>
<li>precompiled binaries (orx link library, orx runtime library)</li>
<li>headers to include at compile time</li>
<li>template files exposing which properties can be accessed using the config system (for user reference only, not needed by orx)</li>
<li>build/project files</li>
</ul>
<h2>
<a id="user-content-compiling" class="anchor" href="#compiling" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Compiling</h2>
<h3>Important - first step:</h3>
<p><strong>If you just downloaded the <code>src</code> package or cloned orx with mercurial or git, you will need to run the setup.bat / setup.sh script
that's located at its root before being able to compile the engine.
This script will download all the needed dependencies and generate all the project files for your platform.
The script will then hook itself to mercurial/git and you shouldn't have to run it manually after subsequent pulls.</strong></p>
<p>The easiest way to learn how to compile your project using orx for a given platform
is to look at the tutorial build project files.</p>
<p>NB: The debug version is far slower than the release one, but will output all the warning
and error messages useful during development.</p>
<p>Here's a quick list of the available compile preprocessor flags:</p>
<ul>
<li>
<p><code>__orxDEBUG__</code> : used to compile and link against the debug versions of orx library
(liborxd.a / orxd.lib / liborxd.dylib), if not specified it refers to
the release versions (liborx.a / orx.lib / liborx.dylib).<br>
NB: If you want to link against the debug versions of orx library, you need
to specify it to your compiler!</p>
</li>
<li>
<p><code>__orxPROFILER__</code> : used to enable the profiling push/pop macros for release builds
It's automatically enabled for debug builds and it has been enabled to
build liborxp.a / orxp.lib / orxp.dll / liborxp.dylib / liborxp.so<br>
NB: You can define it in your projects even when using regular release builds,
but you won't be able to see orx's internal profiling markers!</p>
</li>
<li>
<p><code>__orxSTATIC__</code> : used to compile and link against the static versions of orx library.<br>
NB: If you want to link against the static versions of orx library, you need
to specify it to your compiler!</p>
</li>
<li>
<p><code>__orxEMBEDDED__</code> : used to compile the embedded versions of orx library.<br>
NB: this flag is <em>ONLY</em> needed when compiling orx library, not when linking
against it.</p>
</li>
</ul>
<p>There are other preprocessor flags used when compiling the orx library,
but those should be easy enough to decipher. markdo
However, you might want to specify them manually for cross-compiling or
use them so that your code will behave differently depending on the architecture
for which you're compiling. Here's a quick list of these flags:</p>
<table>
<thead>
<tr>
<th align="center">Flag</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><code>__orxARM__</code></td>
<td>orx is being compiled for an ARM architecture</td>
</tr>
<tr>
<td align="center"><code>__orxPPC__</code></td>
<td>orx is being compiled for a PowerPC architecture</td>
</tr>
<tr>
<td align="center"><code>__orxPPC64__</code></td>
<td>orx is being compiled for a PowerPC 64 architecture</td>
</tr>
<tr>
<td align="center"><code>__orxX86__</code></td>
<td>orx is being compiled for a x86 architecture</td>
</tr>
<tr>
<td align="center"><code>__orxX86_64__</code></td>
<td>orx is being compiled for a x86-64 architecture</td>
</tr>
<tr>
<td align="center"><code>__orxLITTLE_ENDIAN__</code></td>
<td>orx is being compiled for a little endian architecture</td>
</tr>
<tr>
<td align="center"><code>__orxBIG_ENDIAN__</code></td>
<td>orx is being compiled for a big endian architecture</td>
</tr>
<tr>
<td align="center"><code>__orxGCC__</code></td>
<td>orx is being compiled with gcc</td>
</tr>
<tr>
<td align="center"><code>__orxMSVC__</code></td>
<td>orx is being compiled with visual studio C/C++</td>
</tr>
<tr>
<td align="center"><code>__orxLLVM__</code></td>
<td>orx is being compiled with llvm/clang</td>
</tr>