Difference between revisions of "X-Wing Alliance Advanced Mission Creation"

From Emperor's Hammer Encyclopaedia Imperia
Line 28: Line 28:
  
 
==Getting Started==
 
==Getting Started==
Download and install, following the installation instructions included with it, [https://github.com/MikeG621/YOGEME YOGEME]. If your XWA game directory is installed in the default Programs folder on the C Drive, or still has write protections applied to it from where it was copied, set YOGEME to run in Administrator Mode, otherwise it will not be able to edit mission files. Launch YOGEME and go to Tools -> Options menu.  
+
Download and install, following the installation instructions included with it, [https://github.com/MikeG621/YOGEME YOGEME]. If your XWA game directory is installed in the default Programs folder on the C Drive, or still has write protections applied to it from where it was copied, set YOGEME to run in Administrator Mode, otherwise it will not be able to edit mission files. Launch YOGEME and go to Tools -> Options menu.
[[Image:Options.png|thumb|right|<center>YOGEME Options Menu</center>]]
+
[[Image:Options.png|center|<center>YOGEME Options Menu</center>]]
 
*Overall Tab
 
*Overall Tab
 
**You have many different selection boxes to control the behavior of YOGEME
 
**You have many different selection boxes to control the behavior of YOGEME
 
***For the most part you can leave all the settings at their default values.
 
***For the most part you can leave all the settings at their default values.
[[Image:Options-Overall.png|thumb|right|<center>YOGEME Options Menu-Overall Tab</center>]]
+
[[Image:Options-Overall.png|center|<center>YOGEME Options Menu-Overall Tab</center>]]
 
*Map Tab
 
*Map Tab
 
**You can customize the behavior of the region map window when you initially launch it
 
**You can customize the behavior of the region map window when you initially launch it
[[Image:Options-Map.png|thumb|right|<center>YOGEME Options Menu-Map Tab</center>]]
+
[[Image:Options-Map.png|center|<center>YOGEME Options Menu-Map Tab</center>]]
 
*Wireframe Tab
 
*Wireframe Tab
 
**Further works to define the level of detail of the representations of the ship and object models when shown in the region map window
 
**Further works to define the level of detail of the representations of the ship and object models when shown in the region map window
[[Image:Options-Wireframe.png|thumb|right|<center>YOGEME Options Menu-Wireframe Tab</center>]]
+
[[Image:Options-Wireframe.png|center|<center>YOGEME Options Menu-Wireframe Tab</center>]]
 
*XWA Tab
 
*XWA Tab
 
**You will be able to select the file path of the XWA root directory for the copy of XWA that you are doing mission creation for. It is critical that you set this file path correctly as many of the functions of YOGEME depend on reading files from the XWA root directory
 
**You will be able to select the file path of the XWA root directory for the copy of XWA that you are doing mission creation for. It is critical that you set this file path correctly as many of the functions of YOGEME depend on reading files from the XWA root directory
 
***If you change the file path for the root directory, you will need to close YOGEME and reopen to allow it to properly read the data it needs
 
***If you change the file path for the root directory, you will need to close YOGEME and reopen to allow it to properly read the data it needs
 
**You can select the default craft type and IFF for all new craft
 
**You can select the default craft type and IFF for all new craft
[[Image:Options-XWA.png|thumb|right|<center>YOGEME Options Menu-XWA Tab</center>]]
+
[[Image:Options-XWA.png|center|<center>YOGEME Options Menu-XWA Tab</center>]]
 
*Colors Tab
 
*Colors Tab
 
**You can customize the appearance of YOGEME in a limited manor
 
**You can customize the appearance of YOGEME in a limited manor
[[Image:Options-Colors.png|thumb|right|<center>YOGEME Options Menu-Colors Tab</center>]]
+
[[Image:Options-Colors.png|center|<center>YOGEME Options Menu-Colors Tab</center>]]
  
 
==Menus==
 
==Menus==
Line 62: Line 62:
 
*Save As...
 
*Save As...
 
**For saving the current mission file, but allows you to change the name or file path or both
 
**For saving the current mission file, but allows you to change the name or file path or both
[[Image:File.png|thumb|right|<center>YOGEME File Menu</center>]]
+
[[Image:File.png|center|<center>YOGEME File Menu</center>]]
 
===EDIT===
 
===EDIT===
 
The “Edit” Menu contains what you would expect for a normal Windows Based program
 
The “Edit” Menu contains what you would expect for a normal Windows Based program
Line 75: Line 75:
 
*Delete
 
*Delete
 
**Allows for the deleting of selected text or FG
 
**Allows for the deleting of selected text or FG
[[Image:Edit.png|thumb|right|<center>YOGEME File Menu</center>]]
+
[[Image:Edit.png|center|<center>YOGEME Edit Menu</center>]]
 
===TOOLS===
 
===TOOLS===
 
The “Tools” Menu contains many of the functions of YOGEME
 
The “Tools” Menu contains many of the functions of YOGEME
[[Image:Tools.png|thumb|right|<center>YOGEME File Menu</center>]]
+
[[Image:Tools.png|center|<center>YOGEME Tools Menu</center>]]
 
*Verify Mission
 
*Verify Mission
 
**This runs a basic check of the mission file for common errors. It is not that useful of a check as it has many triggers to cause it to say the files in NOT VALID will the file is perfectly good to be used.
 
**This runs a basic check of the mission file for common errors. It is not that useful of a check as it has many triggers to cause it to say the files in NOT VALID will the file is perfectly good to be used.
Line 91: Line 91:
 
*FG Goal Summary
 
*FG Goal Summary
 
**This opens a window where all FG Goals are listed in a single place for a quick reference. See Goals Section for more details
 
**This opens a window where all FG Goals are listed in a single place for a quick reference. See Goals Section for more details
[[Image:FG Goal Summary.png|thumb|right|<center>Flight Group Goal Summary</center>]]
+
[[Image:FG Goal Summary.png|center|<center>Flight Group Goal Summary</center>]]
 
*FG Library
 
*FG Library
 
**This opens an incredibly useful window where you can save and organize the FGs of your mission into a common library that you will be able to quickly copy into another mission. This is very useful if you have created a particular region that you wish to use again in another mission.
 
**This opens an incredibly useful window where you can save and organize the FGs of your mission into a common library that you will be able to quickly copy into another mission. This is very useful if you have created a particular region that you wish to use again in another mission.
[[Image:FG Library.png|thumb|right|<center>YOGEME FG Library</center>]]
+
[[Image:FG Library.png|center|<center>YOGEME FG Library</center>]]
 
*Test
 
*Test
 
**This opens a window from which you can quickly launch into XWA and test the mission you are currently making. YOGEME will automatically create a pilot able to fly the mission you are currently editing.
 
**This opens a window from which you can quickly launch into XWA and test the mission you are currently making. YOGEME will automatically create a pilot able to fly the mission you are currently editing.
Line 100: Line 100:
 
**This opens a window from which you can quickly place Hyper Buoys to link the different regions. You are given the option to place a return pair as well.
 
**This opens a window from which you can quickly place Hyper Buoys to link the different regions. You are given the option to place a return pair as well.
 
***The buoys are placed at 0,0,0 in each region and don’t have arrival triggers (i.e. are always present)
 
***The buoys are placed at 0,0,0 in each region and don’t have arrival triggers (i.e. are always present)
[[Image:HyperbuoyWizard.png|thumb|right|<center>Hyper Buoy Wizard</center>]]
+
[[Image:HyperbuoyWizard.png|center|<center>Hyper Buoy Wizard</center>]]
 
*Apply Super Backdrops
 
*Apply Super Backdrops
 
**This is for X-Wing Alliance Upgrade or TIE Fighter Total Conversion installations and will be covered in a later guide
 
**This is for X-Wing Alliance Upgrade or TIE Fighter Total Conversion installations and will be covered in a later guide
Line 113: Line 113:
 
****Be on the same Team as the Player Craft
 
****Be on the same Team as the Player Craft
 
****Have the Arrival triggers set to “always (TRUE) (In Mission Craft List)”
 
****Have the Arrival triggers set to “always (TRUE) (In Mission Craft List)”
[[Image:Mission Craft List.png|thumb|right|<center>Mission Craft List</center>]]
+
[[Image:Mission Craft List.png|center|<center>Mission Craft List</center>]]
 
*GG and GU Summary
 
*GG and GU Summary
 
**Opens a window where all FG are organized and listed under both their assigned Global Groups and Global Units – See Global Groups and Units Section for more details
 
**Opens a window where all FG are organized and listed under both their assigned Global Groups and Global Units – See Global Groups and Units Section for more details
[[Image:GG and GU Summary.png|thumb|right|<center>GG and GU Summary</center>]]
+
[[Image:GG and GU Summary.png|center|<center>GG and GU Summary</center>]]
 
===HELP===
 
===HELP===
 
The "Help" Menu contains what you would expect for a Windows based program Help tab with a link to the built-in help files
 
The "Help" Menu contains what you would expect for a Windows based program Help tab with a link to the built-in help files
  
 
==Tool Bar==
 
==Tool Bar==
 +
The Tool Bar at the top of the YOGEME window allows for quick access to many of the function previously mentioned in the Menu Section
 +
[[Image:Tool Bar.png|center|<center>YOGEME Main Tool Bar</center>]]
 +
1. New Mission
 +
 +
2. Open Mission
 +
 +
3. Save Mission
 +
 +
4. Save As Mission
 +
 +
5. New Flight Group
 +
*This places a new FG in the FG list at the bottom. The initial settings of the FG are determined by the choices selected within the Options Menu
 +
6. Delete Flight Group
 +
*This removes all currently selected FGs from the mission file
 +
7. Copy Flight Group
 +
*This copies the currently selected FG so that it may be duplicated
 +
**All properties of the FG are copied including its Arrival Conditions, Waypoints, Orders, Etc
 +
8. Paste Flight Group
 +
*This pastes a new copy of the last previously copied FG
 +
9. Open Map Window
 +
 +
10. Open Briefing Editor
 +
 +
11. Verify Mission
 +
 +
12. Open Options Menu
 +
 +
13. Open LST Editor
 +
 +
14. Open Wave Manager
 +
 +
15. Open Help File

Revision as of 21:25, 19 January 2024

Introduction

This guide’s purpose is to document is one place as many details about the design of a X-Wing Alliance (XWA) as possible. It is not meant to replace the Imperial University courses of Mission Creation and Beta Testing Standards (MCBS) or X-Wing Alliance Mission Design (XAM). This guide will be made to show the functions of YOGEME (Ye Olde Galactic Empire Mission Editor) and guide how utilize its features.

XWA Mission Design Limitations

Of the X-Wing series games, XWA, being the newest, has the least restrictive design limitations, but it still does have limitations. Some of the limits will be repeated in this guide when appropriate but will also be all listed below for a quick, single reference.

  • You are allowed up to 4 regions, connected via hyperspace buoys
  • No branching story options or permadeath options for units
  • Audio files must be less than 22,050 Hz and 16-bit WAV file format
  • Maximum number of craft per region at one time cannot exceed 96 or new ones will not spawn
    • Ejected pilots and escape pods count against this limit and therefore any mission where you may be close to the 96 craft limit should select “No Escape Pods/Ejections” as one of the status options for enemy allied craft
  • Maximum number of Flight Groups per mission file of 192
  • Maximum number of different model files per mission of 22
  • Maximum number of AI fired lasers and warheads in-space at one time of 64
  • Maximum number of explosions at one time of 32
  • Maximum number of “Space Objects” of 128 per region
    • Space Objects are:
      • Asteroids
      • Mines
      • Backdrops
      • Etc.
  • Maximum of 64 radio messages
    • Maximum character limit for each radio message of 68
  • Non-animated briefing character limit of ~4,000
  • Animated Briefing
    • Total event limit of ~1,000
    • Character limit of ~215 per caption text

Getting Started

Download and install, following the installation instructions included with it, YOGEME. If your XWA game directory is installed in the default Programs folder on the C Drive, or still has write protections applied to it from where it was copied, set YOGEME to run in Administrator Mode, otherwise it will not be able to edit mission files. Launch YOGEME and go to Tools -> Options menu.

YOGEME Options Menu
  • Overall Tab
    • You have many different selection boxes to control the behavior of YOGEME
      • For the most part you can leave all the settings at their default values.
YOGEME Options Menu-Overall Tab
  • Map Tab
    • You can customize the behavior of the region map window when you initially launch it
YOGEME Options Menu-Map Tab
  • Wireframe Tab
    • Further works to define the level of detail of the representations of the ship and object models when shown in the region map window
YOGEME Options Menu-Wireframe Tab
  • XWA Tab
    • You will be able to select the file path of the XWA root directory for the copy of XWA that you are doing mission creation for. It is critical that you set this file path correctly as many of the functions of YOGEME depend on reading files from the XWA root directory
      • If you change the file path for the root directory, you will need to close YOGEME and reopen to allow it to properly read the data it needs
    • You can select the default craft type and IFF for all new craft
YOGEME Options Menu-XWA Tab
  • Colors Tab
    • You can customize the appearance of YOGEME in a limited manor
YOGEME Options Menu-Colors Tab

Menus

FILE

The “File” Menu contains what you would expect for a normal Windows Based program

  • New...
    • For creating a new mission file
  • Open
    • For opening existing mission files
  • Open Recent...
      • Will show the last 5 mission files that have been opened by YOGEME to allow for quickly switching between files
  • Save
    • For saving the current mission file using it’s current name and file path
  • Save As...
    • For saving the current mission file, but allows you to change the name or file path or both
YOGEME File Menu

EDIT

The “Edit” Menu contains what you would expect for a normal Windows Based program

  • Undo
    • In theory allows to reverse a change that you have made but rarely works
  • Cut
    • Allows for the cutting of text from the different text fields
  • Copy
    • Allows for the copying of either text from a text field or of a whole Flight Group (FG)
  • Paste
    • Allows for the pasting of either previously cut/copied text or copied FGs
  • Delete
    • Allows for the deleting of selected text or FG
YOGEME Edit Menu

TOOLS

The “Tools” Menu contains many of the functions of YOGEME

YOGEME Tools Menu
  • Verify Mission
    • This runs a basic check of the mission file for common errors. It is not that useful of a check as it has many triggers to cause it to say the files in NOT VALID will the file is perfectly good to be used.
  • Map
    • This opens the Region Map – See Map Section for more details
  • Briefing
    • This opens the editing window for the Animated Briefing – See Animated Briefing Section for more details
  • LST
    • This opens an editing window for the MISSION.LST file – See MISSION.LST Section for more details
  • Options
    • Opens the Options Menu – See Getting Started Section above
  • FG Goal Summary
    • This opens a window where all FG Goals are listed in a single place for a quick reference. See Goals Section for more details
Flight Group Goal Summary
  • FG Library
    • This opens an incredibly useful window where you can save and organize the FGs of your mission into a common library that you will be able to quickly copy into another mission. This is very useful if you have created a particular region that you wish to use again in another mission.
YOGEME FG Library
  • Test
    • This opens a window from which you can quickly launch into XWA and test the mission you are currently making. YOGEME will automatically create a pilot able to fly the mission you are currently editing.
  • Hyperbouy Wizard
    • This opens a window from which you can quickly place Hyper Buoys to link the different regions. You are given the option to place a return pair as well.
      • The buoys are placed at 0,0,0 in each region and don’t have arrival triggers (i.e. are always present)
Hyper Buoy Wizard
  • Apply Super Backdrops
    • This is for X-Wing Alliance Upgrade or TIE Fighter Total Conversion installations and will be covered in a later guide
  • Hook Assignment
    • This is for X-Wing Alliance Upgrade or TIE Fighter Total Conversion installations and will be covered in a later guide
  • Wave Manager
    • This opens the Wave manager – See Wave Manger Section for more details
  • Mission Craft List
    • This opens a window where all craft that will appear as Mission Craft on the Initial Briefing Page are listed
      • For a craft to appear as a Mission Craft it must meet the following criteria
        • Be a craft
        • Be on the same Team as the Player Craft
        • Have the Arrival triggers set to “always (TRUE) (In Mission Craft List)”
Mission Craft List
  • GG and GU Summary
    • Opens a window where all FG are organized and listed under both their assigned Global Groups and Global Units – See Global Groups and Units Section for more details
GG and GU Summary

HELP

The "Help" Menu contains what you would expect for a Windows based program Help tab with a link to the built-in help files

Tool Bar

The Tool Bar at the top of the YOGEME window allows for quick access to many of the function previously mentioned in the Menu Section

YOGEME Main Tool Bar

1. New Mission

2. Open Mission

3. Save Mission

4. Save As Mission

5. New Flight Group

  • This places a new FG in the FG list at the bottom. The initial settings of the FG are determined by the choices selected within the Options Menu

6. Delete Flight Group

  • This removes all currently selected FGs from the mission file

7. Copy Flight Group

  • This copies the currently selected FG so that it may be duplicated
    • All properties of the FG are copied including its Arrival Conditions, Waypoints, Orders, Etc

8. Paste Flight Group

  • This pastes a new copy of the last previously copied FG

9. Open Map Window

10. Open Briefing Editor

11. Verify Mission

12. Open Options Menu

13. Open LST Editor

14. Open Wave Manager

15. Open Help File