{"id":20815564,"url":"https://github.com/deepnight/presskit","last_synced_at":"2025-07-04T11:06:55.080Z","repository":{"id":98934450,"uuid":"403050647","full_name":"deepnight/presskit","owner":"deepnight","description":"Static press kit generator for Haxe","archived":false,"fork":false,"pushed_at":"2022-02-28T10:22:43.000Z","size":2798,"stargazers_count":6,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-06T03:03:18.181Z","etag":null,"topics":["game-development","haxe","presskit"],"latest_commit_sha":null,"homepage":"","language":"Haxe","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/deepnight.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}},"created_at":"2021-09-04T12:28:05.000Z","updated_at":"2024-08-15T21:49:13.000Z","dependencies_parsed_at":"2023-03-06T19:00:38.265Z","dependency_job_id":null,"html_url":"https://github.com/deepnight/presskit","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/deepnight/presskit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepnight%2Fpresskit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepnight%2Fpresskit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepnight%2Fpresskit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepnight%2Fpresskit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepnight","download_url":"https://codeload.github.com/deepnight/presskit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepnight%2Fpresskit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260817084,"owners_count":23067435,"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":["game-development","haxe","presskit"],"created_at":"2024-11-17T21:24:02.034Z","updated_at":"2025-06-19T19:37:14.802Z","avatar_url":"https://github.com/deepnight.png","language":"Haxe","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Presskit for Haxe\n\nPresskit is a simple Haxe library that generates static HTML presskits from either XML or JSON source files.\n\n - Use either XML (recommended) or JSON to feed a HTML template.\n - Everything can be customized.\n - Basic **Markdown** is supported: **bold**, *italic*, ~~striked~~, [links](#nope), lists and nested lists.\n\nYou can see an example of a generated presskit here:\n\nhttps://deepnight.net/files/presskit/nuclearBlaze/\n\n\n\n# Installation\n\nYou need [Haxe](https://haxe.org) to run this library.\n\nInstall the lib:\n```\nhaxelib install presskit\n```\n\n\n\n# Usage\n\n## Method 1 - Use the existing default HTML template\n\nGenerate an empty Presskit file in your prefered format.\n\n**XML (recommended):**\n```\nhaxelib run presskit -extract myPresskit.xml\n```\n\n**JSON:**\n```\nhaxelib run presskit -extract myPresskit.json\n```\n*Why is XML recommended over JSON in 2021 you might wonder? Simply because the ouput is an HTML file, and XML format is more convenient for this exact purpose.*\n\nNow just edit your presskit file and fill in the fields.\n\nWhen you're ready to generate your HTML presskit page, run the following command:\n\n```\nhaxelib run presskit -html myPresskit.xml [-zip]\n```\n\nThe `-html` indicates to switch to HTML generation mode.\n\nThe optional `-zip` argument will generate a ZIP archive and add a \"Download everything as ZIP\" to the HTML page.\n\n## Method 2 - Create your own HTML template first\n\n### Custom HTML template\n\nCreate some HTML file containing variables named like `%productName%`. It's a good idea to start from the existing [default HTML template](tpl/default.html). Don't forget to grab the CSS along with it.\n\n```html\n\u003cdiv class=\"presskit\"\u003e\n\t\u003ch2\u003eFactsheet\u003c/h2\u003e\n\t\u003cdl\u003e\n\t\t\u003cdt\u003eProduct name\u003c/dt\u003e\n\t\t\u003cdd\u003e%productName%\u003c/dd\u003e\n\n\t\t\u003cdt\u003eDeveloper\u003c/dt\u003e\n\t\t\u003cdd\u003e%companyName%\u003c/dd\u003e\n\t\u003c/dl\u003e\n\u003c/div\u003e\n```\n\nRun this command to extract all variables (eg. `%productName%`) and build a XML or JSON out of it:\n\n\n```xml\n\u003cproductName\u003e\u003c/productName\u003e\n\u003ccompanyName\u003e\u003c/companyName\u003e\n```\n\n### Syntax of HTML template variables\n\nYour variable names can contain `/` (slashes) to create some hierarchy in your presskit file:\n```html\n\u003cdiv class=\"presskit\"\u003e\n\t\u003ch2\u003e%product/name%\u003c/h2\u003e\n\t\u003cdiv class=\"desc\"\u003e\n\t\t%product/desc%\n\t\u003c/div\u003e\n\u003c/div\u003e\n```\n\n**XML:**\n```xml\n\u003cproduct\u003e\n\t\u003cname\u003e\u003c/name\u003e\n\t\u003cdesc\u003e\u003c/desc\u003e\n\u003c/product\u003e\n```\n\nThere are a few special **reserved** variable names for your template:\n\n - `%zip/status%`: this will contain either \"on\" or \"off\", depending on the `-zip` argument being used or not. This is used to add a CSS class to the \"Download ZIP\" button, to either show or hide it.\n - `%zip/path%`: relative path to the generated ZIP file.\n\n### Build your final HTML presskit\n\nYou can then fill this file, and build your HTML final presskit using:\n\n```\nhaxelib run presskit -html myPresskitFile.xml myCustomTemplate.html\n```\n\n\n\n# Example\n\nHTML template:\n```html\n\u003chtml lang=\"en\"\u003e\n\t\u003chead\u003e [...] \u003c/head\u003e\n\n\t\u003cbody\u003e\n\t\t\u003cdiv class=\"presskit\"\u003e\n\t\t\t\u003ch2\u003e %game/title% (by %company/name%)\u003c/h2\u003e\n\t\t\t\u003cdiv class=\"desc\"\u003e %game/desc% \u003c/div\u003e\n\t\t\t\u003cdiv class=\"desc\"\u003e Website: %game/url% \u003c/div\u003e\n\t\t\u003c/div\u003e\n\t\u003c/body\u003e\n\u003c/html\u003e\n```\n\nIts corresponding XML:\n```xml\n\u003cgame\u003e\n\t\u003ctitle\u003e Nuclear Blaze \u003c/title\u003e\n\n\t\u003curl\u003e [Steam page](https://store.steampowered.com/app/1662480) \u003c/url\u003e\n\n\t\u003cdesc\u003e\n\t\t\u003cimg src=\"img/keyart.png\"/\u003e\n\n\t\tA **unique** 2D firefighting game from the creator of **[Dead Cells](https://deadcells.com)**, with all the devastating backdrafts, exploding walls and sprinklers you could expect.\n\n\t\t- This game is cool,\n\t\t- Another bullet point,\n\t\t- And a last one.\n\t\u003c/desc\u003e\n\u003c/game\u003e\n\n\u003ccompany\u003e\n\t\u003cname\u003e Deepnight Games \u003c/name\u003e\n\u003c/company\u003e\n```\n\nOr JSON:\n```JSON\n{\n\t\"game\": {\n\t\t\"title\": \"Nuclear Blaze\",\n\t\t\"url\": \"[Steam page](https://store.steampowered.com/app/1662480)\",\n\t\t\"desc\": [\n\t\t\t'\u003cimg src=\"img/keyart.png\"/\u003e',\n\t\t\t'A **unique** 2D firefighting game from the creator of **[Dead Cells](...)**, with all the devastating backdrafts, exploding walls and sprinklers you could expect.',\n\n\t\t\t'- This game is cool',\n\t\t\t'- Another bullet point',\n\t\t\t'- And a last one'\n\t\t]\n\t},\n\t\"company\": {\n\t\t\"name\": \"Deepnight Games\"\n\t}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepnight%2Fpresskit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepnight%2Fpresskit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepnight%2Fpresskit/lists"}