Skip to content

Place Management Guide

Create and manage rooms, capsules and objects.

Commands here are node verbs. Type them as shown over SSH, or in the Urchin client's command mode (add / in chat mode). Commands that start with / exist only in the client.

How Places Fit Together

  • HOME is your personal root space, created at your first login. You are always its Steward.
  • Halls are community hubs you found for a group with found hall <name>.
  • Zones divide HOME and each Hall into Public, Common and Private areas.
  • Rooms are where people gather. They live inside a zone and connect by exits.

The User Manual covers Halls, Standing and entry to a Hall.

Look Around

look
look <thing>
place

look (or l) describes where you are. look <thing> examines one thing. place gives a structured read of the current place, with its kind, the rooms and zones under it, its exits and their destinations, and what it holds.

Move

go <exit>
home

go moves you through an exit. The directions have shortcuts (n, s, e, w, ne, nw, se, sw, up, down). home returns you to your HOME.

Create a Room

Rooms live inside zones. Stand in a zone first, then create the room:

go public
create ~room garden --desc A quiet place to talk

create ~room <name> makes a room connected to where you stand, with exits both ways. --from <exit> and --to <return> name those two exits, and --desc sets the description. Creating a room from your HOME's hub or a Hall's hub is refused, with a hint naming the zones you can enter.

In the Urchin client, /create-room-wiz does the same from a dialog, offered only inside a zone.

Describe a Room

describe room garden A quiet place to talk

Manage Exits

Add an Exit

exits garden add north courtyard
exits garden add north courtyard --oneway

exits <room> add <exit_name> <target_room> adds an exit from one room to another. --oneway makes a one-way passage.

Remove an Exit

exits garden remove north

look in a room lists its exits.

Share a Room

share room garden

share room <room> opens a presence for the room so others can reach it. It does not move you into the room. You stay where you are.

Who may enter a shared room, and how the room's owner lets people in, is still changing.

Delete a Room

destroy room garden

destroy room <name> removes a room in the zone you are in. You must be a Steward of the place that contains it. destroy hall <name> removes a Hall in your HOME's Common zone, with its rooms. Leave the Hall before you destroy it.

There is no command to rename a room.

Capsules

A capsule is a container that others reach only through capabilities you grant. It is the unit of sharing.

Create a Capsule

create ~capsule notes

List Capsules

list capsules

View Capsule Contents

peer notes

peer <capsule> (or inspect <capsule>) lists what a capsule holds, apart from people.

Describe a Capsule

describe capsule notes Shared notes for the band

Share a Capsule

share capsule notes
share capsule notes --no-presence

Only a capsule's owner can share it. Sharing a capsule opens a presence for it and moves you into that presence, unlike a room share. Add --no-presence to share it without that. share capsule <name> revoke withdraws the share.

Delete a Capsule

destroy capsule notes
destroy capsule notes --force

A capsule that still holds objects needs --force.

Capability Management

Grant Access

grant notes alex#9T3HVB read,write

grant <capsule> <identity> <caps> grants capabilities on a capsule you own. Add --service <service> to grant them on one service only.

Revoke Access

revoke notes alex#9T3HVB

With no capabilities named, revoke removes them all.

List Access

list grants notes

Services

A capsule can carry services that other people call over the network.

service add notes echo
service list notes
service remove notes echo
service invoke mira#4Q7K2M <method> <capsule>

The service templates are echo, ping and inventory.

Objects

Create an Object

create ~object lantern

The new object goes into your inventory.

Carry and Place Objects

get lantern
drop lantern
put lantern in notes
inventory

get (or take) picks an object up, drop puts it down where you stand, and put <item> in <container> places it in a container. inventory (or i) shows what you carry.

Describe an Object

describe object lantern short A brass lantern

Delete an Object

destroy lantern

Where Places Are Kept

The node keeps its world in its data directory, ~/.local/share/kunuleco/data/ on an installed Linux node and %LOCALAPPDATA%\Kunuleco\data\ on Windows. There is no save command and no command to export or restore places. export-identity backs up your identity only.