How to use GitHub module?

redphx commented 2 weeks ago

I saw the changelogs of Version 1.3.0 mentioned about GitHub Module support for faster development.

How do I implement this? I couldn't find any information in MODULES.md about this feature.

Thanks.

reisxd commented 2 weeks ago

You must have the entire project structure in your repository. It seems like you're trying to build Better XCloud for Tizen using TizenBrew and after checking the releases, it's simply a JS file to be injected (and I'm pretty sure User Scripts are just something that you can paste into DevTools console and it'd work).

Here's what you could do as the package.json file:

{
  "name": "better-xcloud",
  "module": "src/index.ts",
   // TizenBrew stuff below
  "main": "dist/better-xcloud.user.js",
  "appName": "Better XCloud",
  "description": "Userscript to improve Xbox Cloud Gaming (xCloud) and Remote Play experiences on web browsers",
  "packageType": "mods",
  "websiteURL": "https://www.xbox.com/play",
  "keys": [ "The keys that you may want to register. See https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html" ],
  "type": "module",
  "browserslist": [
    "Chrome >= 80"
  ],
  "bin": {
    "build": "build.ts"
  },
  "devDependencies": {
    "@types/bun": "^1.1.6",
    "@types/node": "^20.16.1",
    "@types/stylus": "^0.48.42",
    "eslint": "^9.9.0",
    "eslint-plugin-compat": "^6.0.0",
    "stylus": "^0.63.0"
  },
  "peerDependencies": {
    "typescript": "^5.5.2"
  }
}

And then add redphx/better-xcloud as a GH module.

BTW, your project should work on Tizen 6.5+ (2022+) TVs. See this.

redphx commented 2 weeks ago

Thank you. I can only test this project next week, so I'll report back later.

reisxd / TizenBrew

How to use GitHub module? #28