{"id":31844900,"url":"https://github.com/ptraced/vouch-bot","last_synced_at":"2025-10-12T07:55:10.369Z","repository":{"id":315935235,"uuid":"1061311011","full_name":"ptraced/Vouch-Bot","owner":"ptraced","description":"A Vouch bot remade from a plex tickets addon to be standalone","archived":false,"fork":false,"pushed_at":"2025-09-21T17:04:06.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-21T19:08:20.347Z","etag":null,"topics":["bot","discord","discord-bot","vouch"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ptraced.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-21T17:00:07.000Z","updated_at":"2025-09-21T17:05:00.000Z","dependencies_parsed_at":"2025-09-21T19:08:27.017Z","dependency_job_id":"b3d76ebd-b8d5-44e8-b324-ab1a0bf14cbb","html_url":"https://github.com/ptraced/Vouch-Bot","commit_stats":null,"previous_names":["ptraced/vouch-bot"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ptraced/Vouch-Bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ptraced%2FVouch-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ptraced%2FVouch-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ptraced%2FVouch-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ptraced%2FVouch-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ptraced","download_url":"https://codeload.github.com/ptraced/Vouch-Bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ptraced%2FVouch-Bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010665,"owners_count":26084785,"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-10-12T02:00:06.719Z","response_time":53,"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":["bot","discord","discord-bot","vouch"],"created_at":"2025-10-12T07:55:07.333Z","updated_at":"2025-10-12T07:55:10.355Z","avatar_url":"https://github.com/ptraced.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vouch Bot\n\nA Discord bot for managing user vouches and reviews with star ratings and customizable embeds.\n\n## Features\n\n- **Slash Commands**: Modern Discord slash command interface\n- **Star Ratings**: 1-5 star rating system with visual stars\n- **User-Specific Vouching**: Option to vouch for specific users or the business as a whole\n- **Image Attachments**: Optional image upload for proof/evidence\n- **Role Restrictions**: Limit vouch command usage to specific roles\n- **Customizable Embeds**: Fully customizable embed colors, titles, and field names\n- **Vouch Counter**: Automatic numbering of vouches\n- **Persistent Data**: Vouch count stored in JSON file\n\n## Setup\n\n### Prerequisites\n\n- Node.js 22.14.0 or higher\n- A Discord bot token and application\n- Discord server with appropriate permissions\n\n### Installation\n\n1. **Clone or download this repository**\n\n2. **Install dependencies**\n   ```bash\n   npm install\n   ```\n\n3. **Configure the bot**\n   \n   Edit `config.yml` and replace the placeholder values:\n   \n   ```yaml\n   # Bot Configuration\n   botToken: \"YOUR_BOT_TOKEN_HERE\"     # Your Discord bot token\n   clientId: \"YOUR_CLIENT_ID_HERE\"     # Your Discord application/client ID\n   guildId: \"YOUR_GUILD_ID_HERE\"       # Your Discord server ID (optional)\n   \n   # Other settings\n   vouchChannelId: \"CHANNEL_ID_HERE\"   # Channel where vouches will be sent\n   requiredRoles: [\"ROLE_ID_1\", \"ROLE_ID_2\"]  # Roles that can use vouch command\n   ```\n\n4. **Start the bot**\n   ```bash\n   npm start\n   ```\n\n### Getting Discord IDs\n\nTo get the required IDs:\n\n1. **Bot Token \u0026 Client ID**: \n   - Go to [Discord Developer Portal](https://discord.com/developers/applications)\n   - Create a new application or select existing one\n   - Go to \"Bot\" section for the token\n   - Go to \"General Information\" for the Client ID\n\n2. **Guild ID (Server ID)**:\n   - Enable Developer Mode in Discord settings\n   - Right-click your server → \"Copy Server ID\"\n\n3. **Channel ID**:\n   - Right-click the channel → \"Copy Channel ID\"\n\n4. **Role ID**:\n   - Right-click the role → \"Copy Role ID\"\n\n### Bot Permissions\n\nYour bot needs the following permissions:\n- Send Messages\n- Use Slash Commands\n- Embed Links\n- Attach Files (if image uploads are enabled)\n- Read Message History\n\n## Configuration Options\n\n### Basic Settings\n\n- `allowUserSpecificVouch`: Allow vouching for specific users (true/false)\n- `uploadImage`: Require image attachments for vouches (true/false)\n- `requiredRoles`: Array of role IDs that can use the vouch command\n\n### Customization\n\nAll embed elements can be customized in the `customization` section:\n\n```yaml\ncustomization:\n  embedColor: \"#5e99ff\"\n  vouchTitle: \"🎉 Vouch (#${count})\"\n  vouchFooterText: \"Vouched by ${authorTag}\"\n  userFieldTitle: \"Vouched User\"\n  vouchedByFieldTitle: \"Vouched By\"\n  vouchedAtFieldTitle: \"Vouched at\"\n  starsFieldTitle: \"Stars\"\n  messageDescription: \"${messageContent}\"\n```\n\n### Bot Status\n\nConfigure the bot's activity status:\n\n```yaml\nbotStatus:\n  activity: \"Managing vouches\"\n  type: 0  # 0 = Playing, 1 = Streaming, 2 = Listening, 3 = Watching, 5 = Competing\n```\n\n## Usage\n\n### /vouch Command\n\nUsers with the required roles can use the `/vouch` command with the following options:\n\n- **message** (required): The vouch message/review\n- **stars** (required): Rating from 1-5 stars\n- **user** (optional): The user being vouched for (if enabled in config)\n- **attachment** (optional): Image proof (if enabled in config)\n\n## File Structure\n\n```\nvouch-bot/\n├── commands/\n│   └── vouch.js          # Vouch command implementation\n├── config.yml            # Bot configuration\n├── vouchCount.json       # Persistent vouch counter\n├── index.js              # Main bot file\n├── deploy-commands.js    # Command deployment script\n├── package.json          # Dependencies and scripts\n└── README.md             # This file\n```\n\n## Development\n\nFor development with auto-restart:\n```bash\nnpm run dev\n```\n\n## Support\n\nIf you encounter any issues:\n1. Check that all IDs in `config.yml` are correct\n2. Ensure the bot has proper permissions in your server\n3. Verify that slash commands were deployed successfully\n4. Check the console for error messages","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fptraced%2Fvouch-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fptraced%2Fvouch-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fptraced%2Fvouch-bot/lists"}