diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..67e7769e --- /dev/null +++ b/README.rst @@ -0,0 +1,57 @@ +====== +Plasma +====== +A CMake-based fork of the GPLv3-licensed **CyanWorlds.com Engine** (Headspin/Plasma), with a focus on bug fixes, cross-platform compatibility, and enhanced features. + +For more information, see http://mystonline.com/developers/ + + +Related projects +---------------- +- moul-scripts - An updated repository of game scripts containing + bug-fixes and compatible with modern python interpreters for use with Plasma. +- dirtsand - An open-source Plasma-compatible server project. + + +Library Dependencies +-------------------- +Plasma currently utilizes the following third-party libraries: + +- Python 2.7 +- nVidia PhysX 2.6.4 +- Creative Labs' OpenAL SDK 1.1 +- Microsoft DirectX SDK + - November 2008 or + - June 2010 +- libOgg and libVorbis +- OpenSSL +- eXpat +- libJPEG +- speex +- zlib + +Reducing the use of proprietary libraries is a focus of development and should be expected to change. + + +Compiling Instructions +---------------------- +Currently, compilation only targets Windows systems and requires Visual Studio 2008 or Visual Studio 2010. + +Support for Visual Studio Express editions and other operating systems is planned. + +To compile: + +1) Start CMake-GUI +2) Select your clone of the repository as the source directory, and a build directory (such as .\build) +3) Click 'Configure' + If CMake cannot find required libraries (such as PhsyX or OpenAL) you may need to specify them manually: + Default locations are C:\\physx_2.6.4\\SDKs for **PHYSX_SDK_PATH**, while C:\\Program Files\\OpenAL 1.1 SDK\\include and C:\\Program Files\\OpenAL 1.1 SDK\\libs\\Win32\\OpenAL32.lib are **OPENAL_INCLUDE_DIR** and **OPENAL_LIBRARY**, respectively. Once you have set the missing paths, click 'Configure' again to complete this step. +4) Click 'Generate' to create the Visual Studio solution and associated projects. +5) Open the `Plasma.sln` Solution in Visual Studio and choose **Build->Build Solution**. + + +Additional Information +---------------------- +- Myst Online is available to play for free at http://mystonline.com/play/ +- For more information on this fork and more in-depth building instructions, see the Guild of Writers wiki: . +- This code was forked from the initial release repository at OpenUru.org \ No newline at end of file