{"id":47856445,"url":"https://github.com/kelpycode/vuetale","last_synced_at":"2026-06-01T03:01:21.299Z","repository":{"id":346687603,"uuid":"1191142377","full_name":"KelpyCode/Vuetale","owner":"KelpyCode","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-03T02:59:41.000Z","size":706,"stargazers_count":7,"open_issues_count":12,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-03T04:08:15.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/KelpyCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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":"AGENTS.md","dco":null,"cla":null},"funding":{"github":null,"patreon":null,"open_collective":"Vuetale","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2026-03-25T00:42:05.000Z","updated_at":"2026-05-03T02:59:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/KelpyCode/Vuetale","commit_stats":null,"previous_names":["kelpycode/vuetale"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/KelpyCode/Vuetale","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelpyCode%2FVuetale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelpyCode%2FVuetale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelpyCode%2FVuetale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelpyCode%2FVuetale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KelpyCode","download_url":"https://codeload.github.com/KelpyCode/Vuetale/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelpyCode%2FVuetale/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33757790,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2026-04-03T22:50:19.469Z","updated_at":"2026-06-01T03:01:21.262Z","avatar_url":"https://github.com/KelpyCode.png","language":"JavaScript","funding_links":["https://opencollective.com/Vuetale","https://opencollective.com/hytalemodding"],"categories":[],"sub_categories":[],"readme":"# Vuetale\n\n\u003e 🧙 Sponsord by [Hytale Modding Grant Program](https://opencollective.com/hytalemodding)\n\n**Build Hytale mod UIs with Vue 3, TypeScript, and Kotlin/Java.**\n\nVuetale is a Hytale mod library that brings modern frontend development to Hytale mod interfaces. Write reactive,\ncomponent-based UIs in Vue SFCs, compile them through Vite, and drive them from your Kotlin/Java mod code — all with\nfull type safety.\n\n[Vuetale Discord](https://discord.gg/affkepndn7)\n\n---\n\n## How It Works\n\nVuetale embeds a Node.js/V8 engine inside your mod's JVM process. Vue components are compiled by Vite at build time and\noutput as JavaScript bundles into your mod's `src/main/resources/vuetale/` folder. At runtime, Vue's render output is\ntranslated through a custom bridge into native Hytale UI elements — no HTML, no CSS parsing, no browser involved.\n\n```\nVue SFC  →  Vite build  →  resources/vuetale/\u003cmodule\u003e/  →  loaded by JVM mod  →  native Hytale UI\n```\n\n---\n\n## Features\n\n- **Vue 3 SFCs** — write `.vue` files with `\u003cscript setup\u003e`, composables, and full reactivity\n- **Kotlin/Java API** — open pages and push reactive data from server-side mod code\n- **TypeScript types** — companion CLI extracts type definitions from JARs for IDE support\n- **Hot reload** — iterate on UI without restarting the server\n- **Tailwind CSS** — Tailwind v4 supported out of the box in the starter project\n- **Per-player isolation** — each player gets their own Vue app instance\n\n---\n\n## Quick Start\n\n\u003e For an in-depth guide, see the [Getting Started Guide](https://kelpycode.github.io/vuetale-docs/docs/getting-started).\n\n### 1. Get Vuetale\n\nDownload from either\n\n* [GitHub Releases](https://github.com/KelpyCode/Vuetale/releases)\n* [Modtale](https://modtale.net/mod/vuetale)\n* [Curseforge](https://www.curseforge.com/hytale/mods/vuetale)\n\n### 2. Clone the starter project\n\n```bash\ngit clone git@github.com:KelpyCode/vuetale-starter.git --recurse-submodules my-mod-project\ncd my-mod-project\nrm -rf .git\nrm -rf src/ui/.git\n```\n\n### 3. Place the JAR\n\nCopy `Vuetale-*.jar` to `lib/Vuetale.jar`.\n\n### 4. Validate the server (IntelliJ)\n\n1. Sync Gradle dependencies.\n2. Run `runServer`.\n3. Copy `Vuetale.jar` into `run/mods/`.\n4. Rerun the server and type `/vuetale` in chat — you should see the test UI.\n\n### 5. Set up the UI project (VS Code → `src/ui`)\n\n```bash\npnpm install\npnpm vt config server-mods \u003cabsolute-path-to-run/mods\u003e\npnpm vt config resources \u003cpath-to-src/main/resources\u003e\npnpm vt extract\npnpm vt dev true\npnpm watch\n```\n\nThat's it. Vite watches your Vue files and outputs compiled bundles into `src/main/resources/vuetale/\u003cmodule\u003e/`, which\nthe server picks up automatically.\n\n---\n\n## Usage\n\n### Register your module (Kotlin)\n\n```kotlin\n// In your plugin setup function\nModuleRegistry.registerModule(\"myMod\", Plugin::class.java)\n```\n\n### Open a UI page for a player\n\n```kotlin\nval ui = PlayerUiManager.openPage(\n    playerRef,\n    ref as Ref\u003cEntityStore\u003e,\n    store as Store\u003cEntityStore\u003e,\n    \"myMod\",   // matches vuetale-plugin.json name\n    \"TestPage\" // matches src/ui/lib/pages/TestPage.vue\n)\n\n// Push data to the Vue page\nui.setData(\"playerName\", \"Steve\")\nui.setData(\"health\", 20)\nui.setData(\"items\", listOf(\"Sword\", \"Shield\", \"Potion\"))\n```\n\nAny serializable value works — primitives, lists, maps, and data classes.\n\n### Consume data in Vue\n\n```html\n\n\u003cscript setup lang=\"ts\"\u003e\n    import { useData } from 'vt:@core/composables/useData'\n    import { Common } from 'vt:@core/components/Common'\n    \n    const playerName = useData\u003cstring\u003e('playerName', 'Unknown')\n    const items = useData\u003cstring[]\u003e('items', [])\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n    \u003cCommon.DecoratedContainer :anchor=\"{ Width: 500, Height: 300 }\"\u003e\n        \u003ctemplate #title\u003e\n            \u003cCommon.Title :text=\"`${playerName}'s Inventory`\"/\u003e\n        \u003c/template\u003e\n        \u003ctemplate #content\u003e\n            \u003cGroup layout-mode=\"TopScrolling\" :anchor=\"{ Full: 1 }\"\u003e\n                \u003cCommon.TextButton\n                        v-for=\"item in items\"\n                        :key=\"item\"\n                        :text=\"item\"\n                        @activating=\"() =\u003e console.log(item)\"\n                /\u003e\n            \u003c/Group\u003e\n        \u003c/template\u003e\n    \u003c/Common.DecoratedContainer\u003e\n\u003c/template\u003e\n```\n\n---\n\n## Requirements\n\n| Tool    | Version |\n|---------|---------|\n| Java    | 25      |\n| Kotlin  | 2.x     |\n| Node.js | 20+     |\n| pnpm    | any     |\n| Vue     | 3.5+    |\n| Vite    | 7+      |\n\n---\n\n## Related Projects\n\n| Project                                                             | Description                                            |\n|---------------------------------------------------------------------|--------------------------------------------------------|\n| [vuetale-starter](https://github.com/KelpyCode/vuetale-starter)     | Starter template with Gradle + Vite setup              |\n| [vuetale-companion](https://github.com/KelpyCode/vuetale-companion) | CLI for project setup, type extraction, and hot reload |\n| [vuetale-docs](https://github.com/KelpyCode/vuetale-docs)           | Full documentation site                                |\n\n---\n\n## Documentation\n\nFull guides, API reference, and CLI docs at the documentation site.\n\n- [Getting Started](https://kelpycode.github.io/vuetale-docs/docs/getting-started)\n- [Kotlin API](https://kelpycode.github.io/vuetale-docs/docs/api/kotlin)\n- [Vue API](https://kelpycode.github.io/vuetale-docs/docs/api/vue)\n- [Companion CLI](https://kelpycode.github.io/vuetale-docs/docs/cli/companion-cli)\n- [Troubleshooting](https://kelpycode.github.io/vuetale-docs/docs/troubleshooting)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelpycode%2Fvuetale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelpycode%2Fvuetale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelpycode%2Fvuetale/lists"}