Changeset 515 for trunk/game/README


Ignore:
Timestamp:
03/09/10 16:21:23 (10 years ago)
Author:
barra_parpg
Message:

Patch by mvbarracuda:

  • (Hopefully) final README update before the release of techdemo 1
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/game/README

    r514 r515  
    11================================================================================= 
    22                            PARPG TECHDEMO 1 README 
    3                           Last Updated: 08 March 2010 
     3                          Last Updated: 09 March 2010 
    44================================================================================= 
    55 
     
    88 
    99== Table of contents == 
    10 * Preamble 
    11 * License 
    12 * How to run PARPG 
    13 * Keybinds 
    14 * Known bugs / limitations 
    15 * How to provide feedback 
    16 * Acknowlegements 
     1001 Preamble 
     1102 License 
     1203 Supported operating systems 
     1304 How to run PARPG 
     1405 Keybinds 
     1506 Map editor 
     1607 Known bugs / limitations 
     1708 How to provide feedback 
     1809 Acknowlegements 
    1719 
    18 == Preamble == 
     20== 01 Preamble == 
    1921This 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. 
    2022 
    2123This 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. 
    2224 
    23 == License == 
     25== 02 License == 
    2426* All Python code is licensed under GPL 3.0. For the full license see: <PARPG>/game/license/gpl30.license 
    2527* 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 
    2628* 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 
    2729 
    28 == How to run PARPG == 
    29 === Linux === 
    30 * Unpack the .tar.bz2 source archive 
     30== 03 Supported operating systems == 
     31PARPG is officially supported in combination with these operating systems: 
     32* Linux (32 & 64bit) 
     33* Win32 (32 & 64bit) 
     34 
     35PARPG should nevertheless also work with (prolly some tweaks required): 
     36* FreeBSD (use Linux install instructions) 
     37* Mac OSX 
     38* OpenBSD (use Linux install instructions) 
     39 
     40== 04 How to run PARPG == 
     41=== 04.1 Linux === 
     42* Unpack the fife_r3236_src.tar.bz2 archive to <FIFE> 
     43* cd into the <FIFE> directory and run: scons ext && scons 
     44* In case you encounter any build errors, try these pointers http://wiki.fifengine.de/Building:Linux:SCons 
     45* Unpack the parpg_td1_r515_src.tar.bz2 archive to <PARPG> 
     46* cd into the <PARPG> directory and run: ./run.py 
    3147* Run <FIXME> 
    3248* To run PARPG itself, cd into the PARPG directory and execute run.py (should be automatically associated with your Python 2.6 interpreter) 
    33 * To run the PARPG map editor, cd into the PARPG directory and execute parpg_editor.py; a work in progress map editor tutorial can be found at http://wiki.parpg.net/Map_editor_tutorial 
    3449 
    35 === Mac === 
    36 * Unpack the .tar.bz2 source archive 
    37 * Run <FIXME> 
     50=== 04.2 Mac === 
     51* Unpack the fife_r3236_src.tar.bz2 archive to <FIFE> 
     52* <FIXME>FIFE build instructions for Mac OSX</FIXME> 
     53* In case you encounter any build errors, try these pointers http://wiki.fifengine.de/Building:Mac:Scons 
     54* Unpack the parpg_td1_r515_src.tar.bz2 archive to <PARPG> 
     55* cd into the <PARPG> directory and run: ./run.py 
    3856* To run PARPG itself, cd into the PARPG directory and execute run.py (should be automatically associated with your Python 2.6 interpreter) 
    39 * To run the PARPG map editor, cd into the PARPG directory and execute parpg_editor.py; a work in progress map editor tutorial can be found at http://wiki.parpg.net/Map_editor_tutorial 
    4057 
    41 === Win32 === 
     58=== 04.3 Win32 === 
    4259* Install PARPG to a location of your choice 
    4360* 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) 
    44 * To run PARPG itself, cd into the PARPG directory and execute run.py (should be automatically associated with your Python 2.6 interpreter) 
    45 * To run the PARPG map editor, cd into the PARPG directory and execute parpg_editor.py; a work in progress map editor tutorial can be found at http://wiki.parpg.net/Map_editor_tutorial 
    46 * To run PARPG with file logging, cd into the PARPG directory and execute log_parpg.bat; the log will be written to logfile.txt 
     61* To run PARPG itself, cd into the <PARPG> directory and execute run.py (should be automatically associated with your Python 2.6 interpreter) 
     62* To run PARPG with file logging, cd into the <PARPG> directory and execute log_parpg.bat; the log will be written to logfile.txt 
    4763 
    48 == Keybinds == 
     64== 05 Keybinds == 
    4965* <i> toggles the inventory on and off 
    5066* <t> shows the grid layout 
     
    5773* <PAUSE> (un)pauses the game 
    5874 
    59 == Known bugs / limitations == 
     75== 06 Map editor == 
     76* To run the PARPG map editor, cd into the PARPG directory and execute parpg_editor.py 
     77* A work in progress map editor tutorial can be found at http://wiki.parpg.net/Map_editor_tutorial 
     78 
     79== 07 Known bugs / limitations == 
    6080* 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 
    6181* 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) 
     
    6989* Full list of open tickets can be found at http://parpg-trac.cvsdude.com/parpg/report/1 
    7090 
    71 == How to provide feedback == 
     91== 08 How to provide feedback == 
    7292You can reach the development team in a couple of ways and provide feedback: 
    7393* PARPG forums: http://forums.parpg.net/ 
     
    7898All feedback is welcome! 
    7999 
    80 == Acknowlegements == 
     100== 09 Acknowlegements == 
    81101We 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/ 
    82102 
Note: See TracChangeset for help on using the changeset viewer.