Players Guide

From PSwiki
Revision as of 17:53, 12 September 2013 by Loremipsum (talk | contribs)
Jump to navigation Jump to search


Introduction

In PlaneShift, we aim to create a persistent world in a fantasy setting, in which every player may create characters that live, explore, and interact with maximum realism.
You will start your journey as a citizen of the realm of Yliakum, an enormous underground world filled with a myriad of races, guilds, creatures and other foes to battle, and many places to explore and find or create your own adventures. For those who enjoy playing a more quiet life, there will be many jobs and careers to choose from, and always a tavern nearby to rest your feet, enjoy refreshments and make new friends. The path you choose will be your own.
The realm of Yliakum exists under the guidance of several gods and a firm-handed government [ <- Old Players guide link!]. Here magic is an important part of the lives of the people; this is considered a gift of the gods. Beyond Yliakum, concealed by the Bronze Doors, the deadly Stone Labyrinths await eager explorers. What mysteries will be discovered? Perhaps you will be the first to rediscover ruins lost in the dark depths, or to navigate mysterious dungeons, or to uncover the fate of the great Lemur cities of Kadaikos. The adventure continues even in death. Will you become a tool of the dark?
Enter the world of PlaneShift and discover the truth for yourself.

Development Notes

PlaneShift is fully and permanently open source and free. Currently under heavy development in the early alpha stage, it is run by a very small team of volunteers working with no funding. Every player should know this: you are becoming a tester, not a player of a fully developed commercial game produced by a million-dollar company. As such you are welcome to try out as many of the things currently implemented as you can, and give the development team feedback.
Report bugs at http://www.hydlaaplaza.com/flyspray/ , follow the Development section of the game forum and consider giving your time to contribute to the PlaneShift project.

Useful links:

System Requirements

PlaneShift will run on most personal computers with Windows, Mac OS X or Linux/Unix operating systems and an adequate 3D-accelerated graphics card.

Minimum Requirements:

  • Operating system: Windows (2000, XP or Vista), Mac OS X 10.4.11, Linux (2.6 kernel, glibc 2.7), FreeBSD or Solaris

  • Graphic chipset: Radeon R200 (8500-9250), GeForce 4 Ti/4200Go series, or Intel GMA X3100* 
* Note that Intel chipsets are not optimum for PlaneShift.
  • CPU: 2.4 Ghz Pentium 4 or Athlon XP 2600+

  • Others: 2 GB RAM
, 1 GB free disk space, low noise GPRS internet connection


Recommended Requirements:

  • Operating system: Windows (XP, Vista, 7), Mac OS X 10.5.8, Linux (2.6.27+ kernel, glibc 2.9)

  • Graphic chipset: Radeon R420 (X700-X850) or GeForce FX series**
  • CPU: 
Intel Pentium D 3.0Ghz or AMD Athlon 64 3200+
  • Others: 
4 GB RAM
 for Windows, 4 GB RAM for Mac OS X, [need Linux], 
2 GB free disk space
, Broadband Internet connection




**Other cards may work but are not supported by the staff.

Downloading and Installing PlaneShift

The PlaneShift download size is about 1.1 GB. The download time will vary from under one to several hours according to the server’s upload bandwidth and the type of Internet connection you have. Win7 and recent Linux version installers require higher access rights. If you face technical difficulties, you can find help either by contacting us on IRC or by posting on our  game forum.
To advanced users: The download package is pre-compiled. If you prefer to install PlaneShift from source code, please refer to the PlaneShift Compiling Guide.

Windows Users

  1. Download for Windows
  2. Once downloaded, double click the downloaded icon and step through the installer.
  3. Once the installation is complete, a new folder will appear in your Start Menu titled PlaneShift.


Mac OS X Users

  1. Download for Mac OS X
  2. Double click the downloaded PlaneShift icon and copy the PlaneShift folder to your Applications folder or other selected location.


Linux/Unix Users

  1. Download for Linux
  2. Once the download is complete, install the package as per your platform's requirements.

Updating PlaneShift

Before playing PlaneShift for the first time, it is essential to run an update within the pslaunch application. After this initial update, it is advisable to check for available updates from time to time, as the PlaneShift development team will continue to fix bugs, add features and expand new areas after release. Some of these changes may result in users not being able to log onto the PlaneShift server without updating.

Windows Users

  1. Locate the PlaneShift folder in the Start Menu and click on the pslaunch application (PlaneShift icon) or locate pslaunch.exe inside the installation directory (def: %ProgramFiles(x86)%\PlaneShift\pslaunch.exe)
  2. A window displays the following message: “An update to PlaneShift is available. Do you wish to update now?” Click “Yes”.
  3. You will see the progress of the update as recent changes are downloaded.
  4. Run pslaunch from time to time to get the latest updates. Sometimes you will be required to update in order to connect to the server. Clicking on “Repair” also compares and corrects all non-matching program files against the currently released game version.

