{"id":16906407,"url":"https://github.com/chrisru/ludo-api","last_synced_at":"2025-03-20T16:33:09.324Z","repository":{"id":127151974,"uuid":"194336208","full_name":"ChrisRu/ludo-api","owner":"ChrisRu","description":"🎲 Ludo game API","archived":false,"fork":false,"pushed_at":"2019-09-06T19:09:40.000Z","size":51,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-25T15:30:14.732Z","etag":null,"topics":["api","csharp","ludo","signalr"],"latest_commit_sha":null,"homepage":null,"language":"C#","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/ChrisRu.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":"2019-06-28T21:33:02.000Z","updated_at":"2024-12-17T12:16:56.000Z","dependencies_parsed_at":"2023-04-19T16:28:42.352Z","dependency_job_id":null,"html_url":"https://github.com/ChrisRu/ludo-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisRu%2Fludo-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisRu%2Fludo-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisRu%2Fludo-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisRu%2Fludo-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChrisRu","download_url":"https://codeload.github.com/ChrisRu/ludo-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244649972,"owners_count":20487532,"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":["api","csharp","ludo","signalr"],"created_at":"2024-10-13T18:42:31.424Z","updated_at":"2025-03-20T16:33:09.298Z","avatar_url":"https://github.com/ChrisRu.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ludo API\n\nAPI for a game of Ludo\n\n## How to use\n\n### Library\n\nYou need the following package to use this API.\n\n`npm install @aspnet/signalr@next`\n\n### Connecting\n\nThe API is live on `ludo.azurewebsites.net`\n\nConnect on subpath `/game`\n\n### Events\n\n#### Lobbies\n\n- invoke `lobby:create` with `lobbyName` to create a new lobby\n- invoke `lobby:join` with `lobbyName` to join a created lobby\n- invoke `lobby:leave` to leave your currently joined lobby\n- invoke `lobby:ready` to inform your mates you're ready to roll\n- invoke `lobby:get-players` with `lobbyName` to get the players in said lobby\n- invoke `lobby:get-lobbies` to get the lobbies names\n- invoke `lobby:exists` with `lobbyName` to check whether a lobby with that name already exists\n\nWhen you're in a lobby you can get events for said lobby\n\n- on `lobby:player-join` it returns the user details of the player that joined\n- on `lobby:player-leave` it returns the user identifier for the player that left\n- on `lobby:player-ready` it returns the player identifier of the player who is ready to start the game\n\n#### Game\n\n- invoke `game:start` as admin (those who created the lobby) to start the game when everyone is ready\n- invoke `game:roll-die` to roll your dice if it's your turn\n- invoke `game:advance` with `pieceIndex` to move the piece\n\nWhen you're in a started game you can get events for that game\n\n- on `game:started` the game has started\n- on `game:die-roll` a player has rolled the dice, it returns the player identifier of the player who rolled the die and the amount it rolled\n- on `game:advanced` a player has advanced his piece, it returns the player identifier of the player who advanced his piece and the index of said piece\n- on `game:next-turn` the next player or turn starts, it returns the player identifier of the player whose turn it is and the turn type (roll or advance)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisru%2Fludo-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisru%2Fludo-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisru%2Fludo-api/lists"}