{"id":24020861,"url":"https://github.com/OptimumMeans/TRMNL-Discord-Bot","last_synced_at":"2025-09-14T20:32:15.705Z","repository":{"id":269478374,"uuid":"907245559","full_name":"OptimumMeans/TRMNL-Discord-Bot","owner":"OptimumMeans","description":"The official bot for the TRMNL community, providing quick access to documentation, updates, and resources directly in Discord.","archived":false,"fork":false,"pushed_at":"2024-12-25T01:54:55.000Z","size":61,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-08T12:19:24.160Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://usetrmnl.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OptimumMeans.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-23T06:46:35.000Z","updated_at":"2024-12-23T20:54:51.000Z","dependencies_parsed_at":"2024-12-23T21:28:08.916Z","dependency_job_id":"dd4329f3-abb4-484c-b7f9-aaefbf8553df","html_url":"https://github.com/OptimumMeans/TRMNL-Discord-Bot","commit_stats":null,"previous_names":["optimummeans/trmnl-discord-bot"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OptimumMeans/TRMNL-Discord-Bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2FTRMNL-Discord-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2FTRMNL-Discord-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2FTRMNL-Discord-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2FTRMNL-Discord-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OptimumMeans","download_url":"https://codeload.github.com/OptimumMeans/TRMNL-Discord-Bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2FTRMNL-Discord-Bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275161921,"owners_count":25416092,"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","status":"online","status_checked_at":"2025-09-14T02:00:10.474Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-01-08T12:19:05.019Z","updated_at":"2025-09-14T20:32:15.419Z","avatar_url":"https://github.com/OptimumMeans.png","language":"Python","funding_links":[],"categories":["🔌 Plugins - General"],"sub_categories":[],"readme":"# TRMNL Discord Bot\n\nThe official Discord bot for the TRMNL community. This bot provides easy access to TRMNL documentation, resources, and updates directly within Discord.\n\n## Features\n\n- Access to TRMNL documentation and resources\n- Latest news and updates about TRMNL\n- DIY TRMNL guides and information\n- Privacy policy and terms of service information\n- Framework documentation access\n\n## Setup Instructions\n\n### Prerequisites\n\n- Python 3.11 or higher\n- A Discord Bot Token\n- Discord Developer Application access\n\n### Configuration\n\n1. Clone this repository:\n```bash\ngit clone https://github.com/usetrmnl/discord-bot.git\ncd discord-bot\n```\n\n2. Create and configure environment variables:\n   - Copy `.env.template` to `.env`\n   - Add your Discord bot token:\n```bash\nDISCORD_TOKEN=your_bot_token_here\n```\n\n3. Configure `config.json`:\n   - Set your desired command prefix\n   - Add your bot's invite link\n\n### Installation\n\n1. Create and activate a virtual environment (recommended):\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n```\n\n2. Install required packages:\n```bash\npip install -r requirements.txt\n```\n\n### Running the Bot\n\n```bash\npython bot.py\n```\n\n## Command Reference\n\n- `/home` - Main TRMNL resources\n- `/docs` - Documentation links\n- `/framework` - Framework documentation\n- `/news` - Latest updates\n- `/updates` - All blog posts\n- `/privacy` - Privacy policy\n- `/terms` - Terms of service\n- `/diy` - DIY TRMNL information\n\n## Development\n\n### Adding New Commands\n\nCommands are managed in `src/bot/trmnl.py`. Each command is implemented as a slash command using Discord.py's hybrid command system.\n\n### Documentation Updates\n\nResource links and documentation content are managed in `docs.json`. Update this file to modify command responses.\n\n## Support\n\nNeed help? Join the [TRMNL Discord Community](https://discord.gg/trmnl)\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to your branch\n5. Create a Pull Request\n\n## License\n\nThis project is proprietary software owned by TRMNL. All rights reserved.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOptimumMeans%2FTRMNL-Discord-Bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOptimumMeans%2FTRMNL-Discord-Bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOptimumMeans%2FTRMNL-Discord-Bot/lists"}