{"id":37366101,"url":"https://github.com/gboquizosanchez/retroachievements","last_synced_at":"2026-01-16T04:52:29.620Z","repository":{"id":264548922,"uuid":"893650881","full_name":"gboquizosanchez/retroachievements","owner":"gboquizosanchez","description":"A non-official Laravel library for getting achievement, user, and game data from RetroAchievements.","archived":false,"fork":false,"pushed_at":"2025-04-24T10:51:55.000Z","size":58,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-19T11:28:49.758Z","etag":null,"topics":["api","retroachievements","retroachievements-api"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/gboquizosanchez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-11-25T00:38:02.000Z","updated_at":"2025-02-07T18:08:28.000Z","dependencies_parsed_at":"2024-11-25T01:33:02.385Z","dependency_job_id":null,"html_url":"https://github.com/gboquizosanchez/retroachievements","commit_stats":null,"previous_names":["gboquizosanchez/retroachievements"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/gboquizosanchez/retroachievements","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gboquizosanchez%2Fretroachievements","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gboquizosanchez%2Fretroachievements/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gboquizosanchez%2Fretroachievements/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gboquizosanchez%2Fretroachievements/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gboquizosanchez","download_url":"https://codeload.github.com/gboquizosanchez/retroachievements/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gboquizosanchez%2Fretroachievements/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28420814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:47:48.104Z","status":"ssl_error","status_checked_at":"2026-01-14T10:46:19.031Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api","retroachievements","retroachievements-api"],"created_at":"2026-01-16T04:52:27.828Z","updated_at":"2026-01-16T04:52:29.614Z","avatar_url":"https://github.com/gboquizosanchez.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" dir=\"auto\"\u003e\u003ca href=\"https://retroachievements.org\" rel=\"nofollow\"\u003e\u003cimg src=\"https://media.retroachievements.org/UserPic/Cheke.png\" width=\"100\" alt=\"RetroAchievements Logo\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eRetroAchievements.org API Container for Laravel\u003c/h1\u003e\n\n\u003chr /\u003e\n\n## Summary\nA library that lets you get achievement, user, and game data from RetroAchievements.org directly in your Laravel application.\n\n## Starting 🚀\n\n### Prerequisites 📋\n- Composer.\n- PHP version 8.3 or higher.\n\n## Running 🛠️\n\nInstall the package via composer:\n\n```shell\ncomposer require gboquizosanchez/retroachievements\n```\n\nEstablish the configuration in the `.env` file:\n\n```dotenv\nRA_USERNAME=your_username\nRA_WEB_API_KEY=your_api_key\n```\n\nYou can also publish the configuration file to customize the package:\n\n```shell\nphp artisan vendor:publish --provider=\"RetroAchievements\\RetroAchievementsServiceProvider\"\n```\n**Note**: You need to have a RetroAchievements account to use the API. If you don't have one, you can create one [here](https://retroachievements.org/createaccount.php). And also, you need to have a web API key. You can get one in your [control panel](https://retroachievements.org/controlpanel.php).\n\n## Basic Usage 👷\n\nYou can use two different methods:\n\n### Using the facade\n\nThis method provides directly from ```.env``` file the username and the web API key.\n\n```php\nuse Retroachievements\\RetroClient;\n\nRetroClient::getGame(gameId: 1);\n```\n\n### Using the RetroAchievements model directly\n\nYou can provide a custom username and web API key if you want to use different credentials.\n\nOr, you can use the default ones from the ```.env``` using  ```config('retro-achievements.credentials')```.\n\n```php\nuse Retroachievements\\Data\\AuthData;\nuse RetroAchievements\\Models\\RetroAchievements;\n\n$auth = new AuthData(\n    username: 'your_username',\n    webApiKey: 'your_api_key',\n);\n\n$client = new RetroAchievements($auth);\n\n$client-\u003egetGame(gameId: 1);\n```\n\n### Mapping the response 🗺️\n\nThere are two ways to map the response. By default, the package uses the DTO mapping.\n\n```dotenv\nRA_DTO_MAPPING=true\nRA_RAW_MAPPING=false\n```\n\n**Note**: If you want to use the raw mapping, you need to set the ```RA_DTO_MAPPING``` to ```false``` and the ```RA_RAW_MAPPING``` to ```true```. RAW only works with DTO mapping disabled.\n\n\n## Available methods 📚\n\nThis package provides all methods available in the [RetroAchievements API](https://api-docs.retroachievements.org/getting-started.html).\n\nSee the [RetroClient facade](src/RetroClient.php) for more information.\n\n## Working with ⚙️\n### PHP dependencies 📦\n- Spatie Laravel Data [![Latest Stable Version](https://img.shields.io/badge/stable-4.11.1-blue)](https://packagist.org/packages/spatie/laravel-data)\n#### Develop dependencies 🔧\n- Friendsofphp Php Cs Fixer [![Latest Stable Version](https://img.shields.io/badge/stable-v3.64.0-blue)](https://packagist.org/packages/friendsofphp/php-cs-fixer)\n- Larastan Larastan [![Latest Stable Version](https://img.shields.io/badge/stable-v2.9.11-blue)](https://packagist.org/packages/larastan/larastan)\n- Orchestra Testbench [![Latest Stable Version](https://img.shields.io/badge/stable-v9.6.1-blue)](https://packagist.org/packages/orchestra/testbench)\n- Pestphp Pest [![Latest Stable Version](https://img.shields.io/badge/stable-v3.5.1-blue)](https://packagist.org/packages/pestphp/pest)\n\n## Testing ✅\n\n```shell\ncomposer test\n```\n\n## Problems? 🚨\n\nLet me know about yours by [opening an issue](https://github.com/gboquizosanchez/retroachievements/issues/new)!\n\n## Credits 🧑‍💻\n\n- [Germán Boquizo Sánchez](mailto:germanboquizosanchez@gmail.com)\n- [All Contributors](../../contributors)\n\n## License 📄\n\nMIT License (MIT). See [License File](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgboquizosanchez%2Fretroachievements","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgboquizosanchez%2Fretroachievements","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgboquizosanchez%2Fretroachievements/lists"}