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.

Sign up for GitHub

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

Update add-app.md #28

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update add-app.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 4 additions & 31 deletions docs/Store/add-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,18 @@
# Add an App

First, please make sure the site accepts IFrame. You can check this by inserting the sites URL into this: [IFrame checker](https://www.tinywebgallery.com/blog/advanced-iframe/free-iframe-checker)

## Ways to add an app to the store

### Using Github issues

Create an [Issue](https://github.com/win11react/store/issues/new/choose) and follow the given steps.

### Via Github Pull Request

Make a pull request by editing the [store.json](https://github.com/win11react/store/blob/main/store/index.json) file

Read the schema below, **BEFORE** adding any game/app element into the `store.json` file:

```json
{
"name": "Minecraft", // unique name (check if it has been used already in the file)
"name": "Minecraft Java", // unique name (check if it has been used already in the file)
"icon": "https://example.com/minecraft.png", // logo image, preferrably 1:1 and less than 128px of width
"type": "game", // game or app
"data": {
"type": "IFrame", // type currently supports IFrame only
"url": "https://classic.minecraft.net", // url of the app and make sure they accept Iframe
"url": "https://bongocraft.cf", // url of the app and make sure they accept Iframe
"gallery": [
// three or more images for gallery view in store app
"https://www.minecraft.net/content/dam/games/minecraft/key-art/CavesandCliffsPt1-dotNET-HomepagePromo-600x360.png",
"https://variety.com/wp-content/uploads/2019/02/minecraft-best-year-yet.png?w=600",
"https://www.minecraft.net/content/dam/games/minecraft/screenshots/RayTracing-MineCraft-PMP-Always-Something-New.jpg"
],
"desc": "Minecraft is a sandbox construction video game ...", // description for store app
"feat": "1.1 Combat changes.\n1.2 Fletching table functionality.", // features for store app
"desc": "Minecraft Java For Free !", // description for store app
"feat": "Minecraft 1.5.2 Full Edition included with servers", // features for store app
"invert": true // when true it forces dark theme for game/app window, default is false.
}
}
```

:::caution
### PLEASE REMOVE THE COMMENTS FROM YOUR JSON, BEFORE MAKING A PULL REQUEST
**Comments look like this: `// example text`**

:::


Add your game/app in the file (don't beautify the code, just add your game/app element) and make a pull request to get it **potentially** accepted.