.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "PLANETBLUPI" "6" "December 2023" ""
.SH "NAME"
\fBplanetblupi\fR \- a delirious spell\-binding game
.SH "SYNOPSIS"
\fBplanetblupi\fR [\fIoptional\fR\|\.\|\.\|\.]
.SH "DESCRIPTION"
\fBPlanet Blupi\fR is a strategy and adventure game\. It subtly blends action with thought\-provoking challenges\. Behind the quiet and gentle facade, you'll enjoy a fascinating diversion full of surprises\. Planet Blupi is ideal for ages 12 to 99\.\.
.P
This version contains over 30 missions and a built in editor, which enables you to construct your own missions\.
.SH "CONFIGURATION"
\fBPlanet Blupi\fR supports at least GNU/Linux 2\.6\.32, macOS 10\.9 and Microsoft Windows Vista\. If your OS is not listed, maybe it's possible to build yourself the game\. Most Unix and Unix\-like OS should be supported\.
.P
For the video output, a 3D accelerated video card is highly recommended\. It's still possible to use pure software rendering in all other cases\.
.P
For the sound card, any cards supported by ALSA, PulseAudio, macOS or DirectSound should work fine\.
.SH "SCREEN"
The game \fBPlanet Blupi\fR runs in full screen by using your desktop resolution\. If you are encounting errors, you can start the game by default in windowed mode\. Proceed as follows:
.IP "1." 4
Quit the game \fBPlanet Blupi\fR\.
.IP "2." 4
Open the file \fBshare/planetblupi/data/config\.json\fR with a text editor\.
.IP "3." 4
Replace \fBfullscreen: true\fR by \fBfullscreen: false\fR\.
.IP "4." 4
Save and restart the game\.
.IP "" 0
.P
In this mode the screen is no more scrolled if the mouse touches the window borders\. Use the keyboard arrows instead\.
.P
It's possible to start the game with \fB\-\-fullscreen off\fR instead of editing the \fBconfig\.json\fR file\.
.P
Another way is to start the game in legacy mode\. With this mode, the game runs with the original 640x480 resolution\. Use \fB\-\-legacy\fR on the command line\.
.P
If the problem persists, maybe you should try to start the game with the software renderer\. Edit the \fBconfig\.json\fR file and add \fB"renderer": "software"\fR or start the game with \fB\-\-renderer software\fR\.
.P
Another possibility exists\. You can try to change the driver used by the accelerated renderer\. By default it uses \fB"direct3d"\fR, you can change by \fB"opengl"\fR with \fB"driver": "opengl"\fR with the \fBconfig\.json\fR file or \fB\-\-driver opengl\fR by command line argument\.
.SH "MOUSE"
The left button is always used in three steps:
.IP "1." 4
Select a Blupi\.
.IP "2." 4
Click where you want him to act\.
.IP "3." 4
Click the button corresponding to the required operation\.
.IP "" 0
.P
If the chosen Blupi is already selected (blue or red circle around him), step 1) is not necessary\.
.P
You may select several Blupis by maintaining the \fBShift\fR button pressed\.
.P
The right button is a shortcut\. It orders the selected Blupi to do the most useful operation on the selected spot\.
.SH "KEYBOARD"
.TP
\fBArrows\fR
Scrolls the visible part of the scene\.
.TP
\fBSpacebar\fR
Shows or hides items\.
.TP
\fBF1\fR
Describes the goal without interrupting the game\.
.TP
\fBF5\fR
Normal speed (x1)\.
.TP
\fBF6\fR
Double speed (x2)\.
.TP
\fBHome\fR
Returns to place of mission departure
.TP
\fBCtrl\fR+\fBF9\fR\.\.\fBF12\fR
Bookmarks a spot\.
.TP
\fBF9\fR\.\.\fBF12\fR
Returns to the corresponding bookmarked spot\.
.TP
\fBPause\fR
Temporarily suspends the game (excepted with the hard difficulty)\.
.P
When you switch to another application, the game is automatically paused\.
.SH "MUSIC"
The music is provided in \fIOGG\fR and \fIMIDI\fR formats\. The \fIOGG\fR variant is preferred because the render is the same for all platforms\. For purist fanboys, it's possible to enforce the \fIMIDI\fR variant by starting the game with the \fB\-\-restore\-midi\fR command line argument\. Note that in this case, it's possible to lose some instruments, it depends of your system\.
.P
You can edit the \fBshare/planetblupi/data/config\.json\fR file and add an entry \fB"restoremidi": true\fR, or simply use the new settings available in the global settings screen in the game\.
.P
If you want, you can overload all musics with yours by providing \fIOGG\fR or \fIMIDI\fR music files in your user directory\.
.P
On Windows, type \fB%APPDATA%\eEpsitec SA\ePlanet Blupi\fR in the file browser\. On macOS, look at \fB~/Library/Application Support/Epsitec SA/Planet Blupi\fR\. On Linux, look at \fB~/\.local/share/Epsitec SA/Planet Blupi\fR\.
.P
You can create a \fBmusic\fR sub\-directory with your musics\. For example: \fB%LOCALAPPDATA%\eEpsitec SA\ePlanet Blupi\emusic\emusic000\.ogg\fR\.
.P
Only 10 musics are supported: \fBmusic000\fR to \fBmusic009\fR\.
.SH "OPTIONS"
.TP
\fB\-h\fR, \fB\-\-help\fR
Print this help message and exit\.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version and exit\.
.TP
\fB\-s\fR, \fB\-\-speed\-rate\fR
Change the speed rate \fB[1;2]\fR (default: \fB1\fR)\.
.TP
\fB\-t\fR, \fB\-\-timer\-interval\fR
Set the timer interval (refresh)\. The default value is 50ms\. This is an advanced option because it changes the main events loop frequency\.
.TP
\fB\-f\fR, \fB\-\-fullscreen\fR
Load in fullscreen \fB[on;off]\fR (default: \fBon\fR)\.
.TP
\fB\-z\fR, \fB\-\-zoom\fR
Change the window scale (only if fullscreen is \fBoff\fR) \fB[1;2]\fR (default: \fB1\fR)\.
.TP
\fB\-l\fR, \fB\-\-legacy\fR
Start the game in legacy display mode (640x480)\.
.TP
\fB\-r\fR, \fB\-\-renderer\fR
Set a renderer \fB[auto;software;accelerated]\fR (default: \fBauto\fR)\. Use the \fBsoftware\fR renderer if the \fBaccelerated\fR renderer is bugged\. Note that you can try other drivers (option \fB\-d\fR) before forcing the \fBsoftware\fR renderer\.
.TP
\fB\-d\fR, \fB\-\-driver\fR
Set a driver \fB[auto;direct3d;direct3d11;opengl;opengles2;opengles]\fR (default: \fBauto\fR, ignored with \fBsoftware\fR renderer)\.
.TP
\fB\-c\fR, \fB\-\-enable\-recorder\fR
Enable the recorder feature (\fBF3\fR/\fBF4\fR)\. When playing, you can start a record with \fBF3\fR and stop with \fBF4\fR\.
.TP
\fB\-p\fR, \fB\-\-play\-record\fR
Play a record generated by \fBF3\fR (\fB\-\-enable\-recorder\fR)\.
.TP
\fB\-b\fR, \fB\-\-restore\-bugs\fR
Restore funny original bugs of older versions < v1\.9\. It can be very fun and interesting for speedruns\.
.IP
\fBTower rays:\fR with this bug, it's possible to add rays on a map even without tower\. It's possible only when building a new map\.
.IP
\fBMine flag:\fR you can build a mine without prospecting if you know exactly where is the flag case\.
.IP
\fBEnemy control\fR: you can take the enemy control by going in an enemy factory while the door is open\.
.IP
\fBDuplicate everything\fR: this bug is very useful for duplicating objects by sending the same order to two Blupis\.
.IP
\fBDuplicate time bomb\fR: you can duplicate an amorced bomb by taking\.
.IP
\fBTake trapped ennemy\fR: it's possible to take a trapped enemy; it's useless but possible\.
.IP
\fBSet fire\fR: you can add invisible fire on every type of cells (when building a map)\.
.TP
\fB\-m\fR, \fB\-\-restore\-midi\fR
Restore playback based on MIDI music instead of OGG\.
.TP
\fB\-q\fR, \fB\-\-render\-quality\fR
Enable anti\-aliasing [on;off] (default: on, ignored if windowed)\.
.SH "AUTHOR"
\fBPlanet Blupi\fR is an original creation of Epsitec SA\.
.P
https://www\.blupi\.org \fIinfo@blupi\.org\fR
.SH "COPYRIGHT"
planetblupi is Copyright (C) 1997, Daniel Roux & EPSITEC SA and Copyright (C) 2017\-2021, Mathieu Schroeter