Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DerGoogler committed Jul 6, 2023
1 parent 516d52e commit 69a3551
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 135 deletions.
41 changes: 0 additions & 41 deletions DEV.md

This file was deleted.

65 changes: 8 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,34 @@ Magisk Module Repo Loader (MMRL). Allows you to load custom repos with an simple
[![CodeQL](https://github.com/DerGoogler/MMRL/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/DerGoogler/MMRL/actions/workflows/codeql-analysis.yml)
[![Android CI](https://github.com/DerGoogler/MMRL/actions/workflows/android.yml/badge.svg)](https://github.com/DerGoogler/MMRL/actions/workflows/android.yml)

## How to create custom repo?

Use [this](https://dergoogler.com/repo-generator/) service to create a custom repository.

## What MMRL Supports (Roadmap)

- [x] Custom repo loading (Since 1.4.2 mutiple repositories are supported)
- [x] Translation
- [x] Dark mode
- [x] Themes
- [ ] Favorite lists

#### Android only
### Android only

- [x] View installed modules
- [x] Remove installed modules
- [x] Enable/Disable installed modules
- [ ] Module install
- [ ] Monet theming
- [x] Monet theming

## Screenshots

<table>
<tr>
<td><img src="https://user-images.githubusercontent.com/54764558/170883584-008e135e-09d3-4c5f-9780-9d963b70205f.png"/>
<td><img src="https://user-images.githubusercontent.com/54764558/170883624-b564a344-7f6a-4a94-8494-3ca6b7e6a311.png"/>
<td><img src="assets/screen1.jpg" width="250" />
<td><img src="assets/screen2.jpg" width="250"/>
<tr>
</table>

## Supported `module.json` syntax

**MMRL** new default

> **Note** > `prop_url` can also used as fallback
> **Note** > `prop_url` should always an string otherwise MMRL can't manipulate it.
```json
{
Expand All @@ -54,47 +49,7 @@ Use [this](https://dergoogler.com/repo-generator/) service to create a custom re
"last_update": 1654181061000,
"prop_url": "https://.../module.prop",
"zip_url": "https://.../master.zip",
"notes_url": "https://.../README.md",
"props": {
"id": "samsung_a70_raven_prop_overlay",
"name": "Samsung Galaxy A70 Overlay",
"author": "Der_Googler",
"version": "2022-05-22",
"versionCode": "2205-22",
"description": "Spoof your device to RAVEN pixel prop (April 2022) with an generared overlay for Samsung Galaxy A70 (GSI's only). Prop original made by Tesla",
"foxprops": {
"minApi": "31",
"maxApi": "31",
"minMagisk": "18000",
"needRamdisk": null,
"support": null,
"donate": null,
"config": null,
"changeBoot": null
}
}
}
]
}
```

**FoxMMM**

```json
{
"name": "Repo name",
"website": "repo website",
"support": "optional support url",
"donate": "optional support url",
"submitModule": "optional submit module URL",
"last_update": 0,
"modules": [
{
"id": "module id",
"last_update": 0,
"notes_url": "notes url",
"prop_url": "module.prop url",
"zip_url": "module.zip url"
"notes_url": "https://.../README.md"
}
]
}
Expand All @@ -110,17 +65,13 @@ Always create an `README.md` not `readme.md` or something.

The module doesn't have this prop.

### What are low-quality modules?

These modules doens't have props like `version`, `versionCode`, `description`, `id` or `author`

### Why does my module aren't displayed?

The MMRL has an own hidding system. This means that bad modules can hidden from an admin.

### How to get an verified module?

This depends on the general module quality. (See `What are low-quality modules?`). Not all modules get an verified badge.
This depends on the general module quality. Not all modules get an verified badge.

# Credits & Thanks

Expand Down
Binary file added assets/screen1.jpg
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 assets/screen2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 0 additions & 37 deletions update.py

This file was deleted.

0 comments on commit 69a3551

Please sign in to comment.