Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 5.48 KB

Tpclient-pyogre_manual.mediawiki

File metadata and controls

103 lines (74 loc) · 5.48 KB

Table of Contents

Introduction

Welcome! If this is your first time hearing about Thousand Parsec, you may want to read the rest of this introduction. If you are already familiar with the project, you may want to skip to "First Steps", which talks about installing and running the client.

A quick primer to Thousand Parsec

Thousand Parsec is a framework for creating turn-based strategy games. Each game is based around a ruleset which defines how the game will be played. Some popular rulesets include:

Reach for the Stars A port of the old space 4X strategy game Reach for the Stars. A notable feature of this ruleset is that each turn is actually one of three "phrases", so different actions will be available during each phase.

Minisec and MTSec These are the "example" rulesets for Thousand Parsec, and you can usually see Minisec being played on the demo servers (demo1.thousandparsec.net) if you'd like to take a quick look.

In addition there have been many new rulesets released during this years Google Summer of Code program. This page lists them all.

There are also many different clients available for connecting to the server. It is important to note that the actions that take place in-game are not affected by your choice of client - they are just different ways of doing the same thing.

First steps

Binary builds

Binary builds are versions of a software that usually come with some, if not all of their dependencies included into a single package. These are the fastest way to get up and running with the client, and you can download a Windows version from here. After downloading the setup file, run it and follow the instructions to install it on your system. The client can then be run from the start menu, under the Thousand Parsec/tpclient-pyogre folder. For linux users, there is an Ubuntu .deb file being worked on at the moment.

Running from source

Running from source means downloading the source code and getting all the dependencies for yourself. Currently, the client has these dependencies:

  • Python, a programming language
  • Python-Ogre, a free open source Python interface to a wide range of C++ libraries
  • Python TP Client and Network libraries, a common code base for python-based clients in Thousand Parsec
  • Pygame (optional), a game development library used to playback sound and movies in the client
The source code is hosted in a Git repository, so you'll need Git to download a copy. Windows users can get a binary version of Git from here.

Using the client

Logging on

images/Login.png

Upon starting the client, the first thing you will see is the login screen, with textboxes to fill in the user name and password. To select a server to join, either type in the url in the server textbox or click the drop-down button to show a list of servers currently running.

The user interface

After logging into the game, you'll see the main screen: images/tpclient-pyogre_main.png

Here's an explanation of what the labelled items on the user interface do, from top to bottom:

  1. Menu - Shows the main menu
  2. Designs - Shows a list of ship types in the game (may not be applicable to all rulesets)
  3. Current turn - Shows how long the game has been progressing
  4. Zoom in - Get closer to the currently selected object
  5. Zoom out - Get further from the currently selected object
  6. Deselect - Unselects the currently selected object
  7. Focus - Centers and zooms all the way in on the currently selected object
  8. Fit map - Zooms out all the way and shows the entire map
  9. Orders - Shows the order queue for the currently selected object
  10. Information - Shows additional details about the currently selected object
  11. System - Shows the list of systems in the game, double-clicking on a system will focus on it
  12. Messages - Shows the list of messages received
  13. Turn timer - Number of minutes and seconds until the current turn ends
  14. End turn - Tells the server you are ready to end your turn

Issuing orders

Orders are how you control your assets in the game. Planetary production, fleet movement and colonization are just a few examples of the different orders you can issue to objects belonging to you.


To view an object's current orders, first select an object and bring up the Orders window. You can drag or resize the Orders window if it is blocking your view. You should see something similar to the following screen:

images/Tpclient-pyogre_issue_orders.png

Viewing messages

Controls

Object selection and orders

Mouse

Select an object by clicking on it
Right-click on a destination to issue a move command
Keyboard
Spacebar to bring up an orders menu for the currently selected object

Moving the map

Mouse

Middle-click + drag to pan the map around
Mouse-wheel will zoom in and out
Right-click + drag to rotate the map around the focal point
Double-clicking on an object will center and zoom in on it
Keyboard
Arrow keys to pan the map around
+/- keys will zoom in and out
C to center on the selected object
A to zoom out and fit the map to screen

Additional keys

Esc - bring up the main menu
Ctrl-Q - quit immediately
F12 - take a screenshot

Troubleshooting

Finding players

Empty dialog boxes

No sound

Appendix A - Running from source