Add npm publishing support for @ucl-vr/ubiq and @ucl-vr/ubiq-server#64
Merged
Add npm publishing support for @ucl-vr/ubiq and @ucl-vr/ubiq-server#64
Conversation
Set up both Node packages for publishing to npm under the @UCL-VR scope at v1.0.0, with a tag-triggered CI workflow and updated documentation.
anthonysteed
approved these changes
Mar 22, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The Ubiq Node server and core messaging library have not previously been published to npm. This PR introduces everything needed to publish them under the
@ucl-vrscope, enabling developers to install and integrate them as dependencies in their own Node.js projects. This PR closes #63 upon merging.The codebase was already structured as two separate packages internally, and this publishing approach preserves that separation:
@ucl-vr/ubiq— The core messaging and networking library for the Ubiq platform. It provides connection management, message passing, and network scene abstractions over TCP and WebSocket. This package is intended for developers who want to build custom applications or services on top of the Ubiq messaging layer without running a full room server.@ucl-vr/ubiq-server— The complete Ubiq room server, which depends on@ucl-vr/ubiqand adds room management, rendezvous, peer-to-peer signalling, and ICE server coordination. This is the package to install when hosting a server that Unity and browser clients connect to.Maintaining this separation allows lightweight consumers — such as bots, data loggers, or custom services — to depend only on the core library without pulling in the full server and its dependencies. This PR updates the version numbers of each package to 1.0.0, which will be separately versioned from the Unity package. For future Ubiq package releases, the recommended/minimal Ubiq server version could be listed.
Key Changes
node-v*tags that builds and publishes both packages to npm in dependency orderbinentry point (ubiq-server) so the server can be started directly withnpx @ucl-vr/ubiq-serveror after a global install, without cloning the repositorydescriptionfields in both package.json files to more accurately reflect the purpose of each packagenpxusage as alternatives to cloning the repository