VsWiki - User contributions [en]

Development:Missions

2020-03-22T17:58:18Z

Nabaco: Switched SVN URLs to GH

{{NAV_Manual |
| previous=[[Development:Campaigns|Edit Campaigns]]
| up=[[HowTos]]
| next=[[HowTo:Edit News|Edit News]]
}}
----
==EDITING MISSIONS==
{{attention}}

===Introduction===
Vega Strike has a powerful missions scripting interface that allows you to nearly modify Vega Strike at whatever level you choose, from the AI scripts (and the physics thereof) to the missions... to the overall plot and goal of the game.

===[[HowTo:Edit_Missions:XML_integration|Basic XML integration]]===

===[[HowTo:Edit_Missions:Python:Missions|Python Inheritance In Missions]]===

===Conclusions===
Well this is the best I can do so far. Please read this documentation over and let me know if you have any suggestions or clarifications. And best yet give it a shot and try it out. And at least look at
'''[https://github.com/vegastrike/Assets-Production/tree/master/modules/missions/cargo_mission.py modules/missions/cargo_mission.py]''' (which is called from a number of missions I think) as well as '''[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/privateer.py modules/missions/privateer.py]''' called by '''[https://github.com/vegastrike/Assets-Production/blob/master/mission/explore_universe.mission mission/explore_universe.mission]'''. And certainly try to understand '''[https://github.com/vegastrike/Assets-Production/blob/master/modules/quests/quest_drone.py modules/quests/quest_drone.py]''' before trying to write a quest (or while trying to write one).

Please also have a look in [[Development:Quests]] for a detailed explanation on the structure of quests and an explanation on how they work.

==See also==
* [[HowTo:Add_Conversations]]
* [[HowTo:Edit_News]]
* [[Development:Campaigns]]

----
{{NAV_Manual |
| previous=[[Development:Campaigns|Edit Campaigns]]
| up=[[HowTos]]
| next=[[HowTo:Edit News|Edit News]]
}}

[[Category:HowTos|Edit Missions]]
[[Category:Development|Edit Missions]]

HowTo:Edit Missions:Python:Missions

2020-03-22T17:54:03Z

Nabaco: Replaced one SVN URL

==Python Inheritance In Missions==

Ok lets dig further into the <code>[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/privateer.py privateer.py]</code> module:

It is a very short module written in more or less pure python... I say more or less for a very specific reason: it inherits from a C++ class!

Director is a C++ class exported to python. All missions must inherit from director.... in this case the mission is very short as it uses other (pure python) modules. <code>random_encounters.random_encounters</code>, <code>difficulty.difficulty</code> and ,<code>trading.trading</code> all do NOT inherit from C++ as this class takes care of the C++ inheritance.

The constructor <code>__init__</code> takes the arguments that we passed in from the XML file and passes them on to the various submodules. The only really really important thing you do in the constructor is call
<pre>
Director.Mission.__init__ (self)
</pre>
If you do not do this, Vegastrike will not load your module and will silently fail (this calls the C++ constructor, which actually triggers the binding of your module to the python mission).

Each mission module must have an execute function so that something can happen every physics frame. In this case it just calls execute on all the submodules... not very interesting.

Missions also may have 2 functions:

* <code>Pickle (self)</code> which returns a string with a XML mission file that will load the mission properly as well as a string representing the mission in serialized form... if the mission were reloaded that mission would be loaded and its corresponding python would be run.
* Then <code>Unpickle (self, str)</code> would be called (with str being a string) and the expectation that the mission would be reloaded. <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/modules/newmission.py?rev=HEAD&content-type=text/vnd.viewcvs-markup modules/newmission.py]</code> has an example of this. {{fixme}} ''LINK IS WRONG!! - OLD DATA MODULE REFERENCE''

You may also choose to save data in a float by float format as follows (the advantage to this format is that it is saved on a PER PLAYER basis... so that each player may have a different value):

There are 4 functions at your disposal for this older way to save missions:

This function adds the key for later retrieval (even after VS quits ) and pushes the float to the end of the hashtable indexed by stringkey:

<pre>
myindex=Director.pushSaveData(int whichplayer, stringkey,floatVal);
</pre>

This function modifies a index in a key that has already been pushed back at one point:

<pre>
Director.putSaveData (intWhichPlayer, stringkey, myIndex, floatVal);
</pre>

This function gets the number of float values for a given player:

