From aece40be6030508557f12f353c97727ced064edc Mon Sep 17 00:00:00 2001 From: Nolan Hellyer Date: Tue, 22 Jul 2025 17:52:24 -0700 Subject: [PATCH] create readme and deno.json file --- deno.json | 5 +++++ readme.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 deno.json create mode 100644 readme.md diff --git a/deno.json b/deno.json new file mode 100644 index 0000000..850a072 --- /dev/null +++ b/deno.json @@ -0,0 +1,5 @@ +{ + "tasks": { + "start": "deno main.ts" + } +} \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..1bcb0ee --- /dev/null +++ b/readme.md @@ -0,0 +1,33 @@ +# Detective + +Detective is a JavaScript (Deno) program for writing and running interactive +fiction. The writer creates a JSON document with a specific structure that +describes rooms, objects, events, etc. They can then run the program with Deno +and play through the result. + +## Installation + +Detective is written for [Deno](https://deno.com), which is required. See +installation instructions +[here](https://docs.deno.com/runtime/getting_started/installation). + +Once you have Deno and the repo, you can run `deno task start` from inside the +project, and the little demo story should start. + +## Commands + +Currently, the commands are very simple. + +`inventory` checks the players inventory. + +`go {direction}` moves the player in the given direction. + +`take {item}` picks up the given item. + +`use {item}` uses the given item. + +`quit` exits the program. + +## Writing your own story + +The format for the JSON file is shown in more detail in the