{"id":22796264,"url":"https://github.com/kaktushose/nplay-bot","last_synced_at":"2025-04-19T13:08:51.863Z","repository":{"id":33672142,"uuid":"289742594","full_name":"Kaktushose/NPLAY-Bot","owner":"Kaktushose","description":"discord bot with leveling system, items and events","archived":false,"fork":false,"pushed_at":"2024-12-01T14:22:42.000Z","size":7470,"stargazers_count":11,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-01T15:27:51.292Z","etag":null,"topics":["bot","discord","discord-bot","java","jda"],"latest_commit_sha":null,"homepage":"https://discord.gg/nplay","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kaktushose.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}},"created_at":"2020-08-23T18:18:09.000Z","updated_at":"2024-08-31T17:42:43.000Z","dependencies_parsed_at":"2024-01-07T15:41:20.146Z","dependency_job_id":"27a81bef-8c11-4323-bcf3-25621f96e55d","html_url":"https://github.com/Kaktushose/NPLAY-Bot","commit_stats":null,"previous_names":["kaktushose/nplay-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kaktushose%2FNPLAY-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kaktushose%2FNPLAY-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kaktushose%2FNPLAY-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kaktushose%2FNPLAY-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kaktushose","download_url":"https://codeload.github.com/Kaktushose/NPLAY-Bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229333196,"owners_count":18056671,"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":["bot","discord","discord-bot","java","jda"],"created_at":"2024-12-12T05:11:42.676Z","updated_at":"2024-12-12T05:11:43.241Z","avatar_url":"https://github.com/Kaktushose.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Java CI](https://github.com/Kaktushose/NPLAY-Bot/actions/workflows/maven.yml/badge.svg)](https://github.com/Kaktushose/NPLAY-Bot/actions/workflows/maven.yml)\n[![Deploy](https://github.com/Kaktushose/NPLAY-Bot/actions/workflows/deploy.yml/badge.svg)](https://github.com/Kaktushose/NPLAY-Bot/actions/workflows/deploy.yml)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6eaa0127de99428795b4f5f759da188a)](https://www.codacy.com/gh/Kaktushose/NPLAY-Bot/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=Kaktushose/Levelbot\u0026utm_campaign=Badge_Grade)\n![Generic badge](https://img.shields.io/badge/Version-3.0.0-86c240\".svg)\n[![license-shield](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)]()\n\u003ca href=\"https://discord.gg/qcpeZQhJf5\"\u003e\n\u003cimg src=\"https://discordapp.com/api/guilds/367353132772098048/embed.png\" alt=\"discord\"\u003e\n\u003c/a\u003e\n\n\u003cimg align=\"right\" src=\"https://avatars.githubusercontent.com/u/170041565?s=400\u0026u=c3ca1781422297c0f4f4b236e634b4864d431943\u0026v=4\" height=200 width=200\u003e\n\n# NPLAY-Bot\n\nThis bot was created specifically for the Discord [server](https://discord.gg/qcpeZQhJf5) of the german YouTuber and Twitch Streamer [NPLAY](https://www.youtube.com/nplay). The core feature of this bot is a leveling system, similar to Mee6, but with a high level of customization. \nIn addition, there are various temporary events, a karma system, rewards, permissions and many other useful features.\n\n## Test Server\n\nThe bot is in constant development. Join the test [server](https://discord.gg/JYWezvQ) to receive regular updates, make suggestions and test preview versions. This is also the place to get support if you want to host the bot by yourself.\n\n## Installation\nDue to the high level of customization, I do not provide a public instance that anyone can invite. However, you can still host your own version of the bot. Therefore, you should have a basic understanding of Docker, PostgresSQL and of course Discord bots in general.\n\n\u003e [!IMPORTANT]  \n\u003e The bot is designed to only run on a single guild. Multiple guilds are *not* supported. \n\n### 1. Clone the repo\n\n```\ngit clone https://github.com/Kaktushose/NPLAY-Bot.git\n```\n\n### 2. Initial Configuration\n\nRename the `.env.example` file to `.env` and provide the given values. \n\n```env\nPOSTGRES_DB=database\nPOSTGRES_USER=user\nPOSTGRES_PASSWORD=password\nPOSTGRES_URL=jdbc:postgresql://postgres:5432/database\nGF_SECURITY_ADMIN_PASSWORD=password\nBOT_GUILD=0123456789\nBOT_TOKEN=bot_token\n```\n\n### 3. Start the bot\n\nStart the bot by running:\n\n```\ndocker compose up\n```\n\n\u003e [!NOTE]\n\u003e The default `docker-compose.yml` will also start up Grafana and Watchtower. These services aren't necessary to run the Bot, so feel free to remove them.\n\n### 4. Further Configuration\n\nTo make the bot work properly, you now have to populate the Database correctly. \n\n1. Update the role ids inside the `item_types` and `ranks` table\n2. Update the channel ids inside the `bot_settings` table\n3. Add your karma vote emojis (e.g. 👍) inside the `karma_settings` table\n4. Use the `/rank-config valid-channels add` command to whitelist  channels for the xp system\n5. Manage the permissions with the `/permissions role edit` and `/permissions user edit` commands\n\nThat's it. The bot is now fully functional. \n\n## Credits\n\nI want to thank the following people in now particular order:\n\n1. SimuPlays for creating the concept\n2. Combauer for his support with the concept and the logo creation\n3. 1Flo3 for testing \n4. MeerBiene for his support and general ideas and for keeping me sane\n5. And of course the rest of the NPLAY Discord Team\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaktushose%2Fnplay-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaktushose%2Fnplay-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaktushose%2Fnplay-bot/lists"}