Mercurial > malikania

annotate docs/overview.md @ 115:07cb0d9f92e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: add development overview
author David Demelier <markand@malikania.fr>
date Mon, 11 Sep 2017 16:26:35 +0200
parents
children 835c8ee3f9e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
115
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 Malikania overview
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 ==================
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 This memo is a simple overview about the Malikania Engine architecture.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 Dependency overview
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 -------------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 This is the main targets and their dependencies.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 ````nohighlight
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 +-------------------+ | mlk-client |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 | | | mlk-map |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 | mlk-server | | mlk-tileset |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 | | | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 +-------------------+ +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 +-------------------+ +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 | | | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 | libmlk-server-js | | libmlk-client-js |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 | | | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 +-------------------+ +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 +-------------------+ +-------------------+ +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 | | | | | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 | libmlk-server | | libmlk-client | | mlk-bcc |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 | | | | | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 +-------------------+ +-------------------+ +-------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 +---------------------------------------------------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 | libmlk-common |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 | |
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 +---------------------------------------------------------------+
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 ````
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 libmlk-common
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 -------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 This library contains many utilities that can be used in both server and client
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 targets.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 This library does not depend on client or server code at all.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 libmlk-server
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 -------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 This library contains anything you need to develop a server running your game,
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 it does not depends on anything graphical and can safely be used on headless
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 machine.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 libmlk-client
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 -------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 This library contains graphical modules to develop a rich client. It depends on
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 a graphical backend (mostly SDL) and all of what is needed to make a whole
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 client (graphics, audio, fonts and such).
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 libmlk-server-js and libmlk-client-js
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 -------------------------------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 These libraries are the official Javascript bindings for their respectives
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 homonyms.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 mlk-server and mlk-client
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 -------------------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 These executables are written upon libmlk-server-js and libmlk-client-js
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 respectively, they are able to run games written in Javascript.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 mlk-bcc
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 -------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
75
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 The `mlk-bcc` tool is a very basic resource compiler, it transforms any input
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 data as C++ byte array.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
78
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 mlk-tileset and mlk-map
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 -----------------------
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
81
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 These two executables are required to transform maps and tileset created with
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 the [tiled][link-tiled] map editor.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
84
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 They are only used by the client.
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
07cb0d9f92e9 Docs: add development overview
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 [link-tiled]: http://www.mapeditor.org