yourturn-template: Instructions file for Codex

yourturn-template

This is a template for implementing an online turn-based game web app using a library called yourturn (https://jsr.io/@brandonhorst/yourturn). It uses Deno Fresh v2, Preact v10, Tailwind v4, DaisyUI v5.

Implementing Games

Games are built with game logic in the game directory, by implementing yourturn types. Before starting, access the yourturn type documentation by running this shell command: deno doc jsr:@brandonhorst/yourturn/types. You will need to use these types to build the game.

For the processMove function and the optional refresh function, it is highly recommended to use immer library (as shown in all examples). Also, use the Deno Standard Library when necessary. @std/random is particularly useful for games.

The UI is built using Preact views. These views live in the components directory. The root views are GameView in gameviews.tsx, and LobbyView in lobbyviews.tsx.

After creating a game, makes sure to lint/typecheck it and fix errors.

Commands

• Lint/Typecheck: deno lint
• Test: deno test
• Format: deno fmt

Project Structure

• Fresh/Deno project, routes, islands, components, and static are all standard Deno Fresh directories.
• Deno KV database is used for persistent storage, but this is handled by the yourturn library itself.
• WebSockets are used for game state communication, but this is handled by the yourturn library itself.

In general, to build a game, the islands and routes directories will not need to be touched. They govern the URL structure of the pages and WebSockets. If you do need to modify them in order to change the URL structure or something like that, you can access the documentation with one of these shell commands: deno doc jsr:@brandonhorst/yourturn/server, deno doc jsr:@brandonhorst/yourturn/hooks.