diff --git a/README-user.md b/README-user.md index f3be2e0..64527da 100644 --- a/README-user.md +++ b/README-user.md @@ -1,2 +1,69 @@ -# Planet Blupi +# Planet Blupi (v1.9) + +This version contains over 30 missions and a built in editor, which enables you +to construct your own missions. + +## Configuration + +| Category | Description | +| -------- | ----------- | +| OS | At least GNU/Linux 2.6.32, macOS 10.7 or Microsoft Windows Vista | +| VIDEO | An 3D accelerated video card is highly recommended | +| SOUND | Any sound card supported by ALSA, sndio, macOS or DirectSound | +| INPUT | Keyboard and mouse | + +## Screen problems + +What ever your screen resolution is, the game +"Planet Blupi" always runs in 640x480 on full screen. If your screen does not +support this mode, you may run the game in windowed mode. Proceed as follows: + +- 1. Quit the game "Planet Blupi". +- 2. Open the file "/data/config.json" with a text editor. +- 3. Replace `fullscreen: true` by "fullscreen: false". +- 4. Save and restart the game. + +In this mode the screen is no more scrolled if the mouse touches the window +border. Use the Keyboard arrows instead. + +## Mouse + +Left button: +This button is always used in three steps: + +- 1. Select a Blupi. +- 2. Click where you want him to act. +- 3. Click the button corresponding to the required operation. + +If the chosen Blupi is already selected (blue or red circle around him), +step 1) is not necessary. + +You may select several Blupis by maintaining the Shift button pressed. + +Right button: +The right button is a shortcut. It orders the selected Blupi to do the most +useful operation on the selected spot. + +## Keyboard + +| Keys | Description | +| ------------ | ----------- | +| Arrows | Scrolls the visible part of the scene. | +| Spacebar | Shows or hides items. | +| F1 | Describes the goal without interrupting the game. | +| F5 | Normal speed (x1). | +| F6 | Double speed (x2). | +| Home | Returns to place of mission departure | +| Ctrl+F9..F12 | Bookmarks a spot. | +| F9..F12 | Returns to the corresponding bookmarked spot. | +| Pause | Temporarily suspends the game. | + +When you switch to an other application, the game is automatically paused. + +## EPSITEC + +Planet Blupi is an original creation of EPSITEC SA. + +http://www.blupi.org +info@blupi.org diff --git a/README.md b/README.md index e3a25b9..50bca49 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,10 @@ Please, do not use this repository directly for development but refer to the bundle located at . + +## Original versions (1997) + +You can find "mostly" the original source code from previous versions (v1.7 and +v1.8, 1997) under the tags `v1.7.0` and `v1.8.0`. Note that both tags are +targetting the same commit. The reason is that the version 1.8 was done because +a bug was discovered on the cdroms (deployment problems only).