Skip to content

Commit

Permalink
v2.11.12
Browse files Browse the repository at this point in the history
  • Loading branch information
@DerGoogler
DerGoogler committed Jan 4, 2025
1 parent 2d29394 commit 5498077
Show file tree
Hide file tree
Showing 7 changed files with 670 additions and 362 deletions.
369 changes: 9 additions & 360 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@

This util is to build module repository for [MMRL](https://github.com/DerGoogler/MMRL)

- `sync` is a python package
- `cli.py` is a cli tool

## Getting Started

### Install dependencies

```shell
pip3 install -r util/requirements.txt
pip3 install mmrl-util
```

### New config.json
Expand All @@ -35,56 +32,15 @@ or
cli.py config --write name="Your Magisk Repo" base_url="https://you.github.io/magisk-modules-repo/" max_num=3 enable_log=true log_dir="log"
```

### New track.json

You can write it to `your-repo/modules/{id}/track.json` by yourself, or

```shell
cli.py track --stdin << EOF
{
"id": "zygisk_lsposed",
"update_to": "https://lsposed.github.io/LSPosed/release/zygisk.json",
"license": "GPL-3.0"
}
EOF
```

or

```shell
cli.py track --add id="zygisk_lsposed" update_to="https://lsposed.github.io/LSPosed/release/zygisk.json" license="GPL-3.0"
```

If you want to generate `track.json`s from repositories on github

```shell
cli.py github --token <github-token> -u <user-name> -r <repo-name ...>
```

> [!TIP]
> Click [here](https://github.com/settings/personal-access-tokens/new) to create a new api token.
### Sync

```shell
cli.py sync
```

### Generate a sitemap

```shell
cli.py sitemap --base-url "https://mmrl.dergoogler.com/?module="
```

## How to update by GitHub Actions?

- You can refer to [GMR](https://github.com/Googlers-Repo/gmr).
- You can refer to our [example-repository](https://github.com/Googlers-Repo/example-repository).

## cli.py
## mmrl-util

```
cli.py --help
usage: cli.py [-h] [-v] [-V] command ...
mmrl-util --help
usage: mmrl-util [-h] [-v] [-V] command ...
Magisk Modules Repo Util
Expand All @@ -104,315 +60,8 @@ options:
-V, --version-code Show util version code and exit.
```

## config.json

```json
{
"name": "Googlers Magisk Repo",
"website": "https://mmrl.dergoogler.com",
"support": "https://github.com/Googlers-Repo/repo/issues",
"donate": "https://github.com/sponsors/DerGoogler",
"submission": null,
"description": null,
"base_url": "https://gr.dergoogler.com/repo/",
"max_num": 3,
"enable_log": true,
"log_dir": "log"
}
```

| Key | Attribute | Description |
| ----------- | --------- | ----------------------------------------------- |
| name | required | Name of your module repository |
| base_url | required | Need to end with `/` |
| website | optional | Name of your website |
| donate | optional | Name of your donation url |
| submission | optional | Link to your submission requests |
| description | optional | Describe your repository |
| support | optional | Link to your support chat |
| max_num | optional | Max num of versions for modules, default is `3` |
| enable_log | optional | default is `true` |
| log_dir | optional | default is `null` |

## track.json

```json
{
"id": "str",
"enable": "bool",
"verified": "bool",
"update_to": "str",
"source": "str",
"readme": "str",
"max_num": "int",
"antifeatures": ["array"]
}
```

| Key | Attribute | Type | Description |
| ------------ | --------- | ----- | ------------------------------------------------- |
| id | required | Str | Id of Module (_in `module.prop`_) |
| enable | required | Bool | Whether to enable updates |
| update_to | required | Str | Follow examples below |
| source | optional | Str | Url of where the source code lives |
| homepage | optional | Str | URL |
| readme | optional | Str | URL with e.g. description, instructions |
| changelog | optional | Str | Markdown or Simple Text (**_no HTML_**) |
| support | optional | Str | URL to issue tracker/support forum |
| donate | optional | Str | URL to donation page |
| cover | optional | Str | URL to cover image (featureGraphic) |
| icon | optional | Str | URL to icon.png (squared, max 512x512 px) |
| screenshots | optional | Str[] | URLs to screenshots of the module |
| license | optional | Str | SPDX identifier (see below) |
| antifeatures | optional | Str[] | potentially unwanted "features" (see below) |
| category | optional | Str | category the module belongs to (deprecated) |
| categories | optional | Str[] | array of categories the module belongs to |
| require | optional | Str[] | array of `module_id`s this module depends on |
| verified | optional | Bool | if module has good quality and is well maintained |
| max_num | optional | Int | Overload `MAX_NUM` in `config.json` |
| versions | auto | Int | how many versions are present (do not touch!) |

Examples for antifeatures and their meanings can e.g. be [found here](https://gitlab.com/IzzyOnDroid/repo/-/blob/master/lib/antifeatures.json).

For SPDX identifiers, see the [SPDX license list](https://spdx.org/licenses/).

## `common/repo.json`

> [!IMPORTANT]
> This file can be placed in the modules root directory. If a repo owner has added your module to his repo he can override those fields with the `track.json` file
```jsonc
{
"support": "str",
"donate": "str",
"cover": "str",
"icon": "str",
"license": "str",
"homepage": "str",
"readme": "str",
"screenshots": ["array"],
"category": "str",
"categories": ["array"],
"require": ["array"],
"note": {
"title": "str", // optional
"color": "red,blue,yellow,green", // optional
"message": "str" // required
},
"root": {
"kernelsu": ">= 1.0.0",
"magisk": ">= 24.0
}
}
```
| Key | Attribute | Description |
| ------------ | --------- | ------------------------------------------------------------------------------------------- |
| license | optional | SPDX ID |
| cover | optional | Url |
| icon | optional | Url |
| readme | optional | Str |
| screenshots | optional | Url[] |
| antifeatures | optional | Str[] |
| category | optional | Str |
| categories | optional | Str[] |
| homepage | optional | Url |
| support | optional | Url |
| donate | optional | Url |
| note | optional | Note |
| root | optional | RootSolutions (you should follow the [semver](https://www.npmjs.com/package/semver)) syntax |
### Update from updateJson
> For those modules that provide [updateJson](https://topjohnwu.github.io/Magisk/guides.html#moduleprop).
```json
{
"id": "zygisk_lsposed",
"update_to": "https://lsposed.github.io/LSPosed/release/zygisk.json",
"license": "GPL-3.0"
}
```
### Update from local updateJson
> _update_to_ requires a relative directory of _local_.
```json
{
"id": "zygisk_lsposed",
"update_to": "zygisk.json",
"license": "GPL-3.0"
}
```
### Update from url
> For those have a same url to release new modules.
```json
{
"id": "zygisk_lsposed",
"update_to": "https://github.com/LSPosed/LSPosed/releases/download/v1.8.6/LSPosed-v1.8.6-6712-zygisk-release.zip",
"license": "GPL-3.0",
"changelog": "https://lsposed.github.io/LSPosed/release/changelog.md"
}
```
### Update from git
> For those we can get module by packaging all files in the repository, such as [Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo) and [Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo).
```json
{
"id": "busybox-ndk",
"update_to": "https://github.com/Magisk-Modules-Repo/busybox-ndk.git"
}
```
### Update from local zip
> _update_to_ and _changelog_ requires a relative directory of _local_.
```json
{
"id": "zygisk_lsposed",
"update_to": "LSPosed-v1.8.6-6712-zygisk-release.zip",
"license": "GPL-3.0",
"changelog": "changelog.md"
}
```
## For developer
```
your-repo
├── json
│   ├── config.json
│   └── modules.json
│
├── local
│   ├── ...
│ └── ...
│
├── log
│   ├── sync_2023-03-18.log
│   ├── ...
│   └── ...
│
├── modules
│   ├── zygisk_lsposed
│   │   ├── track.json
│   │   ├── update.json
│   │   ├── v1.8.6_6712.md
│   │   ├── v1.8.6_6712.zip
│   │   ├── ...
│   │   └── ...
│ │
│ ├── another_module
│   │   ├── ...
│   │   └── ...
│ └── .
│
└── util
```
### update.json
```json
{
"id": "zygisk_lsposed",
"timestamp": 1673882223.0,
"versions": [
{
"timestamp": 1673882223.0,
"version": "v1.8.6 (6712)",
"versionCode": 6712,
"zipUrl": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.zip",
"changelog": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.md"
}
]
}
```
### track.json
```json
{
"id": "zygisk_lsposed",
"update_to": "https://lsposed.github.io/LSPosed/release/zygisk.json",
"license": "GPL-3.0",
"homepage": "https://lsposed.org/",
"source": "https://github.com/LSPosed/LSPosed.git",
"support": "https://github.com/LSPosed/LSPosed/issues",
"added": 1679025505.129431,
"last_update": 1673882223.0,
"versions": 1
}
```
## modules.json
### Learn more!

### version 1
```json
{
"name": "{name}",
"metadata": {
"version": 1,
"timestamp": 1692439764.10608
},
"modules": [
{
"id": "zygisk_lsposed",
"name": "Zygisk - LSPosed",
"version": "v1.8.6 (6712)",
"versionCode": 6712,
"author": "LSPosed Developers",
"description": "Another enhanced implementation of Xposed Framework. Supports Android 8.1 ~ 13. Requires Magisk 24.0+ and Zygisk enabled.",
"track": {
"type": "ONLINE_JSON",
"added": 1679025505.129431,
"license": "GPL-3.0",
"homepage": "https://lsposed.org/",
"source": "https://github.com/LSPosed/LSPosed.git",
"support": "https://github.com/LSPosed/LSPosed/issues",
"donate": ""
},
"versions": [
{
"timestamp": 1673882223.0,
"version": "v1.8.6 (6712)",
"versionCode": 6712,
"zipUrl": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.zip",
"changelog": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.md"
}
]
}
]
}
```
### version 0
```json
{
"name": "{name}",
"timestamp": 1692439602.46997,
"modules": [
{
"id": "zygisk_lsposed",
"name": "Zygisk - LSPosed",
"version": "v1.8.6 (6712)",
"versionCode": 6712,
"author": "LSPosed Developers",
"description": "Another enhanced implementation of Xposed Framework. Supports Android 8.1 ~ 13. Requires Magisk 24.0+ and Zygisk enabled.",
"license": "GPL-3.0",
"states": {
"zipUrl": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.zip",
"changelog": "{base_url}modules/zygisk_lsposed/v1.8.6_(6712)_6712.md"
}
}
]
}
```
- [TrackJson](/docs/TrackJson.md)
- [ConfigJson](/docs/ConfigJson.md)
- [RepoJson](/docs/RepoJson.md)
Loading

0 comments on commit 5498077

Please sign in to comment.