Mercurial > parpg-core

comparison README.txt @ 0:1fd2201f5c36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit of parpg-core.
author M. George Hansen <technopolitica@gmail.com>
date Sat, 14 May 2011 01:12:35 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:1fd2201f5c36
1 =================================================================================
2 PARPG TECHDEMO 2 README
3 Last Updated: 6 March 2011
4 =================================================================================
5
6 == Introduction ==
7 Welcome to the second official release of the open source post-apocalyptic RPG undertaking PARPG. This release is based on PARPG SVN trunk revison 877. Built against and tested with FIFE SVN trunk revision 3586.
8
9 == Table of contents ==
10 01 Important note
11 02 Preamble
12 03 License
13 04 Supported operating systems
14 05 How to run PARPG
15 06 Keybindings
16 07 Settings
17 08 Map editor
18 09 Known bugs / limitations
19 10 How to provide feedback
20 11 Acknowlegements
21
22 == 01 Important note ==
23 The install instructions outlined in this README only apply to official stable releases of PARPG! In case you're reading this file but want to test an SVN version of PARPG, please read the install instructions for SVN versions that found at our project wiki instead: http://wiki.parpg.net/Download#SVN
24
25 == 02 Preamble ==
26 This preamble has been written to give you an upfront overview of the current status of the project. In the last months the project slowed down considerably and we basically decided that we'll rather release what we have right now instead of trying to implement more features and add more content, risking to collapse before we reach the finish line of the first release.
27
28 This said: we didn't manage to fix a number of bugs and didn't reach the original aim to implement a couple of quests that you can actually play through. You can walk around, talk to other characters, change to different (placeholder) maps, listen to background audio tracks and play around with the settings. That's it. It's possible that this is the first and last official PARPG release due the issues we are facing lately. Hopefully this release will help to attract some fresh blood that will get the project back on track. If not, it was at least fun for us to spend a year of our life on such a project and release what we have achieved to the public. And move on after that.
29
30 == 03 License ==
31 * All Python code is licensed under GPL 3.0. For the full license see: <PARPG>/game/license/gpl30.license
32 * Assets are either licensed under Creative Commons 3.0 BY-SA or public domain. For the full licenses see: <PARPG>/game/license/cc30_by_sa.license & <PARPG>/game/license/public_domain.license
33 * Most directories contain an <asset>.license file that states under which license the specific assets in the directory are released under and who created them. Use this file to properly attribute developers in case you reuse PARPG assets in your project
34
35 == 04 Supported operating systems ==
36 PARPG is officially supported in combination with these operating systems:
37 * Linux (32 & 64bit)
38 * Win32 (32 & 64bit)
39
40 PARPG should nevertheless also work with (prolly some tweaks required):
41 * FreeBSD (use Linux install instructions)
42 * Mac OSX
43 * OpenBSD (use Linux install instructions)
44
45 == 05 How to run PARPG ==
46 === 05.1 Linux ===
47 * Unpack the fife_r3236_src.tar.gz archive to a folder of your choice (called <FIFE> from now on)
48 * Install scons using your package manager
49 * Install swig using your package manager
50 * Install Python 2.5 or 2.6 and a matching version of PyYAML if you don't have them installed yet
51 * cd into the <FIFE> directory and run: scons ext && sudo scons install-python
52 * In case you encounter any build errors, install the necessary libraries and try these pointers http://wiki.fifengine.de/Building:Linux:SCons
53 * Unpack the parpg_td1_r522_src.tar.gz archive to a folder of your choice (called <PARPG> from now on)
54 * cd into the <PARPG> directory and run: ./run.py
55
56 === 05.2 Mac ===
57 * Unpack the fife_r3236_src.tar.gz archive to a folder of your choice (called <FIFE> from now on)
58 * Install scons using macports
59 * Install swig using macports
60 * Install guichan using macports
61 * Install Python 2.5 or 2.6 and a matching version of PyYAML if you don't have them installed yet
62 * cd into the <FIFE> directory and run: scons ext && sudo scons install-python
63 * In case you encounter any build errors, install the necessary libraries and try these pointers http://wiki.fifengine.de/Building:Mac:Scons
64 * Unpack the parpg_td1_r522_src.tar.gz archive to a folder of your choice (called <PARPG> from now on)
65 * cd into the <PARPG> directory and run: ./run.py
66
67 === 05.3 Win32 ===
68 * Run parpg_td1_r522_win32.exe and install PARPG to a location of your choice (called <PARPG> from now on)
69 * Make sure that you've installed (Active)Python 2.6, PyYAML and FIFE (they either ship with the installer or can be downloaded with the help of it)
70 * To run PARPG itself, cd into the <PARPG> directory and execute run.py (should be automatically associated with your Python 2.6 interpreter)
71 * To run PARPG with file logging, cd into the <PARPG> directory and execute log_parpg.bat; the log will be written to logfile.txt
72
73 == 06 Keybindings ==
74 * <i> toggles the inventory on and off
75 * <t> shows the grid layout
76 * <m> toggles music on and off
77 * <q> shows quit dialog
78 * <F5> shows the grid coordinates
79 * <F7> takes a screenshot
80 * <F10> shows a debug console
81 * <ESC> shows the main menu
82 * <PAUSE> (un)pauses the game
83
84 == 07 Settings ==
85 There are two ways to change the ingame settings like used renderer, resolution, etc.:
86 * Press <ESC> and select Options from the menu
87 * Edit <PARPG>/game/settings.xml manually, entries are mostly self-explanatory
88
89 == 08 Map editor ==
90 * To run the PARPG map editor, cd into the PARPG directory and execute parpg_editor.py
91 * A work in progress map editor tutorial can be found at http://wiki.parpg.net/Map_editor_tutorial
92
93 == 09 Known bugs / limitations ==
94 * FPS rate tends to be rather slow on some systems; the FIFE team is working to address this in their view_performance branch, for details see http://forums.parpg.net/index.php?topic=570.0
95 * While it's possible to talk to the NPCs, you can't solve any of the quests without using the ingame console (see ticket #229)
96 * Some unit tests are broken (see ticket #253)
97 * Random music playback hasn't been implemented (see ticket #250)
98 * PARPG crashes on exit in combination with Windows Vista 64bit if FIFE is built via MSVC 2005/2008 (see ticket #114 for a workaround)
99 * There is no regular main menu, you'll have to use the <ESC> key to access the placeholder menu (see ticket #118)
100 * Containers don't support taking everything out of them at once (see ticket #225)
101 * You can't drop items onto the ground (see ticket #223)
102 * Some map objects are semi-transparent while they should have been rendered opaque (see ticket #251)
103 * Full list of open tickets can be found at http://parpg-trac.cvsdude.com/parpg/report/1
104
105 == 10 How to provide feedback ==
106 You can reach the development team in a couple of ways and provide feedback:
107 * PARPG forums: http://forums.parpg.net/
108 * PARPG IRC channel: #parpg @ irc.freenode.net (visit http://irc.parpg.net to join the channel via your web browser)
109 * PARPG bug tracker: http://bugs.parpg.net
110 * PARPG blog: http://blog.parpg.net/
111
112 All feedback is welcome!
113
114 == 11 Acknowlegements ==
115 We thank everyone who supported the project and believed in the idea of creating an old school isometric 2d RPG despite the general trend of more and more higher budget cross platform (read: consoles and win32) 3d RPGs. We do especially want to thank qubodup, a loyal follower who supported the project since its first steps and has helped us by spreading the word about PARPG with his ingame videos and his continued news coverage at http://freegamer.blogspot.com/
116
117 Furthermore we want to thank the developers of FIFE, the engine of our choice. Without you this project would not have been possible at all and we're glad that the project is finally in good hands again now. If you want to find out more about FIFE, check out their website http://www.fifengine.net/
118
119 The PARPG developers,
120 http://www.parpg.net