{"id":25181689,"url":"https://github.com/jannone/textadv","last_synced_at":"2026-04-28T11:02:53.034Z","repository":{"id":65370060,"uuid":"538273729","full_name":"jannone/textadv","owner":"jannone","description":"Text Adventures generator from Markdown files","archived":false,"fork":false,"pushed_at":"2022-10-22T22:50:53.000Z","size":992,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T15:38:49.954Z","etag":null,"topics":["adventure","adventures","basic","msx","text"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jannone.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}},"created_at":"2022-09-18T23:59:52.000Z","updated_at":"2024-10-11T00:28:01.000Z","dependencies_parsed_at":"2023-01-20T08:31:22.441Z","dependency_job_id":null,"html_url":"https://github.com/jannone/textadv","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/jannone%2Ftextadv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannone%2Ftextadv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannone%2Ftextadv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannone%2Ftextadv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jannone","download_url":"https://codeload.github.com/jannone/textadv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246975940,"owners_count":20862991,"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":["adventure","adventures","basic","msx","text"],"created_at":"2025-02-09T17:18:37.499Z","updated_at":"2026-04-28T11:02:47.992Z","avatar_url":"https://github.com/jannone.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# textadv\n\nText Adventures generator from Markdown files.\n\n\u003e Note: this is prototype app without proper unit tests.\n\u003e Use it at your own risk!\n\n```\nUsage:\n  $ textadv \u003ccommand\u003e [options]\n\nCommands:\n  gen \u003cfile\u003e  Generates Text Adventure from a Markdown file\n  run \u003cfile\u003e  Runs Text Adventure from a Markdown file\n\nFor more info, run any command with the `--help` flag:\n  $ textadv gen --help\n  $ textadv run --help\n\nOptions:\n  -h, --help  Display this message \n```\n\n## File Format\n\n### Project declaration\n\nDeclare your project's name and intro at the root level:\n\n```\n# Haunted House\n\nThis is the intro to this awesome adventure!\n\nLet's dive in!\n```\n\nYou can optionally start your file with a meta-information block:\n```\n---\ntitle: Haunted House\nauthor: John Doe \u003cjohn.doe@example.com\u003e\n---\n```\n\n### Locations\n\nDeclare each location as a second-level text with a pin emoji:\n```\n## 📍 Uncle's house\n\nYou are at your uncle's house.\n\nThe dog is restless and you hear a sound coming from the kitchen.\n```\n\nSometimes you'll prefer to use a short identifier for your location (when using the `goto` command, for instance). This can be done via the `[...]` marker as seen below:\n\n```\n## 📍 Uncle's Kitchen [kitchen]\n\nThere is no one here...\n\nThe trash can is moving!\n```\n\n### Interactions\n\nAfter declaring a location's description, add possible interactions as bullet-point lists:\n\n```\n- go kitchen\n  - \"You hold your breath for a moment and decide do check the kitchen\"\n  - goto kitchen\n- stand still\n  - \"You decide it's better to stay quiet and watch your surroundings\"\n```\n\nEach bullet point is matched against the players input. When a match is found, it will start executing the second-level bullet-points, and stop when those are finished (unless explicitly instructed otherwise by [Commands](#commands) and [Checks](#checks))\n\nYou can have one single bullet-point match against lots of input variations.\nExample:\n```\n- check/examine dog/beagle/buddy\n  - \"Buddy is moving around the room in a very unusual way\"\n- hear/check sound(s)/noise; pay attention \n  - \"This is nothing like you've heard before\"\n```\n\nSecond-level bullet-points can be of 3 types: [messages](#messages), [commands](#commands), or [checks](#checks).\n\n#### Messages\n\nA message is just a quoted text:\n```\n\"You hold your breath for a moment and decide do check the kitchen\"\n```\n\n#### Commands\n\nA command can change the state of the game.\n\nCommand's reference list:\n\n- goto \\\u003croom\u003e: Move player to the room with the specified ID\n- set \\\u003cflag\u003e: Set the named flag as 1 \n- clear \\\u003cflag\u003e: Clear the named flag back to 0 \n- continue: Continue processing the next bullet\n- check-room: Re-introduce the room to the player\n\n#### Checks\n\nA check will test the condition and skip to the next bullet when the condition is false.\n\nCheck's reference list:\n\n- zero \\\u003cflag\u003e: Check if the flag equals 0\n- notzero \\\u003cflag\u003e: Check if the flag is different from 0 \n\n### Objects\n\nTODO\n\n## Using multiple files\n\nYou can split your adventure into multiple markdown files by using the `extends` keyword.\n\n```\n[extends](./another-file.md)\n```\n\nThis will instantly load the referenced file (in parenthesis) and add its contents to each declared section.\n\nThis means you can have multiple files adding descriptions and commands to the same previously declared sections, in effect \"extending\" them.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjannone%2Ftextadv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjannone%2Ftextadv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjannone%2Ftextadv/lists"}