{"id":16151285,"url":"https://github.com/chocomeow/iufi","last_synced_at":"2025-03-18T19:31:14.685Z","repository":{"id":190817960,"uuid":"682966843","full_name":"ChocoMeow/IUFI","owner":"ChocoMeow","description":"A Discord bot designed for card collecting and mini-games specifically for the IU community","archived":false,"fork":false,"pushed_at":"2025-03-03T03:14:18.000Z","size":31991,"stargazers_count":5,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T23:12:21.269Z","etag":null,"topics":["discord","ffmpeg","iu","iufi","python"],"latest_commit_sha":null,"homepage":"","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/ChocoMeow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"ko_fi":"chocoo"}},"created_at":"2023-08-25T09:26:50.000Z","updated_at":"2025-03-03T03:14:18.000Z","dependencies_parsed_at":"2023-10-12T13:45:02.848Z","dependency_job_id":"c3b6f201-5784-4c32-94d3-c19f74328b1d","html_url":"https://github.com/ChocoMeow/IUFI","commit_stats":null,"previous_names":["chocomeow/iufi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChocoMeow%2FIUFI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChocoMeow%2FIUFI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChocoMeow%2FIUFI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChocoMeow%2FIUFI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChocoMeow","download_url":"https://codeload.github.com/ChocoMeow/IUFI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244288554,"owners_count":20429030,"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":["discord","ffmpeg","iu","iufi","python"],"created_at":"2024-10-10T00:55:37.580Z","updated_at":"2025-03-18T19:31:14.393Z","avatar_url":"https://github.com/ChocoMeow.png","language":"Python","funding_links":["https://ko-fi.com/chocoo"],"categories":[],"sub_categories":[],"readme":"# IUFI\n\nIUFI is a Discord bot designed for card collecting and mini-games specifically for the IU community. Built entirely with Python, this bot offers an engaging experience for users to collect cards and participate in fun mini-games.\n\n## Screenshots\n\u003cimg width=\"400\" alt=\"Screenshot 2024-10-20 at 10 03 13 PM\" src=\"https://github.com/user-attachments/assets/c6e315cf-2afa-48a4-a32a-bd4712f8b909\"\u003e\n\u003cimg width=\"400\" alt=\"Screenshot 2024-10-20 at 10 05 59 PM\" src=\"https://github.com/user-attachments/assets/76992956-ff11-481b-84bd-b957d8b3dfbb\"\u003e\n\u003cimg width=\"400\" alt=\"Screenshot 2024-10-20 at 10 05 13 PM\" src=\"https://github.com/user-attachments/assets/09067d6a-705f-420f-b4c9-3b4b246ad52b\"\u003e\n\u003cimg width=\"400\" alt=\"Screenshot 2024-10-20 at 10 03 48 PM\" src=\"https://github.com/user-attachments/assets/0fa6b5de-35b8-45c2-ba5f-61a836f0ca29\"\u003e\n\u003cimg width=\"400\" alt=\"Screenshot 2024-10-20 at 10 06 40 PM\" src=\"https://github.com/user-attachments/assets/8d0be8f5-eaa0-4b15-9813-638c059ad8a6\"\u003e\n\n\n## Requirements\n- Python 3.11 or above\n- A `.env` file with the following variables:\n```plaintext\nTOKEN=DISCORD_BOT_TOKEN\nMONGODB_URL=MONGODB_URL\nMONGODB_NAME=MONGODB_NAME\n```\n- A `settings.json` file containing the bot settings. This file is pre-filled with values based on the IUCord server but can be modified as needed.\n\n## Installation\n1. Clone this repository:\n```\ngit clone https://github.com/ChocoMeow/IUFI.git\n```\n\n2. Navigate to the project directory:\n```\ncd IUFI\n```\n\n\n3. Install the required Python packages. It is recommended to use a virtual environment:\n```\npython -m venv venv\nsource venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\npip install -r requirements.txt\n```\n\n4. Create a .env file in the root directory and add your Discord bot token and MongoDB details.\n5. Modify the settings.json file as needed to customize your bot settings.\n\n## Enabling Music Quiz\nTo enable the music quiz feature in the bot, you must install `ffmpeg` in your environment. You can specify the path for the OPUS library in your `settings.json` file as follows:\n```\n{\n  \"OPUS_PATH\": \"path/to/your/opus/library\"\n}\n```\n*If you do not provide the OPUS_PATH, the program will attempt to auto-detect the OPUS library. If detection fails, you will need to manually specify the path in the settings.json file.*\n\n## Running the Bot\nTo start the bot, run the following command:\n```\npython main.py\n```\n\n## Auto-Created Folders\nUpon starting the bot, the following folders will be automatically created in the root directory:\n- **images:** This folder stores card images. Inside, you should create your own category folders that match the configuration in your `settings.json`.\n- **newImages:** Place any new card images you want to add to the bot in this folder. The bot will automatically update the database and move the images to the correct category folder in the images folder. Ensure that new card images follow the naming format category#.webp (e.g., common1.webp, common2.webp, rare1.webp, etc.).\n- **musicTracks:** This folder will automatically download music tracks using `ytlib` when players are participating in the music quiz.\n\n\n## Contributing\nContributions are welcome! If you have suggestions for improvements or features, feel free to submit a pull request.\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchocomeow%2Fiufi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchocomeow%2Fiufi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchocomeow%2Fiufi/lists"}