IF the launcher itself crashes or you would like to schedule updates, run the following command: “pslaunch.exe /repair”

Mac OS X Users

  1. Open the PlaneShift folder. To run the initial update and check for available updates in the future, double-click on the pslaunch application, or Ctrl-click and select “Open” to override security preferences. 2. A window displays the following message: “An update to PlaneShift is available. Do you wish to update now?” Click “Yes”.
  2. You will see the progress of the update as recent changes are downloaded.
  3. Run pslaunch from time to time to get the latest updates. Sometimes you will be required to update in order to connect to the server. Clicking on “Repair” also compares and corrects all non-matching program files against the currently released game version.

IF the launcher crashes during the update, unpack the zip file manually:

  1. Open the PlaneShift folder and find the new pslaunch.zip file.
  2. Unzip the file. It should expand into a folder.
  3. Open the folder and replace the older existing items in your PlaneShift folder with these new files. Be careful to move the new items to the exact same location of the older items that need replacing.

This is a work-around to manually aid the update. Once this is done, the rest of the update should run fine if you open the pslaunch application again and click “Yes” to the update prompt or click “Repair”.

Linux/Unix Users

  1. Find and click the pslaunch application (PlaneShift icon) under the Applications/Games menu of your desktop environment or run pslaunch inside the installation directory (def: /opt/PlaneShift/pslaunch).
  2. A window displays the following message: “An update to PlaneShift is available. Do you wish to update now?” Click “Yes”.
  3. You will see the progress of the update as recent changes are downloaded.
  4. Run pslaunch from time to time to get the latest updates. Sometimes you will be required to update in order to connect to the server. Clicking on “Repair” also compares and corrects all non-matching program files against the currently released game version.


IF the launcher itself crashes or you would like to schedule updates, apply the following command: “./pslaunch --repair”

Configuring PlaneShift

After installing and updating, click on “Settings” from within the pslaunch application. You will see the General preferences page. This allows you to configure PlaneShift for video preferences and hardware compatibility. The default PlaneShift skin is “Elves”. In order to switch to another skin, first download it from links provided in the PlaneShift mods section of the game forum. Then return and click “Skins” to make your choice.
For sound preferences, click “Audio”.
For graphics preferences, click “Graphics”. To avoid issues with lighting, it is recommended that the “Low” and “Lowest” shader settings be avoided.

Mac OS X Users
For best performance, Mac OS X Users should choose “software” as the sound render option. Enter settings, change “OpenAL” to “Software” on the Audio page. Click “OK”.
The default configuration settings should be adequate for most systems, but if you have trouble running and/or playing the game, please consult the Technical Help section of the game forum for tips and troubleshooting or contact us on IRC.

Creating an Account

Accounts in PlaneShift are free of charge. You will need one in order to play the game. To create a PlaneShift account, visit the PlaneShift website player registration page at: http://planeshift.teamix.org/register/ and follow the instructions:

  1. Click on “Create New Account”.
  2. Enter your real or chosen name and a valid e-mail address. Enter the e-mail address again (to make sure you entered it correctly).
  3. Optional: Specify your country, gender and age for statistical purposes.
  4. Click on “Create Account”. Login to the e-mail account that you specified above. If your PlaneShift account was successfully created, you will be sent an e-mail containing an account activation link.
  5. When you receive your activation email, with the subject "PlaneShift Account Verification", read it and then click the verification link in the e-mail.
  6. On the verification page, enter a password for your new account and then click “Set Password”.

At this point, you are ready to run PlaneShift. See “Running Planeshift”.

Running PlaneShift

All options for running PlaneShift can be specified using the configuration program, which is run by opening pslaunch and clicking “Settings”. You can run PlaneShift either in full screen or windowed mode, but it is recommended that Mac OS X users opt for windowed mode while others stick with full screen setting.

Windows Users
From your Start menu click PlaneShift. In the newly opened “PlaneShift Launcher”, click “Play”. When the server connection screen appears, enter your account username and password. If the server status is “Failed”, check that you have completed initial and further updates (see 1.3). Then click “Login”.

Mac OS X Users
Open the PlaneShift folder in your Applications folder or other selected location. Double-click on the psclient application, or Ctrl-click and select “Open” to override security preferences.
When the server connection screen appears, enter your account username and password. If the server status is “Failed”, check that you have completed initial and further updates (see 1.3). Then click “Login”.

Linux/Unix Users
From your desktop environment's Application menu click PlaneShift. In the newly opened “PlaneShift Launcher”, click “Play”. When the server connection screen appears, enter your account username and password. If the server status is “Failed”, check that you have completed initial and further updates (see 1.3). Then click “Login”.