PlaneShift Dev Docs

Email Docs

If you have any docs that you would like to contribute, please email them to me here.

Server Installation

1. Get all documents as .zip, .tar.gz (not done yet).

2. Read the documentation in PLANESHIFT_CVS/docs

3. PS Web Console Setup

   Documentation of how to setup the PS databases and web console for creating NPC's, Quests etc.

4. PS Server Setup

   Guide to getting your local PS server running after you have followed the basic instructions in the PLANESHIFT_CVS/docs folder.

5. Using the Web Console

   Guide to using the web console. I could use some help from the devs in filling in a few blanks that I don't know about yet.

Other Dev Documents

- Sourcecode Compilation Guides

- PS API Documentation

  This is invaluable. Thanks very much to acraig for pointing me to this.

- PS Code Architecture

  Part of the PlaneShift project's internal documentation. This document overviews the different code layers and logical modules in the PS source. New C++ developers may find this useful in helping them become familiar with the organisation of the PS sourcode.

- PS Effect Editor

- Precompiled libs for Windows and MinGW ...
  - Curl 7.13.0. If you have probs with this, please let me know.

  - MySQL 4.0.32. You really need to install MySQL properly and should not use this. In any case, it is only the header files and the lib.

  - zlib 1.0.22.

- PS License

Player Documents

- Player Guide