{"id":41173348,"url":"https://github.com/technix/atrament-web","last_synced_at":"2026-01-22T19:47:49.733Z","repository":{"id":194322902,"uuid":"688861132","full_name":"technix/atrament-web","owner":"technix","description":"Atrament engine for web browsers","archived":false,"fork":false,"pushed_at":"2025-10-16T08:21:18.000Z","size":2070,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-30T22:52:47.290Z","etag":null,"topics":["choice-based-game","game-development","ink","interactive-fiction","javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/technix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-08T09:00:13.000Z","updated_at":"2025-10-16T08:21:22.000Z","dependencies_parsed_at":"2024-06-25T22:50:25.553Z","dependency_job_id":"5a2c9a1e-92e7-4213-ba2d-58da659d41f4","html_url":"https://github.com/technix/atrament-web","commit_stats":null,"previous_names":["technix/atrament-web"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/technix/atrament-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technix%2Fatrament-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technix%2Fatrament-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technix%2Fatrament-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technix%2Fatrament-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/technix","download_url":"https://codeload.github.com/technix/atrament-web/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technix%2Fatrament-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28669697,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T19:36:09.361Z","status":"ssl_error","status_checked_at":"2026-01-22T19:36:05.567Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["choice-based-game","game-development","ink","interactive-fiction","javascript"],"created_at":"2026-01-22T19:47:48.982Z","updated_at":"2026-01-22T19:47:49.724Z","avatar_url":"https://github.com/technix.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Atrament\r\n\r\n`atrament-web` is a browser build of `atrament-core`, a framework for choice-based games, built around `inkjs`. \r\n\r\nIf you want to make customized Atrament build, check out [atrament-core](https://github.com/technix/atrament-core).\r\n\r\nIf you are looking for example of a web application based on Atrament, check out [atrament-web-ui](https://github.com/technix/atrament-web-ui).\r\n\r\n## Installation\r\n\r\n```npm install @atrament/web```\r\n\r\nor\r\n\r\n```\u003cscript src=\"https://unpkg.com/@atrament/web@2.1.3/umd/atrament.js\"\u003e\u003c/script\u003e```\r\n\r\n## Usage\r\n\r\nInitialization and game start:\r\n```\r\nimport atrament from '@atrament/web';\r\n\r\natrament.init({\r\n    applicationID: 'your-application-id',\r\n    settings: {}\r\n});\r\n\r\nawait atrament.game.init('/path/to', 'inkfile.ink.json');\r\nawait atrament.game.start();\r\natrament.game.continueStory();\r\n```\r\n\r\nState in components:\r\n\r\n```\r\nimport { useStore } from '@nanostores/preact';\r\n\r\nconst gameState = useStore(atrament.store);\r\n```\r\n\r\n## API Documentation\r\n\r\nSee [Atrament core documentation](https://github.com/technix/atrament-core/blob/master/README.md).\r\n\r\n## Components\r\n\r\n- loader: fetch + fflate/jszip\r\n- persistent: [localForage](https://github.com/localForage/localForage) / Neutralinojs storage\r\n- state: [nanostores](https://github.com/nanostores/nanostores)\r\n- sound: [howler.js](https://github.com/goldfire/howler.js)\r\n- platform: web / Neutralinojs\r\n\r\n## LICENSE\r\n\r\nAtrament is distributed under MIT license.\r\n\r\nCopyright (c) 2023 Serhii \"techniX\" Mozhaiskyi\r\n\r\nMade with the support of the [Interactive Fiction Technology Foundation](https://iftechfoundation.org/)\r\n\r\n\u003cimg src=\"https://iftechfoundation.org/logo.svg\" width=\"200px\"\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnix%2Fatrament-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechnix%2Fatrament-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnix%2Fatrament-web/lists"}