doc/README.android

   1 Minetest: Android version
   2 =========================
   3
   4 Controls
   5 --------
   6 The Android port doesn't support everything you can do on PC due to the
   7 limited capabilities of common devices. What can be done is described
   8 below:
   9
  10 While you're playing the game normally (that is, no menu or inventory is
  11 shown), the following controls are available:
  12 * Look around: touch screen and slide finger
  13 * double tap: place a node or use selected item
  14 * long tap: dig node
  15 * touch shown buttons: press button
  16 * Buttons:
  17 ** left upper corner: chat
  18 ** right lower corner: jump
  19 ** right lower corner: crouch
  20 ** left lower corner: walk/step...
  21    left up right
  22        down
  23 ** left lower corner: display inventory
  24
  25 When a menu or inventory is displayed:
  26 * double tap outside menu area: close menu
  27 * tap on an item stack: select that stack
  28 * tap on an empty slot: if you selected a stack already, that stack is placed here
  29 * drag and drop: touch stack and hold finger down, move the stack to another
  30   slot, tap another finger while keeping first finger on screen
  31   --> places a single item from dragged stack into current (first touched) slot
  32
  33 Special settings
  34 ----------------
  35 There are some settings especially useful for Android users. Minetest's config
  36 file can usually be found at /mnt/sdcard/Minetest.
  37
  38 * gui_scaling: this is a user-specified scaling factor for the GUI- In case
  39                main menu is too big or small on your device, try changing this
  40                value.
  41
  42 Requirements
  43 ------------
  44
  45 In order to build, your PC has to be set up to build Minetest in the usual
  46 manner (see the regular Minetest documentation for how to get this done).
  47 In addition to what is required for Minetest in general, you will need the
  48 following software packages. The version number in parenthesis denotes the
  49 version that was tested at the time this README was drafted; newer/older
  50 versions may or may not work.
  51
  52 * Android SDK 29
  53 * Android NDK r21
  54 * Android Studio 3 [optional]
  55
  56 Additionally, you'll need to have an Internet connection available on the
  57 build system, as the Android build will download some source packages.
  58
  59 Build
  60 -----
  61
  62 The new build system Minetest Android is fully functional and is designed to
  63 speed up and simplify the work, as well as adding the possibility of
  64 cross-platform build.
  65 You can use `./gradlew assemblerelease` or `./gradlew assembledebug` from the
  66 command line or use Android Studio and click the build button.
  67
  68 When using gradlew, the newest NDK will be downloaded and installed
  69 automatically. Or you can create a `local.properties` file and specify
  70 `sdk.dir` and `ndk.dir` yourself.
  71
  72 * In order to make a release build you'll have to have a keystore setup to sign
  73   the resulting apk package. How this is done is not part of this README. There
  74   are different tutorials on the web explaining how to do it
  75   - choose one yourself.
  76
  77 * Once your keystore is setup, enter the android subdirectory and create a new
  78   file "ant.properties" there. Add following lines to that file:
  79
  80   > key.store=<path to your keystore>
  81   > key.alias=Minetest