From bf7eb97d3d7bac5dce357ca20702462ec72ab91b Mon Sep 17 00:00:00 2001 From: Stephen Birarda Date: Wed, 5 Mar 2014 16:04:01 -0800 Subject: [PATCH] simplify the README instructions for running own world --- README.md | 48 +++++++++++++----------------------------------- 1 file changed, 13 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 0577aa867d..64d65de87d 100644 --- a/README.md +++ b/README.md @@ -39,59 +39,37 @@ To move around in-world, use the arrow keys (and Shift + up/down to fly up or down) or W A S D, and E or C to fly up/down. All of the other possible options and features are available via menus in the Interface application. -Other components +Full virtual world stack ======== The assignment-client and domain-server are architectural components that will allow -you to run the full stack of the virtual world should you choose to. - - -I want to run my own virtual world! -======== +you to run the full stack of the virtual world. In order to set up your own virtual world, you need to set up and run your own -local "domain". At a minimum, you must run a domain-server, voxel-server, -audio-mixer, and avatar-mixer to have a working virtual world. The domain server gives three different types of assignments to the assignment-client: audio-mixer, avatar-mixer and voxel server. +local "domain". -Complete the steps above to build the system components, using the default Cmake Unix Makefiles generator. Start with an empty build directory. +The domain-server gives a number different types of assignments to the assignment-client for different features: audio, avatars, voxels, particles, and meta-voxels. - cmake .. +Follow the instructions in the [install guide](INSTALL.md) to build the various components. -Then from the Terminal -window, change directory into the build directory, make the needed components, and then launch them. +From the domain-server build directory, launch a domain-server. -First we make the targets we'll need. + ./domain-server - cd build - make domain-server assignment-client - -If after this step you're seeing something like the following - - make: Nothing to be done for `domain-server'. - -you likely had Cmake generate Xcode project files and have not run `cmake ..` in a clean build directory. - -Then, launch the static domain-server. All of the targets will run in the foreground, so you'll either want to background it yourself or open a separate terminal window per target. - - cd domain-server && ./domain-server - -Then, run an assignment-client with all three necessary components: avatar-mixer, audio-mixer, and voxel-server assignments. The assignment-client uses localhost as its assignment-server and talks to it on port 40102 (the default domain-server port). +Then, run an assignment-client. The assignment-client uses localhost as its assignment-server and talks to it on port 40102 (the default domain-server port). In a new Terminal window, run: - ./assignment-client/assignment-client -n 3 + ./assignment-client Any target can be terminated with Ctrl-C (SIGINT) in the associated Terminal window. -To test things out you'll want to run the Interface client. You can make that target with the following command: +This assignment-client will grab one assignment from the domain-server. You can tell the assignment-client what type you want it to be with the `-t` option. You can also run an assignment-client that forks off *n* assignment-clients with the `-n` option. - make interface + ./assignment-client -n 5 -Then run the executable it builds, or open interface.app if you're on OS X. +To test things out you'll want to run the Interface client. To access your local domain in Interface, open your Preferences -- on OS X this is available in the Interface menu, on Linux you'll find it in the File menu. Enter "localhost" in the "Domain server" field. -If everything worked you should see "Servers: 3" in the upper right. Nice work! - -In the voxel-server/src directory you will find a README that explains in -further detail how to setup and administer a voxel-server. +If everything worked you should see that you are connected to at least one server. Nice work!