Skip to content
RNUEReact Native for Unreal Engine
GitHub

Package Registry

How to set up the rnue package registry

On this pageUsing the package registry

The JavaScript portion of rnue is packaged and distributed as scoped npm packages under the @rnue namespace. The package registry is hosted on npm.rnue.dev.

Using the package registry

To use react-native-unreal in a project you need to configure your package manager to use the rnue package registry for all the @rnue/* scoped packages.

  1. Do you have credentials?

    To work with the rnue package registry, you will need a username and password. If you don't have one, please contact the team to request credentials to be provisioned for you.

  2. Login to the registry

    bash
    npm login --registry=https://npm.rnue.dev/

    After running the above command, you will be prompted for your username and password.

    The login command will typically put the resulting authentication token in an .npmrc file located in your operating system's user home directory (for example /home/johndoe/.npmrc on macOS or C:\Users\JohnDoe\.npmrc on Windows).

    You can ensure that the command properly persisted your token by checking the contents of the user .npmrc file. It should look something like this:

    plaintext
    //npm.rnue.dev/:_authToken=YOUR_AUTH_TOKEN_HERE

    Where YOUR_AUTH_TOKEN_HERE is the actual authentication token you received from the login command.

  3. Create an .npmrc file

    The file must be placed in the root of your package or workspace. This .npmrc file needs to exist in the root of every package or workspace that uses react-native-unreal.

    .npmrc file contents:

    plaintext
    @rnue:registry=https://npm.rnue.dev/

    Read the npm docs for more information on using .npmrc files.

  4. Verify your configuration

    If everything was set up correctly, you should be able to add a dependency to any @rnue/* scoped package or run the @rnue/cli command.

    The simplest way to make sure everything works is to run:

    bash
    npx @rnue/cli

    The terminal shows the following output:

    Terminal
    │
■  Please specify a command