| 1 | = Basic PPS Tutorial = |
| 2 | This is a basic tutorial for new PPS students to get familiar with our framework and build environment. The process is described for tardis here. If you use another system first go to the [download] page and make sure you have all dependencies installed. |
| 3 | |
| 4 | == Preparations == |
| 5 | '''We check out the source and media repository and build for the first time''' |
| 6 | 1. Go to / create your orxonox directory: |
| 7 | {{{ |
| 8 | mkdir ~/orxonox |
| 9 | cd ~/orxonox |
| 10 | }}} |
| 11 | 2. Now check out the latest revision of the media repository (you will probably be asked for a username and password once): |
| 12 | {{{ |
| 13 | svn co https://svn.orxonox.net/data/Media |
| 14 | }}} |
| 15 | 3. Now get the latest revision of the trunk: |
| 16 | {{{ |
| 17 | svn co https://svn.orxonox.net/orxonox/trunk |
| 18 | }}} |
| 19 | 4. Prepare to build: |
| 20 | {{{ |
| 21 | mkdir trunk/build |
| 22 | cd trunk/build |
| 23 | cmake .. |
| 24 | }}} |
| 25 | 5. Now build for the first time (may take some time, further builds will be faster): |
| 26 | {{{ |
| 27 | make -j4 #-j4 means to create 4 parallel compile processes |
| 28 | }}} |
| 29 | 6. Additionally you can use [wiki:KDevelop3] as IDE to develop (if you don't want to use the console ;)) |
| 30 | '''Start the game for the first time''' |
| 31 | 7. Enter to the appropriate folder and start the game. You will see a menu popping up, just press the ''Standalone'' button. |
| 32 | {{{ |
| 33 | cd ~/orxonox/trunk |
| 34 | ./run |
| 35 | }}} |
| 36 | '''Now we extend the Ship''' |
| 37 | As you might have recognized some features of the Ship were missing: |
| 38 | * You can't fire (quite limitating) |
| 39 | * ... |
| 40 | In order to change this there are a few steps required: |
| 41 | 1. Open the files TutorialShip.cc and TurorialShip.h (in trunk/src/orxonox/objects) with your favorite IDE or console |
| 42 | 2. (???) |
| 43 | 3. ... |
| 44 | 4. Now edit the levelfile ( Media/levels/sample.oxw ) to use TutorialShip instead of !SpaceShip instead |
| 45 | - find the line where the the !SpaceShip gets loaded |
| 46 | - change !SpaceShip to TutorialShip |
| 47 | - add the new parameters (???) |
| 48 | - save and close the levelfile |
| 49 | '''Now start the game again and do some fancy in-game-stuff''' |
| 50 | 1. (???) |