Add npm packaging #98
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I've set up the project for NPM packaging of the Node.js client. Key changes include: - Updates `src/node-client/index.js` to export System, Node, and World. - Modifies `scripts/build-node-client.mjs` to: - Output to `dist/npm/`. - Copy PhysX assets to `dist/npm/vendor/`. - Generate a `package.json` for the NPM package in `dist/npm/`. - Generate a fallback `index.d.ts` in `dist/npm/` (automated generation via dts-bundle-generator failed when I checked it). - Adds `typescript` and `dts-bundle-generator` as devDependencies. - Updates the main `package.json` with a `publish:node` script and adds `dist/npm/` to the `files` array. - Adds a GitHub Actions workflow (`.github/workflows/npm-publish.yml`) to automate publishing to NPM on new GitHub releases. - Updates `README.md` with installation and publishing instructions. Note: Further work is required to address: - A runtime error "navigator is not defined" when using the client in Node.js. - Issues with the accuracy and completeness of the generated `index.d.ts` TypeScript definitions. This commit includes all preparatory work up to the point of encountering these critical issues when I checked it.
Export required modules for plugin-hyperfy
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds npm packaging and publishing for hyperfy, at least for the Node client. Includes limited Typescript support. Requires some more testing, but pushing the draft for feedback