https://wiki.pioneerspacesim.net/api.php?action=feedcontributions&feedformat=atom&user=PhilbywhizzPioneerWiki - User contributions [en]2026-07-09T05:14:55ZUser contributionsMediaWiki 1.31.0https://wiki.pioneerspacesim.net/index.php?title=Model_viewer&diff=403Model viewer2012-12-13T03:31:32Z<p>Philbywhizz: Added info about Option-Click launch for OSX</p>
<hr />
<div>To enter modelviewer mode, launch the game with:<br />
<br />
pioneer -mv <optional model name><br />
<br />
''OSX Only:'' Hold down the Option key while clicking on the pioneer.app icon to launch the model viewer instead of the game.<br />
<br />
= Hotkeys =<br />
<br />
Esc: Quit<br />
<br />
Tab: Toggle UI<br />
<br />
PrintScr: Screenshot<br />
<br />
Space: Reset camera view + thruster sliders<br />
<br />
G: Cycle grid mode<br />
<br />
R: Randomize colour sliders<br />
<br />
Z: Toggle wireframe mode<br />
<br />
Camera view presets are like Blender:<br />
<br />
* Numpad 1 - Front view<br />
* Ctrl+Numpad - Rear view<br />
* Numpad 3 - Right view<br />
* Ctrl+Numpad 3 - Left view<br />
* Numpad 7 - Top view<br />
* Ctrl+Numpad 7 - Bottom view<br />
* Numpad2/4/6/8: Rotate view<br />
<br />
[[Category:Art]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Escape_Capsules&diff=319Escape Capsules2012-11-08T00:42:45Z<p>Philbywhizz: 2nd link fixed</p>
<hr />
<div>Escape capsules should deploy automatically, or on demand by the player. Depending on the possibility of multiple ship ownership, the abandoned ship might still be retained as player property, and if there is an autopilot or pilot (see [[Idea Crew|crew]]) on board the player could ask it to land.<br />
<br />
Some thoughts about escape capsules:<br />
<br />
* If the player ejects, the enemy ships should not in general continue to attack the player, unless they are being attacked as part of a contract killing directed at the player (not a passenger).<br />
* There should be a small risk that the attacker shows no remorse, and attacks or scoops up the player as slaves (game over).<br />
* A call for help could result in being scooped up for rescue by a friendly ship (GalCop or otherwise). Player is scooped, then sees the view from the rescue ship as it autopilots to a base. The player cannot interact with or control the rescue ship.<br />
<br />
== Escape capsule options ==<br />
<br />
There should be more than one brand of escape capsule available. Here is an outline of some possible options:<br />
<br />
* Basic escape capsule. No autopilot fitted, low thrust.<br />
* Advanced escape capsule. Autopilot included, high thrust.<br />
* Explorer class escape capsule. Fitted with a hyperdrive (perhaps class 0 or range-limited somehow) and the amount of fuel required to use it (probably one tonne).<br />
* Built-in escape capsule. Whatever type it is, you can't fit another or remove this one. It's an integral component of the ship.<br />
<br />
== Insurance policy ==<br />
<br />
'''This could be coded in Lua.'''<br />
<br />
In Elite and Frontier, escape capsules came with an insurance policy. It might be better if these were bought and maintained separately.<br />
<br />
Without an insurance policy, the player is left flying an escape capsule around. The player still has access to his money. Depending on the cost of the insurance, the following terms might be applied:-<br />
<br />
* Time. An insurance policy might be valid:<br />
** Perpetually<br />
** Until compensation is claimed (ie, the pilot ejects and lands)<br />
** Until a specified date (one, five or ten years from purchase)<br />
* Schedule. An insurance policy might replace the escape capsule when the player lands, with the following:<br />
** A ship of the type that the player was flying at the time of ejection<br />
** A ship of the type that the player was flying when the player bought the policy<br />
** A specified ship, regardless of whether the player has ever owned or flown that ship<br />
** Optionally, compensation for the value of contents in the hold<br />
** Optionally, provision of temporary skeleton crew (see [[Idea Crew|crew]] indenture).<br />
<br />
== Escape capsules that don't contain the player ==<br />
<br />
A player should be able to scoop up an escape capsule. On scooping, the player should choose whether to keep the occupant captive (becomes 1t slaves, as in Frontier) or to rescue the occupant. A rescued pilot can be delivered to any spaceport, and on landing will thank the player. There is a non-zero chance of compensation or faction reputation change. An additional option is that the rescued party might join the crew, if there is space on board.<br />
<br />
=== Multiple escape pods ===<br />
<br />
Large ships may have the capacity for numerous escape pods (perhaps of varying types). As the ship gets damaged, crew may elect to eject in pods. Pods of varying types may accept various numbers of crew (including the player) and may take a certain amount of time to launch - this allows fleeing crew to 'double up'; a pod that is preparing to launch will fill up before crew get into empty pods. It is entirely possible that pods are not left for the player.<br />
<br />
=== Passengers ===<br />
<br />
Passenger cabins could (or should?) double up as escape capsules. Perhaps onlt the more expensive ones; this might affect a passenger's willingness to travel with the player's ship, and would certainly affect the player's reputation in the event of catastrophe.<br />
<br />
== Persistent ships / hulks / wrecks ==<br />
<br />
Ejecting does not destroy the parent ship. Some ships may be towed and reclaimed or redocked with and possibly flown. A ship might contonie to operate after the player ejects, if it has a competent crew.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Escape_Capsules&diff=318Escape Capsules2012-11-08T00:40:45Z<p>Philbywhizz: Fixing up document linking</p>
<hr />
<div>Escape capsules should deploy automatically, or on demand by the player. Depending on the possibility of multiple ship ownership, the abandoned ship might still be retained as player property, and if there is an autopilot or pilot (see [[Idea Crew|crew]]) on board the player could ask it to land.<br />
<br />
Some thoughts about escape capsules:<br />
<br />
* If the player ejects, the enemy ships should not in general continue to attack the player, unless they are being attacked as part of a contract killing directed at the player (not a passenger).<br />
* There should be a small risk that the attacker shows no remorse, and attacks or scoops up the player as slaves (game over).<br />
* A call for help could result in being scooped up for rescue by a friendly ship (GalCop or otherwise). Player is scooped, then sees the view from the rescue ship as it autopilots to a base. The player cannot interact with or control the rescue ship.<br />
<br />
== Escape capsule options ==<br />
<br />
There should be more than one brand of escape capsule available. Here is an outline of some possible options:<br />
<br />
* Basic escape capsule. No autopilot fitted, low thrust.<br />
* Advanced escape capsule. Autopilot included, high thrust.<br />
* Explorer class escape capsule. Fitted with a hyperdrive (perhaps class 0 or range-limited somehow) and the amount of fuel required to use it (probably one tonne).<br />
* Built-in escape capsule. Whatever type it is, you can't fit another or remove this one. It's an integral component of the ship.<br />
<br />
== Insurance policy ==<br />
<br />
'''This could be coded in Lua.'''<br />
<br />
In Elite and Frontier, escape capsules came with an insurance policy. It might be better if these were bought and maintained separately.<br />
<br />
Without an insurance policy, the player is left flying an escape capsule around. The player still has access to his money. Depending on the cost of the insurance, the following terms might be applied:-<br />
<br />
* Time. An insurance policy might be valid:<br />
** Perpetually<br />
** Until compensation is claimed (ie, the pilot ejects and lands)<br />
** Until a specified date (one, five or ten years from purchase)<br />
* Schedule. An insurance policy might replace the escape capsule when the player lands, with the following:<br />
** A ship of the type that the player was flying at the time of ejection<br />
** A ship of the type that the player was flying when the player bought the policy<br />
** A specified ship, regardless of whether the player has ever owned or flown that ship<br />
** Optionally, compensation for the value of contents in the hold<br />
** Optionally, provision of temporary skeleton crew (see [[Idea.Crew|crew]] indenture).<br />
<br />
== Escape capsules that don't contain the player ==<br />
<br />
A player should be able to scoop up an escape capsule. On scooping, the player should choose whether to keep the occupant captive (becomes 1t slaves, as in Frontier) or to rescue the occupant. A rescued pilot can be delivered to any spaceport, and on landing will thank the player. There is a non-zero chance of compensation or faction reputation change. An additional option is that the rescued party might join the crew, if there is space on board.<br />
<br />
=== Multiple escape pods ===<br />
<br />
Large ships may have the capacity for numerous escape pods (perhaps of varying types). As the ship gets damaged, crew may elect to eject in pods. Pods of varying types may accept various numbers of crew (including the player) and may take a certain amount of time to launch - this allows fleeing crew to 'double up'; a pod that is preparing to launch will fill up before crew get into empty pods. It is entirely possible that pods are not left for the player.<br />
<br />
=== Passengers ===<br />
<br />
Passenger cabins could (or should?) double up as escape capsules. Perhaps onlt the more expensive ones; this might affect a passenger's willingness to travel with the player's ship, and would certainly affect the player's reputation in the event of catastrophe.<br />
<br />
== Persistent ships / hulks / wrecks ==<br />
<br />
Ejecting does not destroy the parent ship. Some ships may be towed and reclaimed or redocked with and possibly flown. A ship might contonie to operate after the player ejects, if it has a competent crew.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=317Pioneer Wiki2012-11-08T00:35:51Z<p>Philbywhizz: Linking to the Core Team Page</p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [[Keyboard and mouse controls]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
* [[Music]]<br />
* [[Sound Effects]]<br />
* [[Translations]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Design Scope|Game Scope]]<br />
* [[Getting Started with Development]]<br />
** [[Core Team]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Translations&diff=85Translations2012-09-11T13:14:04Z<p>Philbywhizz: Imported from github wiki</p>
<hr />
<div>Pioneer aims to be internationalized. To this end, there is support for multiple languages in Pioneer. This document specifies how the languages are defined, and how somebody can translate Pioneer to a new one.<br />
<br />
Localization is not a current aim. The game is set in the distant future; any cultural conventions will be drawn from the fictional premise of the game.<br />
<br />
There are two translation systems. The first is for the core game engine. The second is for those parts of the game which are implemented in Lua.<br />
<br />
==Core engine translation==<br />
Pioneer selects its languages dynamically, at run time. The languages are defined in files in data/lang. They are should be named after the native name of the language (English, Deutsch, Nederlands, etc) with a <code>.txt</code> filename extension. <code>English.txt</code> should always be present. It is the master language. All other language files should be a translation of <code>English.txt</code>, and any untranslated strings will fall back to the English.<br />
<br />
Language files should be encoded as UTF-8, and must not have a byte order marker at the start. The content of the file should look like this:<br />
<br />
# This is a comment<br />
GAME_SAVED_TO<br />
"Game saved to "<br />
SELECT_FILENAME_TO_LOAD<br />
Select a file to load<br />
COULD_NOT_OPEN_FILENAME<br />
Could not open %path<br />
<br />
Blank lines and lines beginning with # are ignored. All the other lines in the file are interpreted as tokens and definitions, alternately, until the end of the file.<br />
<br />
===Tokens===<br />
<br />
The token is a single word or phrase, in capitals, with underscores replacing spaces and with no punctuation. The token is the same in all languages, and uniquely identifies a translatable phrase to Pioneer.<br />
<br />
===Definitions===<br />
<br />
The definition is the translatable phrase, in whichever language is specified in the filename. Leading and trailing whitespace are ignored. The definitions are indented for legibility, but this is just for the benefit of the person working with the file, not a technical requirement.<br />
<br />
If a translatable phrase should have a leading or trailing space, the definition must be quoted as in the example "Game saved to"' above. This practice is being superseded by tokenization, as described below. If you find a translation where word order would be wrong in your language, please raise an issue on the [https://github.com/pioneerspacesim/pioneer/issues Github issue tracker] so that it can be tokenized.<br />
<br />
Tokenization, as in the example "Could not open %path" above, is used where a phrase will have words inserted by Pioneer. In the example, it is the name of a saved game. In others, it might be where a date or a price is used, or a character's name, a piece of equipment or a cargo type. These tokens are not the same as the main language tokens. These tokens begin with a percent sign, and if they are used adjacent to other words, they can be enclosed in braces, as in this example:<br />
<br />
NUMBER_TONNES<br />
%{mass}t<br />
<br />
Tokens within definitions must not be changed or translated. If the token is changed, it will stop working.<br />
<br />
==Lua module translation==<br />
===Regular translatable phrases===<br />
<br />
Translatable phrases in Lua modules are defined as tables within Lua files. The filename is arbitrary, and is normally chosen by the script writer, who should ideally have provided translatable phrases in the English language.<br />
<br />
Languages are defined as a single Lua table, which contains each language's name as a key, and a further table as that language's dictionary. This is passed to the Translate:Add() function as a single parameter. English ''must'' be defined first, otherwise the game can crash. A simple example is as follows:<br />
<br />
Translate:Add({<br />
English = {<br />
WELCOME = 'Welcome',<br />
["That's beautiful"] = "That's beautiful",<br />
},<br />
Deutsch = {<br />
WELCOME = 'Willkommen',<br />
["That's beautiful"] = 'Das ist wunderschön',<br />
}<br />
})<br />
<br />
This example adds two phrases each to the English and German languages. While a basic understanding of Lua is helpful, it shouldn't be absolutely necessary.<br />
<br />
Note that tokens can be any valid Lua key value. The first style shown above, '''WELCOME''', is a simple token. The other one, '''["That's beautiful"]''', is required wherever a token contains spaces or punctuation. Using the English string as the token makes the mission code more legible.<br />
<br />
The definitions are strings. All entries within tables in Lua should be followed by a comma. Definitions might contain tokens; some will be like the ones described in the Core Engine section above, but others might appear in curly braces like {this}. Those tokens should not be modified or translated; they are where the Lua script will insert other values.<br />
<br />
===Mission flavours===<br />
<br />
The Translate library also includes methods for dealing with flavours. A flavour is an alternative set of phrases for use in a bulletin board advert, or similar, used to add variety to the same mission.<br />
<br />
Flavours are defined as a simple Lua table, and are passed to the ''Translate:AddFlavour()'' function, along with the flavour's language and the name of the module. The name of the module must not be changed, or the flavour will not be used. The flavour loader, Translate:AddFlavour, checks for errors. The first flavour to be defined must be English; all others will be checked to make sure that their structure matches that one.<br />
<br />
A flavours can be added like this:<br />
<br />
Translate:AddFlavour('English','TestModule',{<br />
title = "Shill bidder wanted for auction",<br />
greeting = "Hi there. Want to earn some quick cash?",<br />
yesplease = "Sure. What do you need me to do?",<br />
nothanks = "No, ta - this looks a bit shady.",<br />
})<br />
<br />
And another:<br />
<br />
Translate:AddFlavour('English','TestModule',{<br />
title = "Help me win an auction.",<br />
greeting = "Hello. I'll pay you to place fake bids for me. Interested?",<br />
yesplease = "Yes, I like to live dangerously.",<br />
nothanks = "No thanks; I'd rather not get arrested for fraud.",<br />
})<br />
<br />
The language is specified in the first line as '''English''', and after the language comes the module name, which in this example is '''testmodule'''. To add a German flavour, simply copy that structure, change the 'English' to 'Deutsch' and translate the strings between the quotes. As before, if you see tokens like {this}, do not alter them. They will be replaced by another value during the game.<br />
<br />
It is not necessary to have the same number of flavours in every language. It is necessary to include all of the keys, and not to add extra ones or mis-spell them. If that happens, it will produce an error.<br />
<br />
===Submitting work===<br />
<br />
Ideally, translators should have an account on Github.com and should work from their own fork of the project. New languages, and modifications of existing languages, can be submitted for inclusion in Pioneer by means of a Github.com pull request.<br />
<br />
If you do not wish to use Github.com, the next best solution is to submit an email formatted patch set from any other git repository.<br />
<br />
If you cannot use git at all, please either email your submission to [mailto:brian@ppcis.org brian@ppcis.org], or send it to Brianetta on the Space Sim Central forum. Be sure to include your name and email address; these will be used to mark your work on the git commit log.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=83Pioneer Wiki2012-09-11T13:06:36Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
* [[Music]]<br />
* [[Sound Effects]]<br />
* [[Translations]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Sound_Effects&diff=82Sound Effects2012-09-11T13:04:29Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer sound effects are in [http://xiph.org/vorbis/ ogg vorbis] format.<br />
<br />
Put sound files in <code>data/sounds/</code><br />
<br />
Sound files can be in nested directories within <code>data/sounds</code>, and Pioneer will recursively search through them.<br />
<br />
Sound files should be stereo or mono, 44100Hz or 22050Hz.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Sound_Effects&diff=81Sound Effects2012-09-11T13:04:18Z<p>Philbywhizz: Imported from github wiki</p>
<hr />
<div>Pioneer sound effects are in [http://xiph.org/vorbis/ ogg vorbis] format.<br />
<br />
Put sound files in <code>data/sounds/</code><br />
<br />
Sound files can be in nested directories within <code>data/sounds<code>, and Pioneer will recursively search through them.<br />
<br />
Sound files should be stereo or mono, 44100Hz or 22050Hz.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=80Pioneer Wiki2012-09-11T13:03:22Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
* [[Music]]<br />
* [[Sound Effects]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Music&diff=79Music2012-09-11T13:01:56Z<p>Philbywhizz: Imported from github wiki</p>
<hr />
<div>Music files should be placed in a subdirectory of <code>data/music/</code>. They must be in [http://xiph.org/vorbis/ .ogg format], sampled at 44100 or 22050 Hz.<br />
<br />
Music in <code>core/</code> will be played by the default player script, <code>modules/MusicPlayer.lua</code>. Mission or per-system scripts should add their own music to a separate sub-directory.<br />
<br />
Music in <code>core/</code> is selected based on game events. When a particular game event occurs a song is chosen at random from the appropriate subdir. The subdirs are as follows:<br />
<br />
* '''space''': ambient music, played while flying in space. When music for a specific event finishes the player will start a song from this category. This is also the fallback category if any category subdir has no songs in it.<br />
<br />
* '''near-planet''', '''near-spacestation''': ambient music specific to planets and orbital stations. The player will play something from one of these categories if ambient music is requested and the player is near a planet or station.<br />
<br />
* '''docked''': played when the player docks (ie as the station menu appears)<br />
<br />
* '''undocked''': played when the player undocks (ie when the request launch)<br />
<br />
* '''ship-nearby''', '''ship-firing''': played when the player's alert state changes because a ship is nearby (within 100km) or starts firing. Note that the presence of a ship (even a firing ship) does not necessarily mean the ship is hostile and the player is (about to be) in combat.<br />
<br />
* '''ship-destroyed''': played with the player destroys a ship<br />
<br />
* '''player-destroyed''': played when the player is destroyed. Will continue to play over the "tombstone" screen.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=77Pioneer Wiki2012-09-11T12:58:37Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
* [[Music]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=76Pioneer Wiki2012-09-11T12:57:34Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=75Pioneer Wiki2012-09-11T12:53:39Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [[Creating Custom Systems]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Mods&diff=69Mods2012-09-11T11:47:15Z<p>Philbywhizz: Added a table for the known mods.</p>
<hr />
<div>== Available Mods ==<br />
<br />
=== How to install Mods ===<br />
<br />
Since Alpha 22 Pioneer has had support for modding. This is done by allowing core game data to be added to or overwritten by data in your userdir (that is, <code>'My Docs/Pioneer'</code> for Windows, <code>'~/.pioneer'</code> for Linux, and <code>'~/Library/Application Support/Pioneer'</code> for OSX).<br />
<br />
You have two options for adding files:<br />
<br />
* Put them in userdir/data. Any files in this dir will be visible to the game as part of its normal data/ dir.<br />
* Put them in a zip file in userdir/mods. The zip file contents will be visible to the game as part of its normal data/ dir.<br />
<br />
If a file in your userdir (data or mod) conflicts with one in the core datadir, your copy will be used. You can use this fact to replace core files.<br />
<br />
This mechanism can be used for any file under data/ - ships, models, systems, music, fonts, textures, whatever.<br />
<br />
== List of known Mods ==<br />
{| class="wikitable"<br />
|+Current known Mod Packages<br />
|-<br />
!Mod Name<br />
!Mod Description<br />
!Author<br />
!Version*<br />
!Size<br />
!Download link<br />
|-<br />
|Graveyard<br />
|Example of bundling multiple files in a mod. Adds a custom system "Graveyard" (up and to the right of Sol) and a script that does something when you jump there.<br />
|[[User:RobN|RobN]]<br />
|Alpha22<br />
|1kb<br />
|[http://eatenbyagrue.org/f/pioneer/graveyard.zip graveyard.zip]<br />
|-<br />
|RedSol<br />
|Example of replacing a core file. Replaces the system def for Sol with one that has a red star. <br />
|[[User:RobN|RobN]]<br />
|Alpha22<br />
|1kb<br />
|[http://eatenbyagrue.org/f/pioneer/redsol.zip redsol.zip]<br />
|-<br />
|Moon Heightmap<br />
|Higher res heightmap which replaces the 2mb default heightmap.<br />
|Unknown<br />
|Alpha26<br />
|33Mb<br />
|TBA<br />
|}<br />
<br />
*'' Version numer represents what the module was tested/built against. There is no guarantee that it will work for later versions.''</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.misscrn.4.png&diff=68File:Interact.misscrn.4.png2012-09-11T10:36:46Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.misscrn.3.png&diff=67File:Interact.misscrn.3.png2012-09-11T10:29:30Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.misscrn.2.png&diff=66File:Interact.misscrn.2.png2012-09-11T10:27:22Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.misscrn.1.png&diff=65File:Interact.misscrn.1.png2012-09-11T10:24:57Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.bbsad.4.png&diff=64File:Interact.bbsad.4.png2012-09-11T10:24:03Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.bbsad.3.png&diff=63File:Interact.bbsad.3.png2012-09-11T10:22:53Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.bbsad.2.png&diff=62File:Interact.bbsad.2.png2012-09-11T10:22:11Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=File:Interact.bbsad.1.png&diff=61File:Interact.bbsad.1.png2012-09-11T10:19:26Z<p>Philbywhizz: </p>
<hr />
<div></div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Interacting_with_the_player:_BBS_forms&diff=60Interacting with the player: BBS forms2012-09-11T10:07:18Z<p>Philbywhizz: Initial transfer from GitHub wiki</p>
<hr />
<div>The bulletin board system is currently the only place where real dialogue between a script and the player can take place. Bulletin boards can exist within any <code>SpaceStation</code> in the current system. They are created in a station the first time that a ship is either spawned, or lands, in that station. They continue to exist until the player leaves the system or quits the game. They are not saved in saved games, although a saved game contains information about which ones did exist.<br />
<br />
When a bulletin board is created, the <code>onCreateBB</code> event is triggered, and passes the <code>SpaceStation</code> body in which that bulletin board was created. There is an exception to this: The event is not triggered after loading a game for those bulletin boards which, having existed at the time of saving, are re-created. The consequences of this will be covered later (see "[[Surviving a reload]]").<br />
<br />
There are two components to any mission's entry on a bulletin board: The advert and the form. The advert is the part that is displayed on the main bulletin board list, along with all the other entries. The form is the part that appears on screen when the player clicks the advert's button.<br />
<br />
==Internationalization==<br />
<br />
It is important that scripters are familiar with the Translations library (scroll down to "Lua module translation"). A list of <code>Translate:Add()</code> calls are usually placed in a file named <code>Languages.lua</code> and kept in the same subdirectory as the script that needs them.<br />
<br />
This is by convention only; all translations, regardless of filename, are available to all scripts, and it would technically be perfectly possible to recycle the translated strings provided by another script. In order to keep the workload as simple as possible for translators, however, we do prefer the convention to be followed.<br />
<br />
The script itself makes use of translated strings by getting the translator function and using it to translate strings by token. So, if the <code>Languages.lua</code> file contained this:<br />
<br />
Translate:Add({<br />
English = {<br />
['Please, help me!'] = 'Please, help me!',<br />
},<br />
Deutsch = {<br />
['Please, help me!'] = 'Bitte, hilf mir!',<br />
},<br />
})<br />
<br />
then in the main script, you would first get the translator function:<br />
<br />
local t = Translate:GetTranslator()<br />
<br />
where <code>t</code> could be any other convenient name, in the event that you already have a variable named <code>t</code>. Once you have your translator, you can simply use it to translate by giving it the key:<br />
<br />
UI.Message(t('Please, help me!'))<br />
<br />
This would put "''Please, help me!''" on the screens of English players, and "''Bitter, hilf mir!''" on the screens of German players.<br />
<br />
The translator is fully documented in the codedoc. For the remainder of the document, I shall be using string literals. This is for clarity only; all custom scripts should be fully translatable if they are intended to be included with the game.<br />
<br />
==The BBS advert==<br />
<br />
Adverts are placed onto a BBS by calling the station's <code>AddAdvert()</code> method, once the bulletin board has been created. Depending on the nature of your script, you might want to always place one advert on every station (as seen with the Breakdowns & Servicing script), or you might want to place an arbitrary number of adverts on a given station (as seen with deliveries, or assassinations).<br />
<br />
The opportunities to add an advert are presented by two events. <code>onCreateBB</code> is the obvious one; there is also <code>onUpdateBB</code>, which is called for all existing bulletin boards in the current system, approximately once every hour or two. The actual interval is not particularly predictable.<br />
<br />
The <code>AddAdvert()</code> method takes three arguments. The first is the text that will appear on the advert. The second is the function that will be called when the player clicks the advert. The third is optional, and is a function that can be called when the advert is deleted for any reason.<br />
<br />
<code>AddAdvert()</code> returns a reference number, which can subsequently be used to remove the advert using <code>RemoveAdvert()</code>.<br />
<br />
It's the job of the scripter to decide how many, if any, adverts to add to a bulletin board when <code>onCreateBB</code> is triggered, and whether to add or remove any when <code>onUpdateBB</code> is triggered. Tests could include the population of the system, the type of starport or the type of planet. In the future, tests will be able to include the government type of the system.<br />
<br />
One important thing to bear in mind is that the script cannot query a bulletin boad to find out what adverts already exist. Each script must carefully track each advert that it has created if it is to have any control over how long they remain, and to be able to re-create them after a reload.<br />
<br />
Here is an example of adding an advert. The effect of clicking the advert is simply to send a message to the player console with the name of the station. The advert is only added if the station is in space. There is no mission here; I am simply illustrating the mechanics of adding the advert.<br />
<br />
local onCreateBB = function (station)<br />
<br />
-- This function can be in any scope that's visible when AddAdvert() is called<br />
local sendStationName = function ()<br />
UI.Message(station.label)<br />
end<br />
<br />
if station.type == 'STARPORT_ORBITAL' then<br />
station:AddAdvert('Need the name of this station?',sendStationName)<br />
end<br />
end<br />
<br />
EventQueue.onCreateBB:Connect(onCreateBB)<br />
<br />
This code will create an advert:<br />
<br />
[[File:interact.bbsad.1.png]]<br />
<br />
Looking at the image, you will notice that my advert has appeared at a completely arbitrary location on the bulletin board. There is no way to specify the location, and no way to determine it.<br />
<br />
Clicking on the advert causes this to happen:<br />
<br />
[[File:interact.bbsad.2.png]]<br />
<br />
Even though the only thing our function did was to send a message to the console (visible at the bottom), you can see that Pioneer automatically created a form for our advert. The only control is the "Go back" button, and the name and face are defaulted to that which was displayed on the main bulletin board.<br />
<br />
==The BBS form==<br />
<br />
Once the player has clicked on an advert, they are presented with a form. Each advert has only one form. The content of the form is added by the script, and can be modified at any time. It consists of a title, a face, a message and zero or more clickable options.<br />
<br />
The form itself is passed to the function specified in the <code>SpaceStation.AddAdvert()</code> method. In the example above, that function would be <code>sendStationName()</code>, which simply ignored any parameters sent to it. This resulted in the form being blank.<br />
<br />
The form object which is passed to this function has methods for adding the content. <code>SetTitle()</code> and <code>SetMessage()</code> each accept a string. <code>SetFace()</code> takes a table of information which defines the photofit face on the left. <code>AddOption()</code> adds clickable options with buttons. <code>Clear()</code> removes the Message and Options, but preserves the Title and Face, while <code>Close()</code> acts the same way as the "Go back" button.<br />
<br />
The following example doesn't have any clickable options, but does have a customized form:<br />
<br />
local populateForm = function (form)<br />
local facedata = {<br />
name = "Bob",<br />
female = true,<br />
title = "Lorry driver",<br />
}<br />
<br />
form:SetTitle('This appears above the face picture')<br />
form:SetFace(facedata)<br />
form:SetMessage([[This is the main message.<br />
<br />
It is normally a multi-line string.]])<br />
end<br />
<br />
local onCreateBB = function (station)<br />
station:AddAdvert('This appears in the advert list',populateForm)<br />
end<br />
<br />
EventQueue.onCreateBB:Connect(onCreateBB)<br />
<br />
As before, an advert was created:<br />
<br />
[[File:interact.bbsad.3.png]]<br />
<br />
Randomly, it has appeared at the top of the list.<br />
<br />
Clicking on the advert causes this to happen:<br />
<br />
[[File:interact.bbsad.4.png]]<br />
<br />
Now we can see that <code>populateForm</code> was called, and it successfully filled the form with content. All of the face options were optional; if they aren't provided, Pioneer will choose random values. I have left out a couple of options here; it's wise to specify them all, because after a saved game is loaded, it's the script's job to make sure that the same face appears (see "[[Surviving a reload]]").<br />
<br />
==Adding options to the form==<br />
<br />
In the example above, I created a function named <code>populateForm()</code> which was run when the advert button was clicked. That's not the only time it can be run; it is also run whenever options on its form are clicked.<br />
<br />
To make use of this, it is passed two additional parameters, both of which <code>populateForm()</code> ignored. The first parameter is the form object, the second is the advert's unique reference and the third is the number of the option that was clicked. Because it handles all chat events, by convention we instead name this function <code>onChat()</code>, which is how it shall be named from now on.<br />
<br />
The previous example did not store or use the value returned by <code>AddAdvert()</code>. It is this value which is sent as the second parameter; very useful if your script adds several adverts, each of which might have slightly differently worded content.<br />
<br />
When the advert was clicked in the main bulletin board list, it was passed the value <code>0</code> as the option.<br />
<br />
Form options are declared like this:<br />
<br />
form:AddOption('I am option one',1)<br />
form:AddOption('I am option two',2)<br />
<br />
These options will appear with the specified caption, and will call <code>onChat()</code>, which will receive the form object, the advert reference and the number that was specified after the caption in <code>AddOption()</code>.<br />
<br />
The codedoc has a brilliant example of a complete onChat, which I will reproduce here:<br />
<br />
local onChat = function (form, ref, option)<br />
form:Clear()<br />
<br />
-- option 0 is called when the form is first activated from the<br />
-- bulletin board<br />
if option == 0 then<br />
<br />
form:SetTitle("Favourite colour")<br />
form:SetMessage("What's your favourite colour?")<br />
<br />
form:AddOption("Red", 1)<br />
form:AddOption("Green", 2)<br />
form:AddOption("Yellow", 3)<br />
form:AddOption("Blue", 4)<br />
form:AddOption("Hang up.", -1)<br />
<br />
return<br />
end<br />
<br />
-- option 1 - red<br />
if option == 1 then<br />
form:SetMessage("Ahh red, the colour of raspberries.")<br />
form:AddOption("Hang up.", -1)<br />
return<br />
end<br />
<br />
-- option 2 - green<br />
if option == 2 then<br />
form:SetMessage("Ahh green, the colour of trees.")<br />
form:AddOption("Hang up.", -1)<br />
return<br />
end<br />
<br />
-- option 3 - yellow<br />
if option == 3 then<br />
form:SetMessage("Ahh yellow, the colour of the sun.")<br />
form:AddOption("Hang up.", -1)<br />
return<br />
end<br />
<br />
-- option 4 - blue<br />
if option == 4 then<br />
form:SetMessage("Ahh blue, the colour of the ocean.")<br />
form:AddOption("Hang up.", -1)<br />
return<br />
end<br />
<br />
-- only option left is -1, hang up<br />
form:Close()<br />
end<br />
<br />
Here, every time <code>onChat()</code> is called, regardless of the specified option, the form is cleared. The option is checked, and the relevant content is added to the form. Any other functions can be called from here, and this is how the script gets input from the player.<br />
<br />
An alternative format might be this:<br />
<br />
local onChat = function (form, ref, option)<br />
form:Clear()<br />
<br />
local options = {<br />
[0] = function ()<br />
form:SetTitle("Favourite colour")<br />
form:SetMessage("What's your favourite colour?")<br />
<br />
form:AddOption("Red", 1)<br />
form:AddOption("Green", 2)<br />
form:AddOption("Yellow", 3)<br />
form:AddOption("Blue", 4)<br />
form:AddOption("Hang up.", -1)<br />
end,<br />
[1] = function ()<br />
form:SetMessage("Ahh red, the colour of raspberries.")<br />
form:AddOption("Hang up.", -1)<br />
end,<br />
[2] = function ()<br />
form:SetMessage("Ahh green, the colour of trees.")<br />
form:AddOption("Hang up.", -1)<br />
end,<br />
[3] = function ()<br />
form:SetMessage("Ahh yellow, the colour of the sun.")<br />
form:AddOption("Hang up.", -1)<br />
end,<br />
[4] = function ()<br />
form:SetMessage("Ahh blue, the colour of the ocean.")<br />
form:AddOption("Hang up.", -1)<br />
end,<br />
[-1] = function ()<br />
form:Close()<br />
end<br />
}<br />
options[option]()<br />
end<br />
<br />
==The player's mission list==<br />
<br />
Once the player has negotiated with your form, there might well be a mission in play. It could be a delivery, an assassination, a rush to tell somebody not to leave because so-and-so loves them... the possibilities are limited only by your creativity.<br />
<br />
The player needs a way to keep track of all the missions that they have agreed to undertake. Pioneer provides this through the player's mission screen, which they can access at any time using the F3 button, and looking at the missions tab.<br />
<br />
The content of this screen is controlled by some methods on the <code>Player</code> object, which can always be found at <code>Game.player</code>, and which inherits from <code>Ship</code> and <code>Body</code>. Missions are added to the screen using the <code>AddMission()</code> method. It takes a table of info, and returns an integer reference to that mission, which should be stored so that it can be updated or removed later. So, it usually looks a little like <code>ref = Game.player:AddMission(table_of_info)</code>.<br />
<br />
In practice, it might look more like this:<br />
<br />
local mission_storage={}<br />
<br />
table.insert(mission_storage,Game.player:AddMission({<br />
type = "Fetch beer",<br />
client = "Bert Beerbreath",<br />
due = Game.time + 600, -- ten minutes' time<br />
reward = 10,<br />
location = Game.player.frameBody.path, -- here, basically<br />
status = 'ACTIVE'<br />
}))<br />
<br />
table.insert(mission_storage,Game.player:AddMission({<br />
type = "Fetch curry",<br />
client = "Curt Curryface",<br />
due = Game.time + 900, -- fifteen minutes' time<br />
reward = 5,<br />
location = Game.player.frameBody.path,<br />
status = 'ACTIVE'<br />
}))<br />
<br />
I don't recommend using <code>Game.player.frameBody.path</code> here. I'm only using it because it always returns something, whether docked or not. A real mission would probably use a space station here.<br />
<br />
This creates visible missions on the mission screen:<br />
<br />
[[File:interact.misscrn.1.png]]<br />
<br />
These missions will remain exactly like that forever, unless a script explicitly makes changes. There is no automatic logic, and no automatic removal. Your script must keep track of them. In this example, I have the references in the <code>mission_storage</code> table.<br />
<br />
The <code>UpdateMission()</code> method allows a script to alter any detail. The status can be <code>'ACTIVE'</code>,<code>'FAILED'</code> or <code>'COMPLETED'</code>. I'm going to change the status of the first mission to <code>'COMPLETED'</code>.<br />
<br />
Game.player:UpdateMission(mission_storage[1],{status='COMPLETED'})<br />
<br />
The updated information can be a partial table. The unspecified members will remain unchanged:<br />
<br />
[[File:interact.misscrn.2.png]]<br />
<br />
The <code>GetMission()</code> method allows a script to read data from a mission, if the script has the reference. It returns a table with that information. Here, I'm going to add ten minutes to the deadline of the second mission:<br />
<br />
local due_date = Game.player:GetMission(mission_storage[2]).due<br />
Game.player:UpdateMission(mission_storage[2],{due = due_date + 600})<br />
<br />
The result:<br />
<br />
[[File:interact.misscrn.3.png]]<br />
<br />
The <code>RemoveMission()</code> method allows a script to remove a mission. Here I remove the completed one:<br />
<br />
Game.player:RemoveMission(mission_storage[1])<br />
table.remove(mission_storage,1)<br />
<br />
And here it isn't:<br />
<br />
[[File:interact.misscrn.4.png]]<br />
<br />
==Mission flavours==<br />
<br />
A script can define a mission, and then place many instances of it onto many bulletin boards. A script that introduces many instances should provide some variety; it would harm immersion if all delivery missions were worded identically, for example.<br />
<br />
To introduce variety, we can use tables, which contain all of the lines needed for bulletin board forms, messages and so forth. It's then a simple matter to use a similar, but differently worded, table to make the same misison appear different. A flavour might look like this:<br />
<br />
{<br />
title = "Shill bidder wanted for auction",<br />
greeting = "Hi there. Want to earn some quick cash?",<br />
yesplease = "Sure. What do you need me to do?",<br />
nothanks = "No, ta - this looks a bit shady.",<br />
}<br />
<br />
An alternative flavour might look like this:<br />
<br />
{<br />
title = "Help me win an auction.",<br />
greeting = "Hello. I'll pay you to place fake bids for me. Interested?",<br />
yesplease = "Yes, I like to live dangerously.",<br />
nothanks = "No thanks; I'd rather not get arrested for fraud.",<br />
}<br />
<br />
Ideally, we just need a table with as many of these as we can be bothered to write, then select one at random.<br />
<br />
There are issues with translation, though. Because flavours are often full of colloquial language, and can feature several ways of saying basically the same thing, translating them all word-for-word is not necessarily productive. To this end, the Translate system features a pair of methods which can ease the handling of flavours, especially in different languages.<br />
<br />
The <code>Translate:AddFlavour()</code> method allows a flavour to be added, and marked as being of a specific language. By convention, these statements would appear in the script's <code>Languages.lua</code> file so that translators could see them and be inspired to write some in other languages. The method takes three arguments. The first is the language of the flavour, as a string. The second is a name, so that the <code>Translate</code> class can give flavours back to the correct script. The third is the flavour table itself. If my script was named <code>TestModule</code>, I might define the two flavours above in my <code>Languages.lua</code> as follows:<br />
<br />
Translate:AddFlavour('English','TestModule',{<br />
title = "Shill bidder wanted for auction",<br />
greeting = "Hi there. Want to earn some quick cash?",<br />
yesplease = "Sure. What do you need me to do?",<br />
nothanks = "No, ta - this looks a bit shady.",<br />
})<br />
<br />
Translate:AddFlavour('English','TestModule',{<br />
title = "Help me win an auction.",<br />
greeting = "Hello. I'll pay you to place fake bids for me. Interested?",<br />
yesplease = "Yes, I like to live dangerously.",<br />
nothanks = "No thanks; I'd rather not get arrested for fraud.",<br />
})<br />
<br />
As an added benefit, <code>Translate:AddFlavour()</code> checks all flavour tables for uniformity. It does this by comparing all of the table's keys with that of the first English flavour that was specified; a technical consequence of this is that an English flavour needs to come first in your <code>Languages.lua</code> file, otherwise Pioneer will give you an error.<br />
<br />
To fetch the flavours into your script, use <code>Translate.GetFlavours()</code>. It takes a single argument, which is the module name that was specified in <code>AddFlavour()</code>'s second parameter. It doesn't matter to <code>Translate</code> how many flavours there are in each language, or whether it's an equal number. If my current language is not English, and there are no flavours in that language, English flavours will be used instead. If there is only one flavour in my language, I will only see that one variety.<br />
<br />
The following example will select a random flavour from my flavour tables.<br />
<br />
local all_flavours = Translate:GetFlavours('TestModule')<br />
local flavour = all_flavours[Engine.rand:Integer(1,#all_flavours)]<br />
<br />
<code>GetFlavours()</code> returns a table of flavours. The second line of code generates a random number between 1 and the number of flavours in that table, and returns that flavour from the table. After this, <code>flavour.title</code> will either be <code>"Shill bidder wanted for auction"</code> or <code>"Help me win an auction."</code>. Adding more flavours means more variety.<br />
<br />
==Maintaining immersion==<br />
<br />
Fictionally, of course, this bulletin board is visible to any and all ships that dock at the space station, not just the player. It is important that bulletin board missions are not all scaled to the capabilities of the player. Delivery missions with unreasonable deadlines should not be ruled out. Neither should cargo missions requiring much more cargo space than the player's ship has, or combat missions for which the player is completely unqualified.<br />
<br />
These missions should deal with the player gracefully; either allowing them to fail, and providing consequences, or preventing them from being given the mission.<br />
<br />
It's also important, if your script serves many instances of a mission, to periodically clear away bulletin board adverts and place new ones. Not just those with obvious time constraints, but any others; the assumption that the player should make is that perhaps some other character has taken these missions.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Surviving_a_reload&diff=59Surviving a reload2012-09-11T04:41:31Z<p>Philbywhizz: Initial conversion from github</p>
<hr />
<div>When a game is saved, a script is responsible for informing Pioneer exactly which of its data need to be saved. If nothing is specified, nothing will be saved at all. Similarly, after a game is loaded, a script is responsible for restoring all of its saved data; re-creating bulletin board adverts, the player's mission details, and any run-time state.<br />
<br />
Here is a simple form. If a new game is started, you will see this on every bulletin board that you visit:<br />
<br />
local onChat = function (form, ref, option)<br />
form:Clear()<br />
form:SetMessage("Hello!")<br />
end<br />
<br />
local onCreateBB = function (station)<br />
station:AddAdvert('Click here for a greeting',)<br />
end<br />
<br />
EventQueue.onCreateBB:Connect(onCreateBB)<br />
<br />
If, however, you save the game, then reload, you will not see it on any bulletin board that had been created in the current system before you saved. onCreateBB will be triggered for any subsequently created bulletin boards, but not for those that already existed. It isn't appropriate to have scripts create new adverts just because a player has loaded; instead, it's the responsibility of the script to tell Pioneer what to save, and to use those saved data to restore all adverts after the game is loaded. The same goes for player missions, and any working data that the script is using.<br />
<br />
There are two things we need to do to achieve all of this.<br />
<br />
* We need to track everything that the script is doing.<br />
* We need to be able to pack this away for saving, and bring it back after loading.<br />
<br />
==Tracking everything that we are doing==<br />
<br />
Any local table that is declared in file scope is visible to the entire script, without affecting any other scripts. Essential data should be kept in such tables.<br />
<br />
==Tracking adverts==<br />
<br />
It's important to be able to re-create an advert, so part of the process of making one should be storing that information. Your script will need to make a note of in which station the advert was placed, which flavour was used (if you have flavours), the face data that was used on the form and any unique information that was used, such as specific mission details, reward, etc. The simplest way to keep all of this together is in a table, gathering up the variables by name into keys of the same name:<br />
<br />
local advert = {<br />
station = station,<br />
flavour = flavour, -- This will be a table<br />
facedata = facedata, -- This will be a table<br />
target = target,<br />
destination = destination,<br />
reward = reward,<br />
}<br />
<br />
Remember, the <code>AddAdvert()</code> method takes three arguments: The advert text, the <code>onChat</code> function and the <code>onDelete</code> function. It also returns a unique number, which lends itself nicely to storing the information away. That same unique number is passed to the onChat function, allowing onChat to check that stored information.<br />
<br />
The <code>onDelete()</code> function (again, we call it that by convention only) also accepts this reference as its argument, and is called whenever an advert is destroyed, whether that destruction be explicit (<code>RemoveAdvert()</code>) or implicit (the player hyperspaces away).<br />
<br />
So, we can track adverts that have been created, and stop tracking any that have gone away. I'll do that using the reference returned by <code>AddAvert()</code> as the key to a file-scoped local table:<br />
<br />
local all_flavours = Translate:GetFlavours('TestModule')<br />
local all_adverts = {}<br />
<br />
local onChat = function (form, ref, option)<br />
form:Clear()<br />
form:SetFace(all_adverts[ref].facedata)<br />
form:SetMessage(all_adverts[ref].flavour.title)<br />
end<br />
<br />
local onDelete = function (advert_ref)<br />
all_adverts[advert_ref] = nil<br />
end<br />
<br />
local onCreateBB = function (station)<br />
local flavour = all_flavours[Engine.rand:Integer(1,#all_flavours)]<br />
advert_ref = station:AddAdvert(flavour.title,onChat,onDelete)<br />
local female = Engine.rand:Integer(1) == 1<br />
all_adverts[advert_ref] = {<br />
station = station,<br />
flavour = flavour,<br />
facedata = {<br />
female = female,<br />
name = NameGen.FullName(female),<br />
seed = Engine.rand:Integer()<br />
}<br />
}<br />
end<br />
<br />
EventQueue.onCreateBB:Connect(onCreateBB)<br />
<br />
==Tracking missions==<br />
<br />
This is less of a challenge. Whenever <code>Player.AddMission()</code> is called, it returns a reference to the mission. That reference can be stored in a file-local table, and that table can be iterated through, and <code>Player.GetMission()</code> called on each one. We can wrap these functions up:<br />
<br />
local missionrefs = {}<br />
<br />
local AddMission = function(mission)<br />
table.insert(missionrefs,Game.player:AddMission(mission))<br />
return missionrefs[#missionrefs]<br />
end<br />
<br />
local RemoveMission = function(mref)<br />
for i,m in ipairs(missionrefs) do<br />
if m == mref then<br />
table.remove(missionrefs,i)<br />
end<br />
end<br />
Game.player:RemoveMission(mref)<br />
end<br />
<br />
Now, instead of calling <code>Game.player:AddMission()</code> and <code>Game.Player:RemoveMission()</code>, we just directly call our local functions, <code>AddMission()</code> and <code>RemoveMission()</code>. They will send their argument on to the instance in <code>Game.player</code>, and also store or remove the mission ref in the missionrefs table. There is now a record of which missions belong to this script.<br />
<br />
==Serializing: Packing away for saving and loading==<br />
<br />
The <code>Serializer</code> object provides one method: <code>Register</code>. It takes three arguments. The first is a name; a simple string with which to uniquely identify this script. It's probably sensible to re-use the name that was used for the <code>Translate</code> object's flavour methods. The second argument is the name of a function which will return a single table. The third argument is a function that will accept a single table.<br />
<br />
The second argument is your '''serializer''' function. The third is your '''unserializer''' function. By convention, we name these <code>serialize</code> and <code>unserialize</code>.<br />
<br />
<code>serialize</code> must return a table. This table must contain everything that you need to store to get your script working after a reload. It will be run when the player saves the game.<br />
<br />
<code>unserialize</code> accepts a table, and does something with it. It will be run by the serializer after the game is loaded, immediately before the <code>onGameStart</code> event is triggered. It is passed the data that serialize returned at save time.<br />
<br />
The most common way to deal with this is as follows (and this is very cut down):<br />
<br />
local table_stuff_this_script_uses = {}<br />
local loaded_data<br />
<br />
-- The rest of the script goes here!<br />
<br />
local onGameStart<br />
if loaded_data then<br />
for k,v in loaded_data.table_stuff_this_script_uses do<br />
table_stuff_this_script_uses[k] = v<br />
end<br />
loaded_data = nil<br />
else<br />
-- New game; do other stuff here perhaps<br />
end<br />
end<br />
<br />
local serialize = function ()<br />
return {table_stuff_this_script_uses = table_stuff_this_script_uses}<br />
end<br />
<br />
local unserialize = function (data)<br />
loaded_data = data<br />
end<br />
<br />
EventQueue.onGameStart:Connect(onGameStart)<br />
Serializer:Register("TestModule", serialize, unserialize)<br />
<br />
Now, combining that with the examples above, we get the following, which will save and load both the adverts and the missions that the script created:<br />
<br />
local all_flavours = Translate:GetFlavours('TestModule')<br />
local all_adverts = {}<br />
local missionrefs = {}<br />
<br />
local onGameStart = function ()<br />
all_adverts = {}<br />
missions = {}<br />
<br />
if not loaded_data then return end<br />
<br />
for k,ad in pairs(loaded_data.all_adverts) do<br />
local ref = ad.station:AddAdvert(ad.flavour.title, onChat, onDelete)<br />
all_adverts[ref] = ad<br />
end<br />
for k,mission in pairs(loaded_data.missions) do<br />
local mref = Game.player:AddMission(mission)<br />
table.insert(missions,mref)<br />
end<br />
<br />
loaded_data = nil<br />
end<br />
<br />
local onChat = function (form, ref, option)<br />
form:Clear()<br />
form:SetFace(all_adverts[ref].facedata)<br />
form:SetMessage(all_adverts[ref].flavour.title)<br />
-- some selective code here that will add missions, etc.<br />
end<br />
<br />
-- Other event handlers here that might change or remove missions or adverts<br />
<br />
local onDelete = function (advert_ref)<br />
all_adverts[advert_ref] = nil<br />
end<br />
<br />
local onCreateBB = function (station)<br />
local flavour = all_flavours[Engine.rand:Integer(1,#all_flavours)]<br />
advert_ref = station:AddAdvert(flavour.title,onChat,onDelete)<br />
local female = Engine.rand:Integer(1) == 1<br />
all_adverts[advert_ref] = {<br />
station = station,<br />
flavour = flavour,<br />
facedata = {<br />
female = female,<br />
name = NameGen.FullName(female),<br />
seed = Engine.rand:Integer()<br />
}<br />
}<br />
end<br />
<br />
local AddMission = function(mission)<br />
table.insert(missionrefs,Game.player:AddMission(mission))<br />
return missionrefs[#missionrefs]<br />
end<br />
<br />
local RemoveMission = function(mref)<br />
for i,m in ipairs(missionrefs) do<br />
if m == mref then<br />
table.remove(missionrefs,i)<br />
end<br />
end<br />
Game.player:RemoveMission(mref)<br />
end<br />
<br />
local serialize = function ()<br />
local missions_in_full = {}<br />
for k,mref in ipairs(missions) do<br />
table.insert(missions_in_full,Game.player:GetMission(mref))<br />
end<br />
return { all_adverts = all_adverts, missions = missions_in_full }<br />
end<br />
<br />
local unserialize = function (data)<br />
loaded_data = data<br />
end<br />
<br />
EventQueue.onGameStart:Connect(onGameStart)<br />
EventQueue.onCreateBB:Connect(onCreateBB)<br />
Serializer:Register("TestModule", serialize, unserialize)<br />
<br />
Although the example is functional, it has been coded with brevity alone in mind. I would not recommend using this as the basis for a mission without at least completely rewriting <code>onChat()</code>, and possibly tidying up the temporary loop variable names.<br />
<br />
The codedoc is complete and accurate, and the scripts provided with Pioneer are good examples themselves. The API is extensive, but if you find that there are additonal things you would like to be able to do, or information you would like from Pioneer, the dev team are willing to extend the API to accommodate script writers. Simply create a new issue on the [https://github.com/pioneerspacesim/pioneer/issues Github issue tracker].<br />
<br />
Help is also always available on the [http://pioneerspacesim.net/forum Pioneer forum] on SpaceSimCentral.com, and many of the dev team can be found on IRC at all hours - simply connect to Freenode (irc.freenode.net channel #pioneer).</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Interacting_with_the_game:_Event-based_programming&diff=58Interacting with the game: Event-based programming2012-09-10T23:26:31Z<p>Philbywhizz: minor formatting tweaks</p>
<hr />
<div>The Lua scripts are all executed at startup. If you were to add a single file named <code>hello_world.lua</code> to the '''data/modules''' directory containing the following:<br />
<br />
print("Hello, World!")<br />
<br />
you would literally see the words, "''Hello, World!''" appear in Pioneer's output (if running in a terminal) shortly before the main menu appeared. You would also see it in the Lua console, if you were to open it.<br />
<br />
All file-scoped imperative statements in all Lua files are executed at that time. The way to get Lua code to interact with the game itself, beyond that time, is to write functions and to connect them to event handlers. Many events are triggered by Pioneer during the course of play, all of which will cause any functions which are connected to them, to run. Most will provide those functions with arguments.<br />
<br />
Here is a quick list of some of the more commonly used events:<br />
<br />
* <code>onGameStart</code> is triggered when the player clicks on a new game button in the main menu, or when the player loads a game.<br />
* <code>onEnterSystem</code> is triggered whenever any ship arrives in the current star system after a hyperspace journey.<br />
* <code>onLeaveSystem</code> is triggered whenever any ship leaves the current star system by hyperspacing.<br />
* <code>onShipDestroyed</code> is triggered whenever any ship is destroyed.<br />
* <code>onShipDocked</code> is triggered whenever any ship docks at a starport.<br />
<br />
There are many more. All are fully documented in the [http://eatenbyagrue.org/f/pioneer/codedoc/ Pioneer Codedoc]. Of the five that I have listed, only <code>onGameStart</code> does not provide the function with any arguments. The other four provide a reference to the ship in question, and the latter two each also provide an additional argument (a reference to the attacker, and the starport, respectively).<br />
<br />
==Writing a function for an event==<br />
<br />
An event handling function does not have to return anything. It will be passed any arguments specified in the documentation, which it can either deal with, or ignore. It has access to any variables that are declared in the same file scope, including named functions and tables.<br />
<br />
The following function sends a message to the player's ship console, welcoming them to Pioneer:<br />
<br />
local welcome = function ()<br />
UI.Message ('Welcome to Pioneer!')<br />
end<br />
<br />
The next one expects a ship, and if that ship is the player, it greets them again:<br />
<br />
local greetShip = function (ship)<br />
if ship:IsPlayer() then<br />
UI.Message ('Hope you had an enjoyable hyperjump.')<br />
end<br />
end<br />
<br />
All that remains is to attach these functions to events. The first, I'm going to attach to the <code>onGameStart</code> event, the second, I'm going to attach to <code>onEnterSystem</code>:<br />
<br />
EventQueue.onGameStart:Connect(welcome)<br />
EventQueue.onEnterSystem:Connect(greetShip)<br />
<br />
EventQueue is a global table containing all of the events, which themselves have methods to connect and disconnect functions as handlers. <code>Connect()</code> sets the function up as an event handler, and <code>Disconnect()</code> is its (rarely required) counterpart.<br />
<br />
It's actually common practice in Pioneer to name the function after the event:<br />
<br />
local onGameStart = function ()<br />
UI.Message ('Welcome to Pioneer!')<br />
end<br />
<br />
EventQueue.onGameStart:Connect(onGameStart)</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Interacting_with_the_game:_Event-based_programming&diff=57Interacting with the game: Event-based programming2012-09-10T22:42:58Z<p>Philbywhizz: initial import from github</p>
<hr />
<div>The Lua scripts are all executed at startup. If you were to add a single file named <code>hello_world.lua</code> to the '''data/modules''' directory containing the following:<br />
<br />
print("Hello, World!")<br />
<br />
you would literally see the words, "''Hello, World''!" appear in Pioneer's output (if running in a terminal) shortly before the main menu appeared. You would also see it in the Lua console, if you were to open it.<br />
<br />
All file-scoped imperative statements in all Lua files are executed at that time. The way to get Lua code to interact with the game itself, beyond that time, is to write functions and to connect them to event handlers. Many events are triggered by Pioneer during the course of play, all of which will cause any functions which are connected to them, to run. Most will provide those functions with arguments.<br />
<br />
Here is a quick list of some of the more commonly used events:<br />
<br />
* <code>onGameStart</code> is triggered when the player clicks on a new game button in the main menu, or when the player loads a game.<br />
* <code>onEnterSystem</code> is triggered whenever any ship arrives in the current star system after a hyperspace journey.<br />
* <code>onLeaveSystem</code> is triggered whenever any ship leaves the current star system by hyperspacing.<br />
* <code>onShipDestroyed</code> is triggered whenever any ship is destroyed.<br />
* <code>onShipDocked</code> is triggered whenever any ship docks at a starport.<br />
<br />
There are many more. All are fully documented in the [http://eatenbyagrue.org/f/pioneer/codedoc/ Pioneer Codedoc]. Of the five that I have listed, only onGameStart does not provide the function with any arguments. The other four provide a reference to the ship in question, and the latter two each also provide an additional argument (a reference to the attacker, and the starport, respectively).<br />
<br />
==Writing a function for an event==<br />
<br />
An event handling function does not have to return anything. It will be passed any arguments specified in the documentation, which it can either deal with, or ignore. It has access to any variables that are declared in the same file scope, including named functions and tables.<br />
<br />
The following function sends a message to the player's ship console, welcoming them to Pioneer:<br />
<br />
local welcome = function ()<br />
UI.Message ('Welcome to Pioneer!')<br />
end<br />
<br />
The next one expects a ship, and if that ship is the player, it greets them again:<br />
<br />
local greetShip = function (ship)<br />
if ship:IsPlayer() then<br />
UI.Message ('Hope you had an enjoyable hyperjump.')<br />
end<br />
end<br />
<br />
All that remains is to attach these functions to events. The first, I'm going to attach to the onGameStart event, the second, I'm going to attach to onEnterSystem:<br />
<br />
EventQueue.onGameStart:Connect(welcome)<br />
EventQueue.onEnterSystem:Connect(greetShip)<br />
<br />
EventQueue is a global table containing all of the events, which themselves have methods to connect and disconnect functions as handlers. <code>Connect()</code> sets the function up as an event handler, and <code>Disconnect()</code> is its (rarely required) counterpart.<br />
<br />
It's actually common practice in Pioneer to name the function after the event:<br />
<br />
local onGameStart = function ()<br />
UI.Message ('Welcome to Pioneer!')<br />
end<br />
<br />
EventQueue.onGameStart:Connect(onGameStart)</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=56Pioneer Wiki2012-09-10T22:34:29Z<p>Philbywhizz: menu update</p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
** [[Interacting with the game: Event-based programming]]<br />
** [[Interacting with the player: BBS forms]]<br />
** [[Surviving a reload]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Introduction_to_Mission_Scripting&diff=55Introduction to Mission Scripting2012-09-10T22:33:29Z<p>Philbywhizz: initial import of mission scripting intro</p>
<hr />
<div>Pioneer is extensible through the Lua scripting language. This document is intended to take the reader through the basics of coding up a mission for Pioneer, with a worked example. The assumption is made that the reader is already aware of basic programming concepts, and in particular has some knowledge of the Lua programming language.<br />
<br />
If you are not familiar with Lua, the [http://lua-users.org/wiki/LearningLua lua-users wiki: Learning Lua] page is a good place to start.<br />
<br />
==Pioneer's Lua environment==<br />
Pioneer contains a full Lua interpreter. There are three instances of the interpreter; one for defining models, one for defining the galaxy, and one for writing mission scripts. This document is focused exclusively on the latter of the three.<br />
<br />
When Pioneer is started, the universe is generated. After the universe is generated, Pioneer traverses the data/libs directory and all subdirectories, looking for files ending in the <code>.lua</code> extension. Each of these files are loaded into the interpreter and run. After these are run, Pioneer traverses the data/modules directory and does exactly the same thing. After this, the main menu is shown, and the player can begin a game.<br />
<br />
The order in which the Lua scripts are loaded and run is not strictly defined, other than the fact that scripts in the '''data/libs directory''' will be executed before scripts in the '''data/modules''' directory.<br />
<br />
Any globally defined functions or variables defined in those scripts will be available to any other scripts. We recommend that any functions or variables not explicitly intended for use by other scripts be declared with the <code>local</code> keyword, which will make them available only within the scope of the current file.<br />
<br />
Chapters:<br />
* [[Interacting with the game: Event-based programming]]<br />
* [[Interacting with the player: BBS forms]]<br />
* [[Surviving a reload]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Media_Coverage&diff=54Media Coverage2012-09-10T21:32:57Z<p>Philbywhizz: Added mobDB article</p>
<hr />
<div>The following websites or publications have mentioned or featured Pioneer.<br />
<br />
* [http://www.rockpapershotgun.com/2011/12/06/back-to-frontier-pioneer/ Rock Paper Shotgun] interviews the development team.<br />
* [http://github.com/blog/1228-game-bytes-2/ Github Game Bytes] blog entry featuring Pioneer.<br />
* [http://www.moddb.com/games/pioneer/ ModDB] article featuring Pioneer.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=53Pioneer Wiki2012-09-10T12:23:59Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
* [[Introduction to Mission Scripting]]<br />
* [http://eatenbyagrue.org/f/pioneer/codedoc/ LUA API Reference]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Development Model]]<br />
* [[Design_Workflow|Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=49Pioneer Wiki2012-09-07T11:31:33Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [http://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Our Development Model]]<br />
* [[Design_Workflow|Our Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Getting_Started_with_Development&diff=48Getting Started with Development2012-09-07T11:30:16Z<p>Philbywhizz: Imported getting started in development from github</p>
<hr />
<div>==Getting the Code==<br />
Pioneer is managed using Git, and is stored on [http://github.com Github]. The [http://github.com/pioneerspacesim/pioneer official repository] is the best one to get. To get it:<br />
<br />
git clone git://github.com/pioneerspacesim/pioneer.git<br />
<br />
This will get you on the "master" branch, which is where new code is merged. This is the latest and greatest development and is quite unstable. To build a specific alpha, you need to checkout the appropriate release tag:<br />
<br />
git checkout alpha20<br />
<br />
==Compiling Pioneer on Windows==<br />
An MSVC 2008 project file can be found in the win32/vc2008 folder. Open this project file and Pioneer should build just fine. All dependencies are provided so you don't need to compile any libraries.<br />
<br />
Copy the .dll files from win32/vc2008 into the root folder (the one containing data, src, win32 directories), and you will be able to run the pioneer .exe file you just compiled.<br />
<br />
==Compiling Pioneer on Linux==<br />
===Requirements===<br />
<br />
* libtool<br />
* sigc++-2.0<br />
* freetype2<br />
* GL and GLU<br />
* GLEW<br />
* SDL 1.2<br />
* SDLimage<br />
<br />
Since pioneer is currently only available from the source repository, you also need autoconf and automake in order to generate the ./configure script (by running ./bootstrap)<br />
<br />
You also need git to check the source code out from the repository.<br />
<br />
===Ubuntu commands to install all the requisite libraries===<br />
<br />
These may work on other versions of Ubuntu, and possibly Debian or their derivatives too.<br />
<br />
====Ubuntu 10.4====<br />
<br />
sudo apt-get install libsigc++-2.0-dev libglut3-dev libglew1.5-dev libsdl1.2-dev libvorbis-dev libsdl-image1.2-dev dh-autoreconf git libfreetype6-dev<br />
<br />
====Ubuntu 11.10====<br />
<br />
sudo apt-get install libsigc++-2.0-dev freeglut3-dev libglew1.5-dev libsdl1.2-dev libvorbis-dev libsdl-image1.2-dev dh-autoreconf git libfreetype6-dev<br />
<br />
===Fedora commands to install all the requisite libraries===<br />
<br />
These might work on other Fedora verisons, and Redhat-based systems.<br />
<br />
====Fedora 16====<br />
<br />
yum install libtool libsigc++20-devel mesa-libGL-devel mesa-libGLU-devel glew-devel SDL-devel SDL_image-devel freetype-devel libvorbis-devel libpng-devel gcc-c++<br />
<br />
===Building it===<br />
<br />
./bootstrap<br />
./configure<br />
make<br />
<br />
Currently Pioneer runs from where it is built, and doesn't require (or work with) '''make install'''. To run it:<br />
<br />
./src/pioneer<br />
<br />
===Debugging===<br />
<br />
For developers, gdb can be used for debugging<br />
<br />
gdb ./src/pioneer<br />
run<br />
<br />
Bugs, and feature requests, should be logged on the issue tracker.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=47Pioneer Wiki2012-09-07T11:22:33Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
* [http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
<br />
* [http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
<br />
----<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [https://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Getting Started with Development]]<br />
* [[Our Development Model]]<br />
* [[Design_Workflow|Our Design and Project Management Workflow]]<br />
|}<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=46Pioneer Wiki2012-09-07T11:19:15Z<p>Philbywhizz: Beginnings of a nice main page</p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century. The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems. <br />
<br />
[http://pioneerspacesim.net/download Download Pioneer] for Windows, Linux and Mac OSX<br />
[http://sourceforge.net/projects/pioneerspacesim/files/nightly/ Development Builds] (warning, may be more unstable than a release) <br />
----<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
----<br />
{|width=100%<br />
|width="33%" style="background:#bbffbb; border:2px solid #99ee99; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Community===<br />
* [http://pioneerspacesim.net/ Pioneer Space Sim Homepage]<br />
* [http://pioneerspacesim.net/forum Forums]<br />
* [[FAQ]]<br />
* [https://twitter.com/pioneerspacesim @pioneerspacesim] on Twitter<br />
* [[Media Coverage]]<br />
|width="33%" style="background:#f0f0ff; border:2px solid #c6c9ff; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Content Creation===<br />
* [[Mods]]<br />
|width="33%" style="background:#fff3f3; border:2px solid #ffc9c9; padding:2px 2px 4px 4px; vertical-align: top"|<br />
===Development===<br />
* [[Our Development Model]]<br />
* [[Design_Workflow|Our Design and Project Management Workflow]]<br />
|}<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=45Pioneer Wiki2012-09-07T10:00:44Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century.<br />
<br />
The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems.<br />
<br />
When Pioneer is finished there will be many ways to make ends meet: piracy, smuggling, bounty-hunting, mining, doing missions for the various factions fighting for power, freedom or self-determination<br />
<br />
----<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]<br />
<br />
<br />
==Site Map==<br />
<br />
===General===<br />
* [[FAQ]]<br />
* [[Mods]]<br />
* [[Media Coverage]]<br />
<br />
===Development===<br />
* [[Our Development Model]]<br />
* [[Design_Workflow|Our Design and Project Management Workflow]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Media_Coverage&diff=43Media Coverage2012-09-07T09:59:56Z<p>Philbywhizz: moved In the media to Media Coverage</p>
<hr />
<div>The following websites or publications have mentioned or featured Pioneer.<br />
<br />
* [http://www.rockpapershotgun.com/2011/12/06/back-to-frontier-pioneer/ Rock Paper Shotgun] interviews the development team.<br />
* [http://github.com/blog/1228-game-bytes-2/ Github Game Bytes] blog entry featuring Pioneer.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=In_the_media&diff=44In the media2012-09-07T09:59:56Z<p>Philbywhizz: moved In the media to Media Coverage</p>
<hr />
<div>#REDIRECT [[Media Coverage]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Media_Coverage&diff=42Media Coverage2012-09-07T09:58:06Z<p>Philbywhizz: Minor tidying up</p>
<hr />
<div>The following websites or publications have mentioned or featured Pioneer.<br />
<br />
* [http://www.rockpapershotgun.com/2011/12/06/back-to-frontier-pioneer/ Rock Paper Shotgun] interviews the development team.<br />
* [http://github.com/blog/1228-game-bytes-2/ Github Game Bytes] blog entry featuring Pioneer.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Development_Model&diff=35Development Model2012-09-07T07:26:43Z<p>Philbywhizz: tweak release table look</p>
<hr />
<div>Pioneer's primary repository is hosted at https://github.com/pioneerspacesim/pioneer. To do any hacking you need your own clone of the repository. We recommend that you host your own repository on Github by forking the primary repository as we make heavy use of Github's features, but in the finest git tradition you're welcome to manage your copy of the code as you please.<br />
<br />
=Getting your changes into Pioneer=<br />
<br />
==Create feature branch==<br />
Get your master copy up to date with the central repository, and create a branch for whatever it is that you're working on.<br />
<br />
==Implement feature==<br />
Hack hack hack! This is the fun bit! Its recommended you stay in close contact with the other developers, either via IRC or the mailing list, to make sure that your work fits with the rest of the project.<br />
<br />
==Request merge==<br />
Once your code is ready you need to request that it be merged. If you're using Github, the standard mechanism is a pull request. This creates an issue in the issue tracker so your request doesn't get lost. If you're not using Github you should manually create an issue, point to a place where your repository can be accessed and the SHA1 of the branch head you want merged. We prefer the SHA1 over the symbolic ref so we can be sure that we're reviewing the same code.<br />
<br />
==Review==<br />
Once you've requested a merge someone will review your code. This is the most important part of the process. We insist on a review for two reasons:<br />
<br />
* Ensuring that the codebase remains consistent and there are no glaringly obvious bugs or structural defects in your code<br />
* Giving the reviewer an opportunity to learn your code and the parts of the codebase you changed<br />
For small changes the review will often be a quick nod from someone in IRC, possibly even the merge manager doing the review at the same time as the merge. Larger changes will require a more thorough review, possibly by more than one person (if an expert in a particular area is required).<br />
<br />
When the review is completed the reviewer should make a note on the relevant issue to indicate the branch is ready for merge.<br />
<br />
If the change does not pass review then the reviewer should note the problems in the issue. You should go back and fix the things that the reviewer flagged as problems and then update the issue/pull request with the new SHA1. The original reviewer should take the lead on follow-up reviews to make sure that all the original problems are addressed.<br />
<br />
==Merge==<br />
<br />
Once the review is complete the merge manager will complete the merge and push an updated master. Congratulations, your code is now a part of Pioneer!<br />
<br />
=Release process=<br />
From alpha 11 onwards Pioneer works on a timeboxed release schedule. Releases occur on the second Friday of each month. A release branch is created one week before this release. No new development is accepted onto this branch - only critical bugfixes and documentation updates.<br />
<br />
{| class="wikitable"<br />
|+Projected release dates<br />
|-<br />
!Release<br />
!Freeze date<br />
!Release date<br />
|-<br />
|Alpha 14<br />
|2 September 2011<br />
|9 September 2011<br />
|-<br />
|Alpha 15<br />
|7 October 2011<br />
|14 October 2011<br />
|-<br />
|Alpha 16<br />
|4 November 2011<br />
|11 November 2011<br />
|-<br />
|Alpha 17<br />
|2 December 2011<br />
|9 December 2011<br />
|-<br />
|Alpha 18<br />
|6 January 2012<br />
|13 January 2012<br />
|-<br />
|...<br />
|...<br />
|...<br />
|-<br />
|Alpha26<br />
|7 September 2012<br />
|14 September 2012<br />
|}<br />
<br />
''need to update this table'' [[User:Philbywhizz|Philbywhizz]] 17:33, 6 September 2012 (PDT)<br />
<br />
==Freeze==<br />
On the freeze date the release manager will create a new branch for the release. Development can continue according to the normal development process and code will be merged to master as normal. No new features will be included on the release branch except for critical bugfixes (as determined by the development team).<br />
<br />
The main purpose of the release branch is to give us time to test, update docs and prepare for release.<br />
<br />
==Release==<br />
Things that need to be done for release:<br />
<br />
* Ensure the Changelog, AUTHORS, README and other docs are up to date.<br />
* Do the builds<br />
* Test the builds. This includes making sure they run and making sure all the necessary files are included.<br />
* Upload<br />
* Update the download page with links, MD5 sums and the change log<br />
* Post announcements to:<br />
** pioneerspacesim.net news page<br />
** spacesimcentral.com forum<br />
** moddb.com page</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Media_Coverage&diff=27Media Coverage2012-09-07T04:09:55Z<p>Philbywhizz: Created page with "The following are sites where pioneer has been featured/promoted. * [http://www.rockpapershotgun.com/2011/12/06/back-to-frontier-pioneer/ Back To Front(ier): Pioneer] * [https:/..."</p>
<hr />
<div>The following are sites where pioneer has been featured/promoted.<br />
<br />
* [http://www.rockpapershotgun.com/2011/12/06/back-to-frontier-pioneer/ Back To Front(ier): Pioneer]<br />
* [https://github.com/blog/1228-game-bytes-2 Github Game Bytes #2]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=26Pioneer Wiki2012-09-07T04:05:34Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century.<br />
<br />
The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems.<br />
<br />
When Pioneer is finished there will be many ways to make ends meet: piracy, smuggling, bounty-hunting, mining, doing missions for the various factions fighting for power, freedom or self-determination<br />
<br />
----<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]<br />
<br />
<br />
==Site Map==<br />
<br />
===General===<br />
* [[FAQ]]<br />
* [[Mods]]<br />
* [[In the media]]<br />
<br />
===Development===<br />
* [[Our Development Model]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=25Pioneer Wiki2012-09-07T04:02:42Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is a space adventure game set in the milkyway galaxy at the turn of the 31st century.<br />
<br />
The game is open-ended, and you are free to explore the millions of star systems in the game. You can land on planets, slingshot past gas giants, and burn yourself to a crisp flying between binary star systems.<br />
<br />
When Pioneer is finished there will be many ways to make ends meet: piracy, smuggling, bounty-hunting, mining, doing missions for the various factions fighting for power, freedom or self-determination<br />
<br />
----<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]<br />
<br />
<br />
==Site Map==<br />
<br />
===General===<br />
* [[FAQ]]<br />
* [[Mods]]<br />
===Development===<br />
* [[Our Development Model]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=User:Philbywhizz&diff=24User:Philbywhizz2012-09-07T01:10:50Z<p>Philbywhizz: </p>
<hr />
<div>=Role=<br />
* OSX port maintainer<br />
* Bug squasher<br />
* General developer and scripter<br />
* Dabble in 3d modeling<br />
<br />
=Bio=<br />
I've been in the IT industry for nearly 20 years. Have played with may different technologies and programming languages. (I can remember playing Elite on an old Commodore64 loaded from tape).<br />
<br />
These days I've settled down on OSX for home as my main platform. While I'm not a apple fanboy, I do appreciate nice products that just work so I can focus on what I love doing. I like to think that by helping to port pioneer to OSX I'm bring some of the ''old school'' fun I used to have to a new generation of people.<br />
<br />
-[[User:Philbywhizz|Philbywhizz]] http://www.philbywhizz.com</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=User:Philbywhizz&diff=23User:Philbywhizz2012-09-07T00:56:47Z<p>Philbywhizz: Created page with "=Role= * OSX port maintainer * Bug squasher * General developer and scripter * Dabble in 3d modeling =Bio= I've been in the IT industry for nearly 20 years. Have played with may..."</p>
<hr />
<div>=Role=<br />
* OSX port maintainer<br />
* Bug squasher<br />
* General developer and scripter<br />
* Dabble in 3d modeling<br />
<br />
=Bio=<br />
I've been in the IT industry for nearly 20 years. Have played with may different technologies and programming languages. (I can remember playing Elite on an old Commodore64 loaded from tape).<br />
<br />
These days I've settled down on OSX for home as my main platform. While I'm not a apple fanboy, I do appreciate nice products that just work so I can focus on what I love doing. I like to think that by helping to port pioneer to OSX I'm bring some of the 'old school' fun I used to have to a new generation of people.<br />
<br />
-[[User:Philbywhizz|Philbywhizz]] http://www.philbywhizz.com</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Development_Model&diff=22Development Model2012-09-07T00:33:01Z<p>Philbywhizz: Import of development model</p>
<hr />
<div>Pioneer's primary repository is hosted at https://github.com/pioneerspacesim/pioneer. To do any hacking you need your own clone of the repository. We recommend that you host your own repository on Github by forking the primary repository as we make heavy use of Github's features, but in the finest git tradition you're welcome to manage your copy of the code as you please.<br />
<br />
=Getting your changes into Pioneer=<br />
<br />
==Create feature branch==<br />
Get your master copy up to date with the central repository, and create a branch for whatever it is that you're working on.<br />
<br />
==Implement feature==<br />
Hack hack hack! This is the fun bit! Its recommended you stay in close contact with the other developers, either via IRC or the mailing list, to make sure that your work fits with the rest of the project.<br />
<br />
==Request merge==<br />
Once your code is ready you need to request that it be merged. If you're using Github, the standard mechanism is a pull request. This creates an issue in the issue tracker so your request doesn't get lost. If you're not using Github you should manually create an issue, point to a place where your repository can be accessed and the SHA1 of the branch head you want merged. We prefer the SHA1 over the symbolic ref so we can be sure that we're reviewing the same code.<br />
<br />
==Review==<br />
Once you've requested a merge someone will review your code. This is the most important part of the process. We insist on a review for two reasons:<br />
<br />
* Ensuring that the codebase remains consistent and there are no glaringly obvious bugs or structural defects in your code<br />
* Giving the reviewer an opportunity to learn your code and the parts of the codebase you changed<br />
For small changes the review will often be a quick nod from someone in IRC, possibly even the merge manager doing the review at the same time as the merge. Larger changes will require a more thorough review, possibly by more than one person (if an expert in a particular area is required).<br />
<br />
When the review is completed the reviewer should make a note on the relevant issue to indicate the branch is ready for merge.<br />
<br />
If the change does not pass review then the reviewer should note the problems in the issue. You should go back and fix the things that the reviewer flagged as problems and then update the issue/pull request with the new SHA1. The original reviewer should take the lead on follow-up reviews to make sure that all the original problems are addressed.<br />
<br />
==Merge==<br />
<br />
Once the review is complete the merge manager will complete the merge and push an updated master. Congratulations, your code is now a part of Pioneer!<br />
<br />
=Release process=<br />
From alpha 11 onwards Pioneer works on a timeboxed release schedule. Releases occur on the second Friday of each month. A release branch is created one week before this release. No new development is accepted onto this branch - only critical bugfixes and documentation updates.<br />
<br />
{| class="wikitable"<br />
|+Projected release dates<br />
|-<br />
!Release<br />
!Freeze date<br />
!Release date<br />
|-<br />
|Alpha 14<br />
|2 September<br />
|9 September<br />
|-<br />
|Alpha 15<br />
|7 October<br />
|14 October<br />
|-<br />
|Alpha 16<br />
|4 November<br />
|11 November<br />
|-<br />
|Alpha 17<br />
|2 December<br />
|9 December<br />
|-<br />
|Alpha 18<br />
|6 January<br />
|13 January<br />
|}<br />
<br />
''need to update this table'' [[User:Philbywhizz|Philbywhizz]] 17:33, 6 September 2012 (PDT)<br />
<br />
==Freeze==<br />
On the freeze date the release manager will create a new branch for the release. Development can continue according to the normal development process and code will be merged to master as normal. No new features will be included on the release branch except for critical bugfixes (as determined by the development team).<br />
<br />
The main purpose of the release branch is to give us time to test, update docs and prepare for release.<br />
<br />
==Release==<br />
Things that need to be done for release:<br />
<br />
* Ensure the Changelog, AUTHORS, README and other docs are up to date.<br />
* Do the builds<br />
* Test the builds. This includes making sure they run and making sure all the necessary files are included.<br />
* Upload<br />
* Update the download page with links, MD5 sums and the change log<br />
* Post announcements to:<br />
** pioneerspacesim.net news page<br />
** spacesimcentral.com forum<br />
** moddb.com page</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=21Pioneer Wiki2012-09-07T00:21:14Z<p>Philbywhizz: </p>
<hr />
<div>Pioneer is some kind of game thing.<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]<br />
<br />
== Pages under construction ==<br />
<br />
Please make a proper index or contents for these.<br />
<br />
===General===<br />
* [[FAQ]]<br />
* [[Mods]]<br />
===Development===<br />
* [[Our Development Model]]</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=FAQ&diff=20FAQ2012-09-07T00:14:19Z<p>Philbywhizz: Initial import of FAQ from the github wiki</p>
<hr />
<div>=Frequently Asked Questions=<br />
==What is Pioneer?==<br />
Pioneer is a freeform single player space adventure in the spirit of [https://en.wikipedia.org/wiki/Frontier:_Elite_II Frontier: Elite II].<br />
<br />
==Is this a game or a simulation?==<br />
Frontier was a game, but with a newtonian flight model and a slightly more scientific flavour to the universe than usually in space games. Pioneer will follow this same path.<br />
<br />
==Can I play online?==<br />
There will be no multiplayer. This does not rule out the possibility of minor network features, but multiplayer as it is commonly known is not compatible with the core mechanics of Pioneer.<br />
<br />
==Can I colonize planets, build space stations or conquer the universe?==<br />
No, these are out of the game scope. While the game universe might not stay static for the duration of a game, the player can not generally influence major events.<br />
<br />
==Can I walk around space stations and planets?==<br />
No, you cannot exit your ship. The ship is always your avatar.<br />
<br />
==Is the universe pre-defined or randomly generated?==<br />
There are millions of stars in the galaxy. A few hundred on them are based on real-world astronomic catalogues. some of the planets (obvious ones being in the Sol system) are pre-defined, but most things are procedurally generated. This means that a planet does not exist until you actually visit it, but it will be generated the same way for every player.<br />
<br />
==Can I hire crew for my ship?==<br />
Frontier had this, so it should be possible in Pioneer one day.<br />
<br />
==Are savegames compatible between releases?==<br />
While the game is still in alpha, this cannot be guaranteed. The situation will stabilize in a few years.<br />
<br />
==Where is star system X from Frontier? Can I buy ship Y?==<br />
Pioneer is not an exact clone of Frontier. You will have to figure out new trade routes!<br />
<br />
==How do I take screenshots?==<br />
Ctrl+Printscreen saves .png files in the same directory where the game .ini and savegames are.</div>Philbywhizzhttps://wiki.pioneerspacesim.net/index.php?title=Pioneer_Wiki&diff=19Pioneer Wiki2012-09-07T00:08:59Z<p>Philbywhizz: Add in FAQ link</p>
<hr />
<div>Pioneer is some kind of game thing.<br />
<br />
Please make this wiki nice. Copy the content over from the [https://github.com/pioneerspacesim/pioneer/wiki GitHub wiki], add stuff about mods, dev, whatever. Be awesome! [[Getting started|How to get started]].<br />
<br />
And write a nice front page and get rid of this, ok? :)<br />
<br />
Pioneer is brung to you by a flock of [https://github.com/pioneerspacesim/pioneer/blob/master/AUTHORS.txt opensource beardy-weirdies], and is [http://www.gnu.org/licenses/gpl.html Free Software]<br />
<br />
== Pages under construction ==<br />
<br />
Please make a proper index or contents for these.<br />
<br />
* [[FAQ]]<br />
* [[Mods]]</div>Philbywhizz