Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More Replacement #89

Merged
merged 23 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
f5f7eae
Initial Commit.
Armored-Dragon Jun 25, 2024
26be09e
Hover effects.
Armored-Dragon Jun 26, 2024
a616785
More hover effects.
Armored-Dragon Jun 26, 2024
63594a4
Added navigation page.
Armored-Dragon Jun 27, 2024
367b0c2
Added "Installed Apps" view.
Armored-Dragon Jun 27, 2024
9be42b0
Fix missing onScreenChanged event listener.
Armored-Dragon Jun 29, 2024
71819cc
Community-apps support.
Armored-Dragon Jul 18, 2024
ad2b9c0
Fix app description overflow on details page.
Armored-Dragon Jul 18, 2024
9d62db7
Documentation.
Armored-Dragon Jul 18, 2024
03cd963
Merge branch 'overte-org:master' into More-Replacement
Armored-Dragon Jul 18, 2024
947787f
Install Overte Community Apps by default.
Armored-Dragon Jul 19, 2024
dec7739
Changed variables to Camel Case.
Armored-Dragon Jul 19, 2024
33b71d6
Fix TextWrapping causing undefined error.
Armored-Dragon Jul 19, 2024
f2c276e
Removed bottom padding.
Armored-Dragon Jul 19, 2024
fb96779
Update base_url of Overte Community Apps.
Armored-Dragon Jul 19, 2024
a65f112
Duplication check on installing repositories.
Armored-Dragon Jul 19, 2024
709b55d
Improved legacy repo support.
Armored-Dragon Aug 28, 2024
11611ba
Unfocus selected index on list clear.
Armored-Dragon Aug 28, 2024
574f6b6
Fixed search width issue.
Armored-Dragon Aug 28, 2024
77bdd9d
Fix app search.
Armored-Dragon Aug 28, 2024
2d8e00d
Removed dead code.
Armored-Dragon Aug 28, 2024
7864f77
Refactor message handler.
Armored-Dragon Aug 28, 2024
1b8223c
Changed icon.
Armored-Dragon Aug 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions applications/metadata.js
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,15 @@ var metadata = { "applications":
"icon": "domainMapper/icon_inactive_white.png",
"caption": "DOMAP"
},
{
"isActive": true,
"directory": "more",
"name": "MoreNG",
"description": "More app rewrite in QML. Please see documentation https://github.com/overte-org/community-apps/tree/master/applications/more for more information",
"jsfile": "more/more.js",
"icon": "more/img/icon_white.png",
"caption": "MORE-NG"
},
{
"isActive": true,
"directory": "hmd3rdPerson",
Expand Down
69 changes: 69 additions & 0 deletions applications/more/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# More
1. What is More
2. User manual
- Installation
- Adding Repositories
- Usability tips
3. Development
- How to create your own repository

## What is More
More is an application that allows users to quickly install additional applications hosted from online repositories.

## User Manual
### Installation
**Recommended method**:

To install this application, visit the pre-installed More application provided inside of Overte.

Inside of the pre installed More application, search for the app that is also called "More".
Click the "Install" button and the More application will be installed.
You will also need to add the url Add `https://raw.githubusercontent.com/overte-org/community-apps/master/applications/more/more.qml` to the QML whitelist manually.

**Alternative**:

You can install More manually by following these instructions:
1. In Interface, go to Edit > Running Scripts.
2. Load the script url: `https://raw.githubusercontent.com/overte-org/community-apps/master/applications/more/more.js`
3. Add `https://raw.githubusercontent.com/overte-org/community-apps/master/applications/more/more.qml` to the QML whitelist.

### Adding Repositories
To add a repository, navigate to the application menu by pressing the top right most button with the hamburger icon.
From there, click the section labeled "Repository Manager". In the text field labeled "Add a manifest.json url", paste in a url that provides a manifest json object.
As an example, if you wanted to provide a url to a manifest file hosted on GitHub, you would paste in something along the lines of `https://raw.githubusercontent.com/user/respository/manifest.json`.
After the url is in the text field, press the green plus button to add the repository to the list. Do note that this app does attempt to verify repositories when they are added. If you find that your repository can not be added successfully, ensure the repository is of the correct format. Also make sure that the url you are providing is correct.
If you are a repository host, ensure that your repository is set up correctly.


### Usability Tips
TODO

## Development
### How to create your own repository
#### Github
To turn a GitHub repository into a Overte repository provider, you need to make your GitHub repository a "[GitHub Pages](https://pages.github.com/)" repository.
The defaults provided by GitHub will be sufficient for this use case. Select the root of the repository as the GitHub Pages root.
After you have ensured that your repository is set up correctly, you can add the `manifest.json` file to the root of your repository.

This is the format to use:
```json
{
"title": "My GitHub Repository", // This is the name that will show up in the repository manager
"base_url": "https://raw.githubusercontent.com/myuser/myrepository", // This is what the More app uses as a base to search for applications provided by the 'applications' key just below this entry.

// This is the list of all applications this repository will provide to the More app.
"applications": [
{
"name": "My App", // The name of the application to display.
"directory": "myapp", // The directory of the application relative to the 'base_url'. This will be interpreted as 'https://raw.githubusercontent.com/myuser/myrepository/myapp' internally.
"script": "myapp.js", // The entry script of the application.
"icon": "icon.png", // The icon of the application to show in the list.
"description": "This is my first application! Download this please." // The description of the application to display in the "details" page.
},
/// ...and other applications
]
}
```

#### HTTPS Servers
To provide the applications from a standard HTTPS server, the procedure is largely the same as with GitHub. You simply need to provide a JSON response that is in the same format as the above "GitHub" format.
Binary file added applications/more/img/icon_black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added applications/more/img/icon_white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions applications/more/menu.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading