{"id":15149008,"url":"https://github.com/streetturtle/noobie","last_synced_at":"2025-10-24T05:30:49.716Z","repository":{"id":45476437,"uuid":"338602482","full_name":"streetturtle/noobie","owner":"streetturtle","description":"Create a wibar widget for Awesome WM with no lua code!","archived":false,"fork":false,"pushed_at":"2021-10-24T18:21:30.000Z","size":233,"stargazers_count":42,"open_issues_count":2,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-30T23:41:46.569Z","etag":null,"topics":["awesome-wm","awesome-wm-widgets","awesomewm","lua","widgets"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/streetturtle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-02-13T15:17:52.000Z","updated_at":"2024-12-30T12:00:39.000Z","dependencies_parsed_at":"2022-07-15T04:46:47.443Z","dependency_job_id":null,"html_url":"https://github.com/streetturtle/noobie","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetturtle%2Fnoobie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetturtle%2Fnoobie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetturtle%2Fnoobie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetturtle%2Fnoobie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/streetturtle","download_url":"https://codeload.github.com/streetturtle/noobie/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237918710,"owners_count":19387305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["awesome-wm","awesome-wm-widgets","awesomewm","lua","widgets"],"created_at":"2024-09-26T13:41:11.269Z","updated_at":"2025-10-24T05:30:49.011Z","avatar_url":"https://github.com/streetturtle.png","language":"Lua","funding_links":[],"categories":["Configuration Related"],"sub_categories":["Projects that Ease Configuration"],"readme":"# noobie\n\nThis is a widget-maker tool - it creates a widget based on a JSON definition returned by a script. \nFor example, if your script returns following JSON:\n\n```json\n{\n  \"widget\": {\n    \"icon\": \"smile\",\n    \"text\": \"noobie\",\n    \"mouse_actions\": {\n      \"on_right_click\": \"echo 'right click'\"\n    }\n  }\n}\n```\n\nnoobie will convert it to the widget:\n\n![screenshot](./screenshots/screenshot.png).\n\nMore complex example (from a [people-in-space](https://github.com/streetturtle/noobie-plugins/tree/master/people-in-space) plugin) with a menu, each menu item has an icon, title and subtitle:\n\n![screenshot](./screenshots/screenshot3.png).\n\nFor more examples check out plugins repository: [noobie-plugins](https://github.com/streetturtle/noobie-plugins)\n\n## Features:\n\n - dropdown menu:\n \n   ![menu](./screenshots/screenshot2.png)\n \n - mouse actions (scroll up/down, right click);\n - icon could be either a local file, a [feathericons](https://feathericons.com/) icon or an image from URL;\n - a notification with details in case your script failed:\n \n   ![error notification](./screenshots/screenshot-errors.png)\n \n## Plugins\n\nCheck out existing plugins in this repo: https://github.com/streetturtle/noobie-plugins.\n\n## Creating a plugin\n\nPlease consult a **noobie.schema.json** for details. Below are few important excerpts:\n\n- `icon` of the widget or menu item can be one of \n  - a name of feathericons icon, you can get it here: [feathericons.com](https://feathericons.com/); \n  - an absolute path to the image file;\n  - URL to the image file. If you are not sure image exists, you can add a `icon_fallback` field with an absolute path to the fallback image;\n - for a horizontal line in the menu add an item with title equals to '-', like  \n    ```json\n    { \"title\":  \"-\" }\n    ```\n  - for a header menu item set `header` field to true, note that the `icon` field will be ignored:\n    ```json\n    {\n      \"header\": \"true\",\n      \"title\": \"Header Title\"\n    }\n    ```\n \n## Installation\n\n1. Clone the repo under ~/.config/awesome/ folder\n1. At the top of rc.lua add an import:\n \n    ```lua\n    local noobie_exmaple_1 = require(\"noobie\")\n    local noobie_exmaple_2 = require(\"noobie\")\n    ```\n1. Add a widget to wibox and provide a path to your script:\n \n    ```lua\n    noobie_exmaple_1{ path = os.getenv(\"HOME\") .. '/.config/awesome/noobie/test.sh' },\n    noobie_exmaple_2{ path = os.getenv(\"HOME\") .. '/.config/awesome/noobie/othertest.py' },\n    ```\nIf your widget is static you can define it in a JSON file and use like this:\n\n```lua\nnoobie_exmaple_1{ path = 'cat ' .. os.getenv(\"HOME\") .. '/.config/awesome/noobie/test.json' },\n```\n    \n# Troubleshooting\n\nIn case of any problem / issue / question:\n - create an [issue](https://github.com/streetturtle/noobie/issues/new/choose)\n - raise a question on [Discussions](https://github.com/streetturtle/noobie/discussions)!\n - ping me on AwesomeWM's discord, here's an [invite](https://discord.gg/XYvn8R5)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetturtle%2Fnoobie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstreetturtle%2Fnoobie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetturtle%2Fnoobie/lists"}