{"id":18269391,"url":"https://github.com/keziahmoselle/pippitrack","last_synced_at":"2025-06-18T20:34:18.791Z","repository":{"id":41597971,"uuid":"383864810","full_name":"KeziahMoselle/pippitrack","owner":"KeziahMoselle","description":"Track your osu! activity (top plays, daily updates, new beatmaps). It also have some fun osu! commands.","archived":false,"fork":false,"pushed_at":"2024-10-18T17:29:52.000Z","size":5968,"stargazers_count":14,"open_issues_count":12,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-10T06:54:05.507Z","etag":null,"topics":["discord","discord-bot","hacktoberfest","osu","track"],"latest_commit_sha":null,"homepage":"https://pippitrack.com/","language":"TypeScript","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/KeziahMoselle.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}},"created_at":"2021-07-07T16:43:23.000Z","updated_at":"2025-05-19T18:14:40.000Z","dependencies_parsed_at":"2023-02-13T18:16:47.309Z","dependency_job_id":"30305be9-70d7-488b-89b6-85d5fc774c2a","html_url":"https://github.com/KeziahMoselle/pippitrack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/KeziahMoselle/pippitrack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeziahMoselle%2Fpippitrack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeziahMoselle%2Fpippitrack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeziahMoselle%2Fpippitrack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeziahMoselle%2Fpippitrack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KeziahMoselle","download_url":"https://codeload.github.com/KeziahMoselle/pippitrack/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeziahMoselle%2Fpippitrack/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260629587,"owners_count":23038952,"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","discord-bot","hacktoberfest","osu","track"],"created_at":"2024-11-05T11:35:54.828Z","updated_at":"2025-06-18T20:34:13.777Z","avatar_url":"https://github.com/KeziahMoselle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![cover](.github/cover.jpg)\n\n![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/KeziahMoselle/osu-track/lint/main?label=lint\u0026style=flat-square)\n\n# PippiTrack\n\nA Discord bot that allows you to track osu! things. It has some useful commands too.\n\n## [Invite PippiTrack to your server](https://invite.pippitrack.com/)\n\n## How do I report a bug or request a feature ?\n\n- [Join the PippiTrack Discord server](https://discord.pippitrack.com/)\n- [Create an issue](https://github.com/KeziahMoselle/pippi-track/issues/new) on this repository.\n- Contact me on Discord (**Keziah#6631**)\n\n## How do I use PippiTrack ?\n\n### See documentation at [https://pippitrack.com/](https://pippitrack.com/)\n\n### Get started\n\n#### For users\n\nStart by linking your Discord account to an osu! username like so :\n\n```\n/link \u003cusername\u003e \u003cmode\u003e\n```\n\n[See all commands](#list-of-commands)\n\n#### For administrators\n\nAfter inviting the bot to your server, you need to configure it.\n\n```\n/configure\n```\n\n![configure](.github/config.gif)\n\nTrack a user (top plays, weekly updates and replays)\nYou can track up to 100 players.\n\n```\n/track \u003cusername\u003e\n```\n\n```\n/untrack \u003cusername\u003e\n```\n\n```\n/tracklist \u003c?page\u003e\n```\n\n### List of commands\n\nUpdate an osu! profile via [osu!track](https://ameobea.me/osutrack/)\n\n```\n/update \u003c?username\u003e\n```\n\n![update](.github/update.png)\n\nDisplay peak rank and accuracy of a player\n\n```\n/score \u003c?username\u003e\n```\n\n```\n/gifted \u003c?username\u003e\n```\n\n\n```\n/peak \u003c?username\u003e\n```\n\n![peak](.github/peak.png)\n\nDisplay your profile stats via [osu!sig](https://lemmmy.pw/osusig/)\n\n```\n/osu \u003c?username\u003e\n```\n\n![osusig](.github/osusig.png)\n\n\n### Tracking\n\n#### Top plays (Need polish)\n\n![top play tracking](.github/top_play_tracking.png)\n\n#### Updates\n\nTracked players are queued for an automatic [osu!track](https://ameobea.me/osutrack/) update. (Once a day)\n\n![mass updates](.github/updates.png)\n\n#### Replays (o!rdr)\n\nTracked players that use [o!rdr](https://ordr.issou.best/) will have their replays sent in the replay channel. (if set)\n\n![replays](.github/new_replay.png)\n\n## Installation\n\nHave [Node.js](https://nodejs.org/) (version 16.8.x or newer) installed.\n\n```bash\nnpm install\n```\n\nThen copy the `.env.example` to `.env` and fill in the values.\n\nTo run the bot in development mode run :\n\n```bash\nnpm run dev\n```\n\nTo run the bot in production mode run :\n\n```bash\nnpm run build \u0026\u0026 npm run start\n```\n\n## Directory structure\n\n### `src/commands`\n\nCommands are classes that exports a `run` method and several properties.\n\n```js\nclass Command {\n  name = 'command-name' // !command-name\n  arguments = ['username'] // Accepted arguments for the command !command-name \u003cusername\u003e\n  description = 'Description of the command' // Used for the !help command\n  category = 'general'\n\n  async run(message, args) {}\n}\n```\n\n### `src/services`\n\nServices needs to export a function that triggers the service (running a cron job, etc)\n\n### `src/Bot.js`\n\nThe `Bot.js` file is used for the internal logic of the bot.\nWe'll add listeners to the bot's events and handle the commands.\n\n## Credits\n\n### Services\n\n- [https://ameobea.me/osutrack/](https://ameobea.me/osutrack/) osutrack is a statistics tracker for the game osu!. It stores user information in a database and creates graphs and displays statistics showing how that users' stats changed over time.. A project by [ameobea](https://ameobea.me/)\n- [o!rdr](https://ordr.issou.best/) o!rdr is a free online tool to make renders of osu! replays using [Danser](https://github.com/Wieku/danser-go). Made by [MasterIO](https://github.com/MasterIO02/)\n- [https://lemmmy.pw/osusig/](https://lemmmy.pw/osusig/) for the `!osu` profile image. Created by [Lemmmy](https://osu.ppy.sh/users/4656511)\n\n### Art\n\n- [AKARA](https://akara.fr/) Thank you for the art ! (Badges cover of the `!peak` command)\n- [Bouf](https://osu.ppy.sh/users/4431069) for the name `PippiTrack` and the edit of Koigokoro avatar !\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeziahmoselle%2Fpippitrack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeziahmoselle%2Fpippitrack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeziahmoselle%2Fpippitrack/lists"}