HooverHigh/QuestAppLauncher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Updated readme

Browse Source
This commit is contained in:
tverona1
2019-09-14 18:59:24 -07:00
committed by GitHub
parent 41d3092a9b
commit a022a0c4ad
1 changed files with 73 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+73 -45
View File
@@ -10,6 +10,8 @@ An app launcher for Quest implemented in Unity.
* Support for resizable grid
* Support for downloading app icons and names, including auto-updating
* Support for sorting alphabetically or by most recently used
* Support for renaming apps
* Support for custom 360/cubemap 3D backgrounds
## Getting Started
@@ -25,14 +27,34 @@ There are various options available in Settings. These are:
* Sort By: Whether to sort alphabetically or most recent.
* Show 2D: Whether to show 2D apps.
* Grid Size: How many columns & rows to display.
* Background: Pick a custom 3D background (see below).
* Auto Update & Update Now: Whether to auto-update app icons & names and whether to update these now -- see above.
* Reset Hidden Apps: This setting un-hides any hidden apps. (To hide an app, highlight the app on the grid and press either the A or Y button on your controller.)
* Reset Hidden Apps: This setting un-hides any hidden apps. See below regarding hiding apps.
* Reset Renamed Apps: This setting changes app names back to their default. See below regarding renaming apps.
## Advanced Features
The below sections described advanced / custom features.
## Other Features
### Custom 3D Backgrounds
Customer 3D background images are supported. Both 360 degree (equirectangular) and 6-side (cubemap) images are supported. This is automatically detected based on aspect ratio (with cubemap having 4:3 aspect ratio).
To set up custom 3D backgrounds:
1. Copy your background images (either jpg or png) to the following location on your Quest: **Android/data/aaa.QuestAppLauncher.App/files/backgrounds**
2. In "Settings", select the custom background.
Note: Whether an image is 360 degree or cubemap images is automatically detected based on aspect ratio (with cubemap having 4:3 aspect ratio). Here's an example of a cubemap image: https://en.wikipedia.org/wiki/Skybox_(video_games)#/media/File:Skybox_example.png
### Hiding Apps
If there is an app that you would like to hide, highlight the app and press either the B or Y button on your controller. You can reset any hidden apps in Settings.
### Renaming Apps
To rename an app (i.e. to pick a different app name / icon for it), highlight the app and press either A or X on the controller. This will show a list of apps from you can choose an alternate app name / icon. You can reset these changes back to default in Settings.
Note: It is recommended that you download the app names / icon packs first (see above) in order to populate a full list of app to choose from.
## Manually configuring the launcher (for advanced users only)
The below sections described ways to manuallyze configure the launcher. This is intended for advanced users only and is typically not necessary, as everything is supported via the Settings UI within the app.
### Manually overriding app icons and names
It is also possible to manually configure app icons and names rather than automatically downloading them. This section describes how.
It is possible to manually configure app icons and names rather than automatically downloading them. This section describes how.
#### Override app names
Create a file called **appnames.json**. Add an entry with package-id as key and the desired name. Example:
@@ -47,6 +69,23 @@ Note: Multiple appnames*.json files are supported. If multiple files are present
Note: Text format is also supported. See below.
#### Appnames.json syntax
This section describes the syntax for appnames.json. The syntax for these entries are as follows:
"com.mycompany.myapp":{"name": "My Application"}
#### Custom Categories (Tabs)
The launcher supports custom categories (tabs). This can be specified in the **appnames.json** file by adding up to two custom categories per entry. The syntax is:
"com.mycompany.myapp":{"name": "My Application", "category": "Action", "category2" : "Puzzle"}
The above example will categorize the two entries below in Action and Puzzle tabs:
#### Appnames.txt syntax
Alternatively, txt format is also supported for appnames instead of json. The syntax is:
packageName,appName[,category1[, category2]]
Comments can be added to appnames.txt by prepending "#".
#### Override app icons
Create an iconpack.zip file that contains a jpg file per app with the package-id as the filename. Example:
com.mycompany.myapp.jpg
@@ -58,37 +97,10 @@ Note: Multiple iconpack*.zip files are supported. If multiple files are present,
Note: Individual jpg files are also supported at the /Android/data/aaa.QuestAppLauncher.app/files path. These override any corresponding jpgs in iconpack*.zip files.
### Configuration
The launcher can be customized by creating a **config.json** file and copying it to the following location on your Quest: Android/data/aaa.QuestAppLauncher.App/files.
### config.json: Configuration file
The launcher can be customized by creating a **config.json** file and copying it to the following location on your Quest: Android/data/aaa.QuestAppLauncher.App/files. Note: These configuration options are accessible via the Settings UI, so typically you would not need to manually configure this file.
The following options are supported:
#### Categories (tabs)
By default, the launcher will display automatic tabs (Quest, Go/GrearVr and 2D) and any custom tabs specified in appnames.txt file. These can be overridden with two fields - "autoCategory" and "customCategory". Both fields support the following values:
"off": No not display the categories
"top": Display categories on top
"left": Display categories on left-side
"right": Display categories on right-side
#### Setting Grid Size
The default grid size is 3x3 cells. The grid size can be customized by specifying grid rows and columns as in the following example:
```
{
"gridSize": {
"rows": 2,
"cols": 4
}
}
```
#### Sort By
Whether to sort apps alphabetically or by most recently used. Key is "sortMode" and valid values are "az" (default) or "mostRecent".
#### Showing / Hiding 2D apps
To show or hide 2D apps, set the "show2D" field to true (default) or false.
#### Example config.json
#### Format of config.json
Here's an example config.json:
```
@@ -102,6 +114,7 @@ Here's an example config.json:
"autoCategory": "top",
"customCategory": "right"
"autoUpdate": true,
"background": "backgrounds/my_background_360.jpg",
"downloadRepos": [
{
"repoUri": "tverona1/QuestAppLauncher_Assets/releases/latest",
@@ -111,22 +124,37 @@ Here's an example config.json:
}
```
### Appnames.json syntax
This section describes the syntax for appnames.json. The syntax for these entries are as follows:
#### gridSize: Setting Grid Size
The default grid size is 3x3 cells. The grid size can be customized by specifying grid rows and columns as in the following example:
"com.mycompany.myapp":{"name": "My Application"}
```
{
"gridSize": {
"rows": 2,
"cols": 4
}
}
```
#### Custom Categories (Tabs)
The launcher supports custom categories (tabs). This can be specified in the **appnames.json** file by adding up to two custom categories per entry. The syntax is:
"com.mycompany.myapp":{"name": "My Application", "category": "Action", "category2" : "Puzzle"}
#### sortMode: Sorting order
Whether to sort apps alphabetically or by most recently used. Key is "sortMode" and valid values are "az" (default) or "mostRecent".
The above example will categorize the two entries below in Action and Puzzle tabs:
#### show2D: Showing / Hiding 2D apps
To show or hide 2D apps, set the "show2D" field to true (default) or false.
### Appnames.txt syntax
Alternatively, txt format is also supported for appnames instead of json. The syntax is:
packageName,appName[,category1[, category2]]
#### autoCategory and customCategory
By default, the launcher will display automatic tabs (Quest, Go/GrearVr and 2D) and any custom tabs specified in appnames.txt file. These can be overridden with two fields - "autoCategory" and "customCategory". Both fields support the following values:
Comments can be added to appnames.txt by prepending "#".
"off": No not display the categories
"top": Display categories on top
"left": Display categories on left-side
"right": Display categories on right-side
#### autoUpdate and downloadRepos
To enable automatic updating of new app icons and names, set autoUpdate to true. downloadRepos lists the repos from which to download. FOr now, we only support github repos.
#### background
The "background" field specifies a relative path to use as a custom 3D background. See earlier section on custom backgrounds.
## Source structure:
- Assets/Scenes/QuestAppLauncher.unity: The main scene