The main client for the Worldforge MMORPG system.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake
data
doc
man/man1
media
scripts
src
support
tests
.gitignore
.mailmap
AUTHORS
CMakeLists.txt
COPYING
ChangeLog
INSTALL
NEWS
README.md
ember.conf.in
ember.desktop
ember.dox.in
ember.in

README.md

Ember

Join us on Gitter!

Ember is the client for the WorldForge virtual world system. It can be used for playing and exploring as well as authoring.

That means that if you're a player who wants to explore a virtual world hosted by a Worldforge server, this is the client for you. And if you're a world builder who wants to build your own world, this is also the client for you.

To learn more about Worldforge visit our website.

Installation

Since Ember uses a lot of internal Worldforge libraries which might not be supplied by your system we strongly suggest that you use the Hammer tool to compile Ember. This is script provided by the Worldforge project which will download and install all of the required libraries and components used by Worldforge.

If you want to compile yourself, make sure that both OGRE and CEGUI is available on your system and do

mkdir build_`arch` && cd build_`arch`
cmake ..
make
make media-download
make install

The make media-download will fetch all of the needed media files from the net. Rsync is required.

Tests

The test suite can be built and run using the check target. For example:

make check

API documentation

If Doxygen is available API documentation can be generated using the docs target. For example:

make docs

Working with media

An alternative to the media-download target is to instead use the raw media repo source, as found at https://svn.worldforge.org:886/svn/media/trunk/. If you intend to edit or add new media you probably want this instead.

The target mediarepo-checkout will use Subversion to checkout the repository to the mediarepo directory. When running a non-release build Ember will automatically load media from this directory. Note that this might lead to longer start times, as more files needs to be processed.

In addition, there's a mediarepo-process target which processes the media from the media repository, as fetched by mediarepo-checkout, and places the results in the build directory, under a subdirectory named ember-media-<version>. When running a non-release build Ember will automatically load media from this directory, taking precedence over the mediarepo directory.

Running Ember

As Ember is a 3d client it requires a 3d capable graphics card. If you have a fairly recent machine you should be good though.

If you want to run Ember as a world builder tool we strongly recommend that you also install and run a local instance of the Cyphesis server. By running an instance of the Cyphesis server on your local machine you're automatically given administrative access to the world, and can build and alter it however you like. Just as with Ember we recommend that you use the Hammer tool to compile Cyphesis.

How to help

If you're interested in helping out with development you should check out these resources: