Variable name fix + structure creation unrolling in lighting code
[oweals/minetest.git] / doc / README.android
1 Minetest Android port
2 =====================
3 Date: 2014 06 28
4
5 Controls
6 --------
7 The Android port doesn't support everything you can do on PC due to the
8 limited capabilities of common devices. What can be done is described
9 below:
10
11 While you're playing the game normally (that is, no menu or inventory is
12 shown), the following controls are available:
13 * Look around: touch screen and slide finger
14 * double tap: place a node or use selected item
15 * long tap: dig node
16 * touch shown buttons: press button
17 * Buttons:
18 ** left upper corner: chat
19 ** right lower corner: jump
20 ** right lower corner: crouch
21 ** left lower corner: walk/step...
22    left up right
23        down
24 ** left lower corner: display inventory
25
26 When a menu or inventory is displayed:
27 * double tap outside menu area: close menu
28 * tap on an item stack: select that stack
29 * tap on an empty slot: if you selected a stack already, that stack is placed here
30 * drag and drop: touch stack and hold finger down, move the stack to another
31   slot, tap another finger while keeping first finger on screen
32   --> places a single item from dragged stack into current (first touched) slot
33
34 Special settings
35 ----------------
36 There are some settings especially useful for Android users. Minetest's config
37 file can usually be found at /mnt/sdcard/Minetest.
38
39 * gui_scaling: this is a user-specified scaling factor for the GUI- In case
40                main menu is too big or small on your device, try changing this
41                value.
42 * inventory_image_hack: if your inventory items are messed up, try setting
43                this to true
44
45 Known issues
46 ------------
47 Not all issues are fixed by now:
48
49 * Unable to exit from volume menu -- don't use the volume menu, use Android's
50   volume controls instead.
51 * 512 MB RAM seems to be inadequate -- this depends on the server you join.
52   Try to play on more lightweight servers.
53
54 Versioning
55 ----------
56 Android version numbers are 4 digits instead of Minetest's 3 digits.  The last
57 number of Android's version represents the Android internal version code. This
58 version code is strictly incremental. It's incremented for each official
59 Minetest Android build.
60
61 E.g. prerelease Minetest Android builds have been 0.4.9.3, while the first
62 official version most likely will be 0.4.10.4
63
64 Requirements
65 ------------
66
67 In order to build, your PC has to be set up to build Minetest in the usual
68 manner (see the regular Minetest documentation for how to get this done).
69 In addition to what is required for Minetest in general, you will need the
70 following software packages. The version number in parenthesis denotes the
71 version that was tested at the time this README was drafted; newer/older
72 versions may or may not work.
73
74 * android SDK (x86_64 20131030)
75 * android NDK (r9d)
76 * wget (1.13.4)
77
78 Additionally, you'll need to have an Internet connection available on the
79 build system, as the Android build will download some source packages.
80
81 Build
82 -----
83
84 Debug build:
85 * Enter "build/android" subdirectory
86 * Execute "make"
87 * Answer the questions about where SDK and NDK are located on your filesystem
88 * Wait for build to finish
89
90 After the build is finished, the resulting apk can be fond in
91 build/android/bin/. It will be called Minetest-debug.apk
92
93 Release build:
94
95 * In order to make a release build you'll have to have a keystore setup to sign
96   the resulting apk package. How this is done is not part of this README. There
97   are different tutorials on the web explaining how to do it
98   - choose one yourself.
99
100 * Once your keystore is setup, enter build/android subdirectory and create a new
101   file "ant.properties" there. Add following lines to that file:
102   
103   > key.store=<path to your keystore>
104   > key.alias=Minetest
105
106 * Execute "make release"
107 * Enter your keystore as well as your Mintest key password once asked. Be
108   careful it's shown on console in clear text!
109 * The result can be found at "bin/Minetest-release.apk"
110
111 Other things that may be nice to know
112 ------------
113 * The environment for Android development tools is saved within Android build
114   build folder. If you want direct access to it do:
115   
116   > make envpaths
117   > . and_env
118   
119   After you've done this you'll have your path and path variables set correct
120   to use adb and all other Android development tools
121
122 * You can build a single dependency by calling make and the dependency's name,
123   e.g.:
124
125   > make irrlicht
126
127 * You can completely cleanup a dependency by calling make and the "clean" target,
128   e.g.:
129
130   > make clean_irrlicht