3
3
Launcher
4
4
========
5
5
6
- .. note ::
7
-
8
- This form of packaging creates an APK that allows quick and dirty testing
9
- of your android applications. Do not use in production!
10
-
11
- .. warning ::
12
-
13
- Using the launcher in production gives the end-user easy access to your
14
- source code.
15
-
16
6
The Kivy Launcher is an Android application that can run any Kivy app
17
7
stored in `kivy ` folder on SD Card. You can download the latest stable
18
8
version for your android device from the
19
9
`Play Store <https://play.google.com/store/apps/details?id=org.kivy.pygame >`_.
20
10
21
- The stable launcher comes with various packages usually listed in the
22
- description in the store. Those aren't always enough for an application to run
23
- or even launch if you work with other dependencies that are not packaged.
24
-
25
- Permissions
26
- -----------
27
-
28
- The stable launcher has these permissions:
11
+ The stable launcher comes with various Python packages and
12
+ permissions, usually listed in the description in the store. Those
13
+ aren't always enough for an application to run or even launch if you
14
+ work with other dependencies that are not packaged.
29
15
30
- - ACCESS_COARSE_LOCATION
31
- - ACCESS_FINE_LOCATION
32
- - BLUETOOTH
33
- - INTERNET
34
- - READ_EXTERNAL_STORAGE
35
- - RECORD_AUDIO
36
- - VIBRATE
37
- - WRITE_EXTERNAL_STORAGE
38
-
39
- .. |perm_docs | replace :: android documentation
40
-
41
- .. _perm_docs :
42
- https://developer.android.com/guide/topics/security/permissions.html
43
-
44
- Check the other available permissions in the |perm_docs |_.
45
-
46
- Packages
47
- --------
48
-
49
- The launcher by default provides access to these packages:
50
-
51
- - audiostream
52
- - cymunk
53
- - docutils
54
- - ffmpeg
55
- - kivy
56
- - lxml
57
- - openssl
58
- - pil
59
- - plyer
60
- - pygments
61
- - pyjnius
62
- - pyopenssl
63
- - sqlite3
64
- - twisted
16
+ The Kivy Launcher is intended for quick and simple testing, for
17
+ anything more advanced we recommend building your own APK with
18
+ python-for-android.
65
19
66
20
Building
67
21
--------
68
22
69
- To keep up with the most recent Kivy and be able to run more than one app
70
- without building over and over a launcher with kivy `master ` branch together
71
- with additional packager most of your apps use are necessary. To build it
72
- you'll need pygame bootstrap (launcher is not available in sdl2 yet). To get
73
- the most recent versions of packages you need to clean them first, so that
74
- the packager won't grab an old package instead of fresh one.
23
+ The Kivy Launcher is built using python-for-android, and is currently
24
+ only supported by the pygame bootstrap (there is no SDL2 launcher
25
+ yet). To get the most recent versions of packages you need to clean
26
+ them first, so that the packager won't grab an old package instead of
27
+ fresh one.
75
28
76
29
.. highlight :: none
77
30
@@ -100,45 +53,39 @@ the packager won't grab an old package instead of fresh one.
100
53
adding `main.py ` or `main.pyo ` to the app. The argument `--launcher ` is
101
54
above them and tells the p4a to build the launcher version of the APK.
102
55
103
- The power of the launcher is in its capability to run multiple apps from
104
- source, which means the more packages you include, the more stable your
105
- installation will be and the less times you'll need to update it or do anything
106
- else with it except running apps. The necessary stuff is about 6 - 8MB big and
107
- additional packages won't increase the size that much, which is definitelly
108
- an advantage if there are more than two apps for testing.
109
-
110
56
Usage
111
57
-----
112
58
113
- Once the launcher is installed, you need to create a folder on your sdcard
114
- (` /sdcard/kivy `). Each new folder inside ` kivy ` represents a separate
115
- application.
116
-
117
- ::
59
+ Once the launcher is installed, you need to create a folder in your
60
+ external storage directory (e.g. `` /storage/emulated/0 `` or
61
+ `` /sdcard ``) - this is normally your 'home' directory in a file
62
+ browser. Each new folder inside ` kivy ` represents a
63
+ separate application ::
118
64
119
65
/sdcard/kivy/<yourapplication>
120
66
121
- To tell the launcher to even see your application you have to have
122
- `android.txt ` file in your app's folder . The file has to contain three basic
67
+ Each application folder must contain an
68
+ `android.txt ` file. The file has to contain three basic
123
69
lines::
124
70
125
71
title=<Application Title>
126
72
author=<Your Name>
127
73
orientation=<portrait|landscape>
128
74
129
- The file is editable so you can change for example orientation or name. You
130
- aren't allowed to change permissions however, so before building the launcher
131
- decide carefully what permissions do you need.
75
+ The file is editable so you can change for example orientation or
76
+ name. These are the only options dynamically configurable here,
77
+ although when the app runs you can call the Android API with PyJNIus
78
+ to change other settings.
132
79
133
- After you set your `android.txt ` file, you can now run the launcher and start
134
- any available app from the list.
80
+ After you set your `android.txt ` file, you can now run the launcher
81
+ and start any available app from the list.
135
82
136
83
Release on the market
137
84
---------------------
138
85
139
- Launcher is released on Google Play with each new Kivy stable branch. Master
140
- branch is not suitable for a regular user because it changes quickly and needs
141
- testing.
86
+ Launcher is released on Google Play with each new Kivy stable
87
+ branch. The master branch is not suitable for a regular user because
88
+ it changes quickly and needs testing.
142
89
143
90
Source code
144
91
-----------
@@ -150,5 +97,4 @@ Source code
150
97
pythonforandroid/bootstraps/pygame/build/src/org/renpy/android
151
98
152
99
If you feel confident, feel free to improve the launcher. You can find the
153
- source code at |renpy |_. Change the link if you want to contribute to other
154
- than pygame bootstrap.
100
+ source code at |renpy |_.
0 commit comments