Mercurial > molko
annotate README.md @ 510:21d2c66f3521
core: doxygenize alloc
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 04 Mar 2023 10:06:07 +0100 |
parents | e1fa1b867281 |
children | e070fdcc592b |
rev | line source |
---|---|
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
1 Molko's Engine |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
2 ============== |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
3 |
414
6947c1fefe5c
misc: extreme cleanup
David Demelier <markand@malikania.fr>
parents:
366
diff
changeset
|
4 The Molko's Engine is a C and framework to write 2D RPG games in a portable |
6947c1fefe5c
misc: extreme cleanup
David Demelier <markand@malikania.fr>
parents:
366
diff
changeset
|
5 manner. It is designed in mind to be flexible, simple and convenient to use. |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
6 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
7 It has the following features: |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
8 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
9 - Written in C99, |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
10 - Portable (Windows, macOS and UNIX likes systems), |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
11 - Simple, flexible, |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
12 - Well documented, |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
13 - Virtual file system support. |
447 | 14 - Usable in both C or Javascript. |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
15 - Can embed resources using `mlk-bcc`. |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
16 |
447 | 17 Javascript quick startup |
18 ------------------------ | |
19 | |
20 The `mlk-run` executable exposes the Javascript API and start a game from a | |
21 directory or a .mlk file (which is a .zip file with a .mlk extension). | |
22 | |
23 Hello world in Javascript: | |
24 | |
25 mkdir superluigi | |
26 | |
27 Add the following content in superluigi/main.js: | |
28 | |
29 ```js | |
30 var w = new Window("Super Luigi, number one", 640, 480); | |
31 var run = true; | |
32 | |
33 while (run) { | |
34 var ev; | |
35 | |
36 while ((ev = Event.poll())) { | |
37 switch (ev.type) { | |
38 case Event.Type.QUIT: | |
39 run = false; | |
40 break; | |
41 default: | |
42 break; | |
43 } | |
44 | |
45 Painter.color = 0xFFFFFFFF; | |
46 Painter.clear(); | |
47 Painter.present(); | |
48 } | |
49 } | |
50 ``` | |
51 | |
52 Finally run the game using `mlk-run superluigi`. | |
53 | |
54 You can also create a .zip file with a .mlk extension and `mlk-run` will be able | |
55 to use content from it. | |
56 | |
57 cd superluigi | |
58 zip -r ../superluigi.mlk . | |
59 cd .. | |
60 mlk-run superluigi.mlk | |
61 | |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
62 Documentation |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
63 ------------- |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
64 |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
65 Use `mkdocs serve` inside the **doc** directory to see the user and developer |
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
66 documentation. |
13
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 Author |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 ------ |
c188e9603faf
misc: add basic documentation files
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 |
366
19782ea1cf4a
misc: start rebranding
David Demelier <markand@malikania.fr>
parents:
326
diff
changeset
|
71 Molko's Engine was written by David Demelier <markand@malikania.fr>. |