{"id":19675635,"url":"https://github.com/notnite/playdate-fishing","last_synced_at":"2025-09-04T06:39:53.034Z","repository":{"id":237425806,"uuid":"696480224","full_name":"NotNite/playdate-fishing","owner":"NotNite","description":"FFXIV fishing controlled by a Playdate","archived":false,"fork":false,"pushed_at":"2023-09-26T04:20:33.000Z","size":144,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-29T02:39:58.834Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/NotNite.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":"2023-09-25T20:35:39.000Z","updated_at":"2023-09-28T01:16:37.000Z","dependencies_parsed_at":"2024-05-01T17:34:47.589Z","dependency_job_id":"5ab4edaf-9c95-4c8c-81c4-9f34c0c041b8","html_url":"https://github.com/NotNite/playdate-fishing","commit_stats":null,"previous_names":["notnite/playdate-fishing"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NotNite/playdate-fishing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fplaydate-fishing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fplaydate-fishing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fplaydate-fishing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fplaydate-fishing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotNite","download_url":"https://codeload.github.com/NotNite/playdate-fishing/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fplaydate-fishing/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273567169,"owners_count":25128630,"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","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-11T17:25:15.959Z","updated_at":"2025-09-04T06:39:53.002Z","avatar_url":"https://github.com/NotNite.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Playdate Fishing\n\nFFXIV fishing controlled by a Playdate.\n\n## What?\n\n[The Playdate](https://play.date/) is a handheld game console with a crank. [A friend](https://github.com/KazWolfe) gave me the idea to connect the crank to FFXIV fishing. Here it is.\n\n## How?\n\nThe Playdate exposes a [serial connection over USB](https://github.com/jaames/playdate-reverse-engineering/blob/main/usb/usb.md). There are two features on the serial connection we can (ab)use:\n\n- Anything you `print` in a game gets logged to the serial port\n- You can evaluate Lua bytecode with the `eval` command\n\nNote the *bytecode* in that sentence. We can evaluate custom Lua on the fly, but compiling a new program for each command sounds miserable. However, I have [too much experience with Lua bytecode](https://notnite.com/blog/ffxiv-modloader-ace/), and I found [this excellent GitHub gist](https://gist.github.com/ericlewis/43d07016275308de11a5519466deea85) that details splicing data into Lua bytecode to pass JSON to the game. I reimplemented that gist in C#, allowing me to have two way communication with everyone's favorite cheese slice.\n\n## Installation\n\nThis guide assumes you are a developer that is probably in the Playdate developer ecosystem but is probably not in the FFXIV developer ecosystem. You will have to build this from source - I'm not providing binaries for a project this dumb.\n\nRequirements:\n\n- A [Playdate](https://play.date/) and [XIVLauncher](https://goatcorp.github.io/)\n- The [Playdate SDK](https://play.date/dev/) and [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download)\n\nFirst, build and install the Playdate game (making sure you have the Playdate SDK in your path, and your Playdate is connected via USB and is unlocked):\n\n```shell\npdc ./playdate ./com.notnite.playdatefishing.pdx\npdutil install ./com.notnite.playdatefishing.pdx\n```\n\nThen, build the Dalamud plugin:\n\n```shell\ndotnet build ./dalamud/PlaydateFishing\n```\n\nNow, open FFXIV. Go into the Experimental tab of the Dalamud settings (`/xlsettings`), and add the path to the built DLL to the \"Dev Plugin Locations\" section. Then, do the following:\n\n- Plug in your Playdate to your computer\n- Ensure your Playdate is unlocked on the home screen\n- Enable the Dalamud plugin, then start the Playdate game, in that exact order\n\nCongrats - you can now rethink your life choices. It is suggested to disable the plugin before closing the game.\n\n## Controls\n\n- Undock the crank to use Cast\n- Dock the crank to use Quit\n- Crank to use Hook\n  - If you use Patience, the speed you crank at determines whether to use Precision Hookset or Powerful Hookset\n\n## Contributing\n\nFirst, don't.\n\nSecond, I work on the Playdate part in Visual Studio Code and the FFXIV part in JetBrains Rider. If you're contributing to the Lua part, consider making a `.vscode/settings.json` like the following, to silence some annoying errors:\n\n```json\n{\n  \"Lua.workspace.library\": [\n    \"\u003cpath to your playdate SDK\u003e/CoreLibs\",\n    \"playdate/annotations.lua\"\n  ],\n  \"Lua.diagnostics.globals\": [\n    \"playdate\",\n    \"fishing\",\n    \"input\",\n    \"log\",\n    \"json\"\n  ],\n  \"Lua.runtime.special\": {\n    \"import\": \"require\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotnite%2Fplaydate-fishing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotnite%2Fplaydate-fishing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotnite%2Fplaydate-fishing/lists"}