<pre>
Director.getSaveDataLength (int whichplayer, string key)
</pre>

This function gets save data saved at that number:

<pre>
Director.getSaveData(int whichplayer, stringkey, int num)
</pre>

You can make up stringkeys and save only 1 float per key if you wish... each key is allowed to have an vector of possible values. Use as you wish! For the privateer mission I save things with key 31337ness and the one value in there is the difficulty that I write out.... If a campaign is more global rather than player specific you may just choose to pickle it...however if something is on a per-player basis, it may be best going in these SaveData float vectors.

With the exception of AI modules from here on out it's straight python. I will go over some of the functions you can call inside Vega Strike in a minute.

[[Category:HowTos|Edit Missions:Python:Missions]]
[[Category:Development|Edit Missions:Python:Missions]]

HowTo:Edit Missions:XML integration

2020-03-22T17:27:03Z

Nabaco: Switched SVN URLs to GH

==Basic XML integration==
First let me start by explaining how to run a python class... in this case we start with the prebuild <code>[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/privateer.py modules/missions/privateer.py]</code> script to run our mission. Open up <code>[https://github.com/vegastrike/Assets-Production/blob/master/mission/explore_universe.mission mission/explore_universe.mission]</code> First come the variables that designate how the mission should normally start. By normally I mean if they don't have any save game present.

===Variables Section===

* '''continuousterrain''' [string]
** "" (default)
* '''credits''' [float] - Starting money.
** 0 (default)
* '''defaultplayer''' [string] - Team name. Doesn't seem to matter. {{fixme}}
* '''description''' [string] - Description is used in scripts only, the engine doesn't read it.
* '''difficulty''' [float] - Multiplier for lots of game parameters - e.g. "Basic repair" cost equals <code>[[Manual:Config:Advanced:Variables#.22physics.22_section|physics/repair_price]]</code>*difficulty.
** In net games is set by server variable. Can be modified by scripts later. E.g. difficulty.py module provides a simple way to automatically vary it with PC's wealth (it only goes up, to 0.999) and in default campaign it maxes out at 400000 Cr.
** 1 (default)
* '''num_players''' [int]
** 1 (default)
* '''savegame''' [string] - The savegame makes the mission more of a campaign type mission where things may be saved to disk and reloaded at a later point.
** If no savegame variable is specified (this is where the autosave goes) then the mission will not save and will be a one time play mission.
** "" (default)
* '''system''' [string] - Starting system. Can be overridden via savegame or scripts.
** "sol.system" and "Sol/Sol" (default) {{fixme}}
* '''terrain''' [string]
** "" (default)

<pre>
<mission>
<settings>
<origin planet="earth" x="0000" y="100" z="000.0"/>
</settings>

<variables>

<var name="credits" value="13500"/>
<var name="defaultplayer" value="blue"/>
<var name="mission_name" value="Privateer Mission" />
<var name="difficulty" value=".05"/>
<var name="system" value="Crucible/Cephid_17" />
<var name="description" value="Like, as if." />
<var name="savegame" value="explore_universe_difficulty" />
</variables>
</pre>
It loads <code>Crucible/Cephid_17.system</code> as the star system (which is in XML and stores all present planets) After this, comes the actors in the mission, the flightgroups of fighters. If a mission has more than one player, then each player is the leader (first ship) in each respective flightgroup.

Notice that so far there are a lot of values you don't see for long in the default vegastrike game. Credits, System, first flightgroup fighter, difficulty--these are all initial values but can change.... since there is specified a savegame.

===Flightgroup Section===

* <code>flightgroup</code>
** '''name''' [string] [needed] - The displayed name.
** '''logo''' [string]
** '''logo_alpha''' [string]
** '''faction''' [string] [needed]
** '''type''' [string] [needed] - Unit type.
*** "hornet.xunit" (default) {{fixme}}
** '''ainame''' [string] [needed] - AI to use.
*** Much like <code>data/ai/VegaEvents.csv</code>: it refers to <code>[https://github.com/vegastrike/Assets-Production/tree/master/ai/events data/ai/events/]'''ainame'''.*.xml</code> AI files, ''not'' .xai scripts they call.
*** "_ainame" - {{fixme}} Seems to use Python [https://github.com/vegastrike/Assets-Production/tree/master/modules/ai/ AI modules].
** '''waves''' [int] [needed] - Number of waves. The next one will be launched only after its predecessor is completely eliminated.
** '''nr_ships''' [int] [needed] - Ships per wave.
** '''terrain_nr'''
*** "" (default); "mission"
** '''unit_type'''
*** "" (default) ='''unit'''; "vehicle"; "building"
* <code>pos</code> [double] [needed], <code>rot</code> [float] - Coordinates and orientation.
** '''x''', '''y''', '''z''' [float]
* <code>order</code> - Scripted orders for the flightgroup. Elements are read, but seems to not being actually parsed currently. {{fixme}} Flightgroups spawn with "fire at will" directive and start acting as their AI setups and AI priorities suggest.
** '''order''' [needed]
** '''target''' [needed] - The name of target flightgroup.
** '''priority''' - Seems not to be used at all. {{fixme}}

<pre>
<flightgroups>
<flightgroup name="Shlimazel" faction="privateer" type="llama.begin"
ainame="default" waves="1" nr_ships="1">
<pos x="-95124024.543917" y="412089916.256812"
z="-110779667.398050"/>
<rot x="180.0" y="180.0" z="180.0"/>
<order order="tmptarget" target="omikron"/>
<order priority="0" order="superiority" target="enemy"/>
<order priority="1" order="bomber" target="omikron"/>
<order priority="2" order="escort" target="blue"/>
</flightgroup>
</flightgroups>
</pre>

The <code>rot</code> flag is ignored, and the position specifies the <code>x,y,z</code> coords of the Shlimazel flightgroup, which is of type <code>llama.begin</code>.

===Python Section===
Future note: If you wanted to add a campaign to the privateer mission you would most likely modify <code>privateer.py</code> to have a campaign module get loaded.... so you wouldn't necessarily need to modify <code>explore_universe.mission</code> just to add a campaign... lets dig further into the meat of the scripting.

If a mission has python tags...then it is a python mission and may have some embedded python in it. In this case the python makes a new python object of type privateer in the <code>privateer.py</code> module in the <code>[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/ modules/missions/]</code> directory.

<pre>
<python>
from privateer import privateer
my_obj=privateer(8000,40000,500,3,2,.6,.25,.1,400000,2000)
</python>
</mission>
</pre>

You have to be careful about newlines, etc in the XML, but it should usually work just dandy. You notice that the mission may pass in arguments to the privateer module that can make slight changes in the gameplay. This allows many cargo missions to use the same module in order to change the parameters of the cargo missions. In this case the values I have selected appear to work relatively well.

Note: Python code must be on a line by itself without any indentations--it needs to work exactly as it would if you had the contents in a python file itself. If you want the indents to work in-line with the XML file, you must prefix it with a block, such as an if statement:

<pre>
<python>if 1:
from privateer import privateer
my_obj=privateer(8000,40000,500,3,2,.6,.25,.1,400000,2000)
</python>
</mission>
</pre>

[[Category:HowTos|Edit Missions:XML integration]]
[[Category:Development|Edit Missions:XML integration]]

Development:Campaigns

2020-03-22T16:39:21Z

Nabaco: Switched the example campaign URL from SVN to GH

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [https://github.com/vegastrike/Assets-Production/blob/master/modules/campaigns.py link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode(args)'' - here you have to talk to a fixer and accept or reject the proposed mission.
* ''CampaignNode(args)'' - creates an action, like adding reward or adjusting a faction relation, without fixer intervention.
* ''CampaignChoiceNode(args)''

Nodes must be initialized first:

<code><pre>
ThisNode = CampaignClickNode() # initialize the node
ActionNode = CampaignNode()
</pre></code>

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement and the different types of mission nodes that can be created are described in the following section. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

* SaveVariableCondition
* HaveCredits
* InSystemCondition
* HasUndocked
* CargoSpaceCondition
* AtMostActiveMissionsCondition
* AtLeastActiveMissionsCondition
* OrCondition
* AndCondition
* InvertCondition

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Examples =

==The first major campaign written (Jenek)==

See also the [http://forums.vega-strike.org/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

==Ending Node with AddCredits and AdjustRelation==

<code><pre>
FinalNode.Init(vs, # savegame variable
[], #start location
[], #dialog
None, # fixer sprite
TrueSubnode(AddCredits(100000,AdjustRelation("privateer","pirates",0.01))), # subnode script
None, # completion script
[CampaignEndNode(vs)]) # continue with next mission
</pre></code>

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]