npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

create-unimud-client

v0.0.5

Published

Project skeleton generator for MUD into Unity with UniMUD

Downloads

73

Readme

create-unimud-client

create-unimud-client is an opinionated Unity project generator for MUD v2 projects that wraps UniMUD. You can use it to add Unity support for existing MUD projects, or create the scaffold for a new MUD project and Unity frontend.

Generated Unity projects provide:

  • Player spawning
  • Player movements using arrows
  • Optional VR reality support for Meta Quest 2

Quickstart

# Go to the root of your MUD project
cd /PATH/TO/MUD/PROJECT/ROOT

# Install create-unimud-client
npm install -g create-unimud-client

# Generate Unity scaffold
npx create-unimud-client generate

# Alternatively, run from anywhere
npx create-unimud-client generate --path /PATH/TO/MUD/PROJECT/ROOT

# Install new dependencies
pnpm i

# Code generation
pnpm run initialize

Starting the app will depend on the project specifics. A typical flow may be:

  • Start the blockchain locally: dev mud:node
  • Deploy: cd packages/contracts && pnpm run dev:local
  • Optionally start frontend: pnpm run dev:client

Prerequisites

create-unimud-client supports the following MUD tables. Each section corresponds to an entry in mud.config.ts

  • Spawnable players
Player: "bool"
  • Player position
Position: {
    schema: {
        x: "int32",
        y: "int32",
    }
}

Options

Enable VR

npx create-unimud-client generate --vr

Do not modify package.json

Use this option with tankmud

npx create-unimud-client generate --skipPackageJson

Setting up VR / Meta Quest 2

Follow the official instructions to setup a headset.

When Unity is openend for the first time, you may notice errors: UnityException: creating Asset path at. Ignore those and switch the build target to Android. You can now run in Unity Editor.

Contributing

Releasing

npm version 0.0.0
npm publish