capitalist Code
Status: Beta
Brought to you by:
hoermen
The Capitalist Handbook Daniel Hermann hoermen@users.sourceforge.net Version 0.3.2 , Sun Feb 27 22:21:38 CET 2011 This Handbook describes Capitalist Version 0.3.2. ______________________________________________________________________ Table of Contents 1. Introduction 1.1 Changes 1.1.1 v0.1 1.1.2 v0.2 1.1.3 v0.2.1 1.1.4 v0.3 1.1.5 v0.3.1 1.1.6 v0.3.2 2. Installation 2.1 How to obtain Capitalist 2.2 Requirements 2.2.1 Server 2.2.2 Client 2.3 Compilation and installation 3. Usage 3.1 Starting the server 3.2 Starting the clients 3.3 Starting the game 4. Questions and Answers 5. Copyright 6. Additional Information, Clients ______________________________________________________________________ 11.. IInnttrroodduuccttiioonn Capitalist is a Monopoly(R)-like board game for 2-8 players. Walk around the board, buy properties, receive rent from your competitors, try to get monopolies to build houses and hotels on them and finally be the richest on the board. Capitalist is server-based and can be played over the internet. This handbook describes the server. 11..11.. CChhaannggeess 11..11..11.. vv00..11 +o Initial Release 11..11..22.. vv00..22 +o debts +o bankruptcy +o allow animations for moving the token on client +o (list incomplete) 11..11..33.. vv00..22..11 +o minor updates for gcc-3.x compatibility 11..11..44.. vv00..33 +o enable server to be started by client +o added settings framework: new commands "set" and "show", only one option yet ("aifill") +o corrected implementation of income tax (depending on properties of player) +o corrected jail card handling (removal from stack, registration with player) +o AI player: limited functionality, no trading yet, command "aitoggle" and option "aifill" +o bugfixes 11..11..55.. vv00..33..11 +o bugfix release (compile issues with gcc-4.3 and on freebsd 6.3) +o added man page 11..11..66.. vv00..33..22 +o Security fix: buffer overflow when receiving faulty packages +o FTBFS bugfixes, transition to cmake build system 22.. IInnssttaallllaattiioonn 22..11.. HHooww ttoo oobbttaaiinn CCaappiittaalliisstt You can download the latest version of Capitalist at <http://capitalist.sourceforge.net/>. 22..22.. RReeqquuiirreemmeennttss 22..22..11.. SSeerrvveerr There are no special requirements. It currently compiles only on linux (AFAIK), but there should not be huge problems to port it to any other UNIX operating system. Feel free to try it and send me your patches. 22..22..22.. CClliieenntt The client (Kapitalist) requires the following libraries/headers to compile and run: +o KDE 3.x (tested on KDE >=3.3.2) +o Qt 3.x (tested on Qt >=3.3.4) Install appropriate packages for your distribution or visit <http://www.kde.org>. 22..33.. CCoommppiillaattiioonn aanndd iinnssttaallllaattiioonn In order to compile and install Capitalist on your system, type the following in the base directory of the Capitalist distribution: % mkdir build && cd build % cmake .. % make % make install Since Capitalist uses CMake you should have no trouble compiling it. Should you run into problems please report them to the author <mailto:hoermen@users.sourceforge.net>. 33.. UUssaaggee 33..11.. SSttaarrttiinngg tthhee sseerrvveerr Capitalist is server-based, so at first you have to start the server on a console with the command % capitalist which opens up a special server console with a prompt, This is the server for Capitalist version x.x Get more info at http://capitalist.sourceforge.net/ 1: Now accepting new client connections Get a list of the available commands with 'help'. > _ where you can type in commands like > help Available commands: (P=player, L=level, O=option V=value) ------------------------------------------------------------------- help - this help text quit - quit game and shutdown server list - list players show - show available server options set O V - set server option X to value V start - start game ... Abbreviations are allowed. > _ or see a list of options with > show ------------------------------------------------------------------- + means you may change the option = means the option is on its default value ------------------------------------------------------------------- Option value (min,max) description ------------------------------------------------------------------- aifill +=2 (2,8) ------------------------------------------------------------------- > _ 33..22.. SSttaarrttiinngg tthhee cclliieennttss In the next step, each player who wants to play in the game should join the game by starting a client (i.e. Kapitalist) and connecting to the server. When a game is in progress, there is one server running, and as many clients as there are human players. So each player types % kapitalist on the commandline (or starts Kapitalist in the K-Menu) and connects by selecting Game->Connect. A Dialog appears where you must type in the correct hostname and port of the server (in many cases, the default, localhost:2525, is already ok). In addition you have to chose a suitable nickname. 33..33.. SSttaarrttiinngg tthhee ggaammee When all human players have connected to the server, the game can be started by typing > start on the server console. AI players are created automatically by the server up to a number of "aifill" total players. By default, aifill is set to 2, so that you play against one AI opponent if there are no other human players connected at starting time. Now most of the action takes place in the client windows. Please consider the client documentation for more information. 44.. QQuueessttiioonnss aanndd AAnnsswweerrss EErrrroorr:: bind failed: address already in use You have to use a different port. The default port is 2525. You can tell the server to use a different port by giving '--port' as a command line argument: % capitalist --port 3456 You can get a list of other available command line arguments by typing % capitalist --help 55.. CCooppyyrriigghhtt Capitalist Copyright 2006,2008,2011 Daniel Hermann, hoermen@users.sourceforge.net This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 66.. AAddddiittiioonnaall IInnffoorrmmaattiioonn,, CClliieennttss For additional information see the Capitalist Homepage <http://capitalist.sourceforge.net/>. This linuxdoc documentation was processed in the following way: % linuxdoc --backend=html index.sgml -> capitalist/docs/en/*.html % linuxdoc --backend=txt index.sgml -> README