Flash to Unity User`s Manual
Contents
1. Boolean value e IsControllerinputEnabled indicates if controller input is enabled this is an optional setting Boolean value Section for the prefabs settings e LoadingTransitionPrefabPath indicates the path of the prefab transition for the loading between scenes String value e SelectionCursorPrefabPath indicates the path of the prefab for the cursor for the UI input controller String value To use this the setting IsControllerInputEnabled must be set to True Section for the Frame rate e TargetFPS optional setting that indicates the FPS to be used by Update method which is used by the Application targetFPS of Unity Integer value e FixedUpdateFPS optional setting that indicates the FPS to be used by the FixedUpdate method Integer value e AnimationFPS indicates the FPS for all the F2U animations Integer value e UpdateAnimationsMethod indicates what Update the F2U animations will use String value Posible values are FixedUpdate and Update And the last section for the Memory FlashtoUnity e TargetTexturesMemory Megabytes Integer value Monday October 7 2013 indicates the target memory for the textures in This build settings file is included into the package and is configured for the application to run at 30 FPS and using the FixedUpdate update method for the animations by default a i i gO J C Program Files 86 TexturePacker bi Organize v a m Include in2. FlashtoUnity Monday October 7 2013 o The animations folder must only contain movie clips that reference either textures in the textures folder other movie clips in the animations folder sound clips on the sounds folder or movie clips in the texts folder o The text folder must only contain movie clips each with exclusively a text component inside o The textures folder must only contain graphics that reference images on the assets folder o The assets folder may contain anything the user would like to inject to the project o The sounds folder must exclusively contain sound clips e No symbol may have a name with spaces e The project must be saved as an XFL file Checking that everything was imported correctly After importing the animations the user should make sure that every animation was exported correctly The user may need to check the Unity console for errors that might have arisen while processing the XFL project Important consideration on importing Adobe Flash projects Flash to Unity s pipeline is merely constructive meaning that it will never attempt to destroy or nullify components Should the user modify their scene in such a way so that a certain component becomes unneeded Flash to Unity will not detect the missing component The user is completely responsible for properly disposing of unneeded components Creating a Flash to Unity Complian
3. and graphic assets and resource management 1 Installation process Make sure all system requirements are met and the required software is installed Import the Flash to Unity package as a custom package to your Unity project In the Unity menu select the Assets gt Import Package gt Custom Package then select the file Flash to Unity package and import it Open up one of the sample scenes under Assets gt Scenes gt F2U and run it to test the package was successfully imported FlashtoUnity Monday October 7 2013 What should be visible After successfully importing Flash to Unity the user should see a new menu option in the Unity menu named F2U Check The Flash to Unity Menu go to Tools F2U Help User Manual 02 Menu Manual for more details Additionally the user should be able to see the imported scripts on the assets folder under the Scripts folder File Edit Assets GameObject Component Terrain FPL amp 0 Build Window Help Base Flash to Unity script and menu locations FlashtoUnity Monday October 7 2013 Setting up Unity to work with Flash to Unity Configuring Unity to work with Flash to Unity is relatively simple as the user may only need to tamper with some easily identifiable values The next list will detail which values to set and where to locate them 1 The project should be set to generate Meta files whenever possible In the edit menu go to the Edit option in the m
4. library Share with Name d plugins 8 HQX dil v HQX lib Icon ico key bin key OLD bin phonon4 dll PVRTexLib dll _ qt conf 2 QtCore4 dill S QtCreatorUtils dll S QtCreatorUtils lib S QtGuid dil S QtNetwork4 dll QtOpenGL4 dil QtScript4 dil S QtWebKit4 dil S QtXmi4 dil TecturePacker exe Texture Packer s default installation paths Importing your Flash Project Once a Flash project that complies with the proposed standard is created the user FAVORITES g Macintosh HD Dropbox E All My Files PAN Applications E Desktop m Documents O Downloads E Movies JJ Music Pictures Ai administrator build dir 9 Shared SHARED 02816b ezuniga admin pc E art 10 pc art 13 sa im Sev Ss DVD Player 4 F2U 0 FaceTime Font Book 3 GlyphDesigner Google Chrome amp ical iChat fa Image Capture a iTunes Launchpad Mail E Mission Control W Photo Booth amp Preview QuickTime Player Safari Screenium Server r Server SourceTree Stickies E System Preferences 7 TextEdit TexturePacker may proceed to begin the importing process In order to import Flash project into Unity the user may need to follow the steps detailed in short Please do note that if the user FlashtoUnity Monday October 7 2013 hadn t set the paths to their tools then a file browser wi
5. FlashtoUnity Monday October 7 2013 FairPlay kabs Flash to Unity User s Manual Wednesday August 28 2013 FlashtoUnity Monday October 7 2013 Abstract The following document is a user s manual for Flash to Unity which is a tool that allows transforming flash animations Flash animations into fully working Unity objects that can be used to implement either 2D games or 2D user interfaces The general objective is to present a clear simple and elegant user manual can refer to in order to learn about the tool This manual may also be used as a reference FlashtoUnity Monday October 7 2013 Table of Contents PMR UN sata tases e besa seet E A E pa cenraad genes bacaten alta A e E ante 4 Installation and First UWS sais sssnsacdsasiceacesteadadsaaneten irre aR E adeaddesasuaded vasheoacausaneadeaaneedabens 4 System GU IPS HITS sessen esaa r EE SE EEE en EEEE E SEOS ESEESE TEESE 4 Required SoftWare serisine snaa a EA A E EE a a EE AE EEEE TE 5 ScD ean e a ign psy emacs cg asa see nee ee 5 What you should already Kiwi cecascorascnriewcrastcigancsoiaaacnndoweemanar asians 5 Installati n PTO CESS sienio eose iE AEE E EE E E EE 5 What should be Visible iis cccssscsscctsasneseesancepesaavnencsacssvansestosastaasavesadeavansasbtoatsaadecsasasheseusasnsseaniss 6 Setting up Unity to work with Flash to Unity ssssesesssesessesessseesseesseesseesseeesseerssressersseeesees 7 Setting up the Flash to Unity build se
6. Unity Monday October 7 2013 2 Rename the f2u_template_screen_texture texture symbol with a proper name 3 Rename the f2u_template_screen_texts texts movie clip with a proper name 4 Rename the f2u_template_screen_animations animations folder with a proper name 5 Save the XFL document with a proper name From this point the XFL template has been changed to a custom XFL with the correct folder structure so the user can create its animations with the standard and adequate structure Usage Restrictions In order to ensure the project works correctly these simple rules must be followed e The project should run at 30 FPS e The project must be saved as a single XFL file Flash to Unity needs the metadata generated by this format in order to function correctly e There must not be loose symbols on the project s root Every symbol must belong to a folder e Assets must be organized as per the standard detailed later on this section Flash to unity parses each project in a per folder basis so misplaced symbols may not be imported correctly e The user must never tamper with the generated XML files outside the Flash editor unless they know exactly what to do For movie clips to be properly imported into Unity they must abide by the following rules e lf the movie clip is located at z the animations folder then it should comply with the Ties FlashtoUnity Monday October 7 2013 n
7. ain menu and selected the Project Settings and then the Editor option Then set the mode of the Version Control to Meta Files This will allow the creation of META meta files for each file and folder in the project This is useful when the project is under a version control system like Git or SVN If a control version system such as SVN or Git is used then the follow this guide http docs unity3d com Documentation Manual ExternalVersionControlSystemSu pport html 2 The user must set the following paths a The path to the Texture Packer installation command line prompt b The path to their Flash installation The base installation directories are detailed as follows e TexturePacker o Win C Program Files x86 TexturePacker bin T exturePacker exe o Mac Applications T exturepacker app e Flash FlashtoUnity Monday October 7 2013 o Win C Program Files x86 Adobe Adobe Flash CSX Flash exe o Mac Applications Adobe Adobe Flash CS Version app Setting up the Flash to Unity build settings Flash to Unity use a file called build_settings which is under the xmls folder in the Unity project resources This file contains a section for the general settings e Version the version of the app String value e g 7 0 2 e DefaultLanguage the default language String value e g english e IsConsoleReportingEnabled indicates if the application should log in the Unity developer console
8. ame standard for movie clips e No movie clip should have two layers with the same name Additionally empty layers must not exist e The registration point for every animation must be set Correct object centering at point 0 0 of the scene e There must be exactly one object per layer and key frame You may use the Distribute to Layers option in order to separate objects e A layer must not change the symbol it contains e f the movie clip were to have labels then a layer named labels must be created This layer will hold every label of the scene and any label not on this layer will be ignored by Flash to Unity e If the movie clip were to have actions then a layer named actions must be created This layer will hold every action to be executed and any action not on this layer will be ignored by Flash to Unity e Only three types of actions are supported by Flash to Unity Stop GotoAndPlay and GotoAndStop Usage of any other action will result in undefined behavior Only one action may be executed at any frame e f sounds were to be included in the movie clip then a layer named sounds must be created This layer will hold every sound to be played Flash to Unity does not support streaming e The type of the movie clip must be Movie Clip That is one can t use a movie clip as if it were a texture or a texture as if it were a movie clip e When the user wants to hide something in a la
9. e on its name For example the texture for a chessboard may be named chessboard_texture FlashtoUnity Monday October 7 2013 Using the f2u_template_scene XFL template Flash to Unity includes a template scene f2u_template_scene xfl which the user may use as a base for creating scenes on Flash The structure of this template mirrors the required and suggested standards of a Flash to Unity XFL project so it s safe to assume the XFL project is initially importable into Unity Example of a usual Flash to Unity structure compliant project Name AS Linkage v Ly animations y ty f2u_template_screen_animations screen_animation t4 assets GraySquare png 24 sounds p sfx P vo v Ly texts cy f2u_template_screen_texts text v 24 textures EA f2u_template_screen_texture lt Figure 1 A common Flash to Unity compliant project Note that it s recommended to separate the animations on folder each folder representing a scene in your XFL project This allows for a better separation of animations when importing the XFL into Unity Additionally textures should have the name of their respective scene as a prefix on their own name Both practices permit Flash to Unity to better organize the generated assets when importing the XFL projects into Unity To use this template as a base XFL the user should follow the next steps 1 Open the f2u_template_screen xfl XFL with Flash Flashto
10. e texts Texts may be assigned to the animations at the animations directory in order to be actually drawable They can be assigned freely as if they were normal animations It s important to note that the instance of the text in the animation can be transformed as if it was any other transformation 12 items Name v LY textures sa test_text_screen_texture v F texts TIMELINE 2 a E E ES button_text x labels gt sounds actions gt f assets sounds v 24 animations text sprite hit_area v By test text_screen animated_button_animation o Ef s o D E CEDE x A Basic animation with a text object on it Note the text layer FlashtoUnity Monday October 7 2013 Restrictions on Flash projects You can check the Flash to Unity XFL Structure go to F2U Help User Manual 04 XFL structure Manual document in order to learn more about what should and should not be done when creating Flash to Unity compliant projects Flash Project Examples In order to show some sample projects the Flash to Unity package include some Flash projects that were used to create the included demo scenes To see and test importing or modifying these example projects the user should go to the F2U folder of the Editor folder in Unity and find a zip file named ExampleSourceAssets and then decompress it out of the Unity project It also contains the font file source
11. goodies that may ease work such as simplified XML I O management finite state machines logs 2D sound management and localization management Installation and First Use System Requirements e Windows 7 or Mac OSX 10 5 or later e Atleast 2GB of RAM e Any requirements Unity may need http unity3d com unity system requirements e Any requirements Texture Packer may need http www codeandweb com texturepacker documentation e Any requirements Adobe Flash may need http www adobe com products flash tech specs html FlashtoUnity Monday October 7 2013 Required software Adobe Flash CS5 or later Texture Packer 2 4 2 or later paid license support for free licenses via TPS parsing Unity 4 or later No Pro version required A program suitable for FNT style font creation and manipulation optional for text handling o Windows users may use BMFonrt http www angelcode com products bmfont o Mac users may use Glyph Designer 1 7 or later http www 71squared com en glyphdesigner o Alternatively you may use Font Packer to do the job https github com mattdesl gdx fontpack Setup What you should already know This manual assumes the user has basic Flash and Unity 3D knowledge The user is assumed to know about basic scene creation on both software as well as transforming various effects into key frames The user must also be familiarized with Unity s API especially around the usage of audio
12. into key frames if able The most common functionality that can be added by converting it to key frames is enumerated as follows e Any non classic tween that uses non standard easing e Pivots On the other hand the most common functionality that cannot be added at all via Flash to Unity is as follows e Any brightness or tint transformation Advanced transformations are partially supported Flash to Unity cannot translate color offsets correctly 6 e Any action different from Stop GotoAndPlay or GotoAndStop When importing animations Flash to Unity ignores any frame marked as a guide In order to mark a layer as a guide the user must right click on a layer and check the Guide property on the Flash editor Creating texts Texts are important resource that allows the developers to present instructions commands suggestions options names or descriptions among many other things to the player They are essential assets any game nowadays counts with and they have evolved to become not only useful but also aesthetically pleasing Flash to Unity allows for the insertion of text written in Flash into any scene that requires it Text may only be declared on the XFL project for it to become available though if the user wants to give it any use they must assign it on Flash one of the FlashtoUnity Monday October 7 2013 available pairs of font type and size the user has already converted int
13. ll open for them to set the path to the missing tools 1 Export the bitmaps for your XFL file a On Unity select the Tools menu on the menu bar and then select the Flash submenu under F2U b Select the Export XFL Bitmaps option and select the XFL file you would like to process c If you hadn t already had your XFL file open the script will open it for you It will then parse your project and transform every texture you had defined and transform it into a numbered bitmap d Alternatively to c the user may choose to open their scene directly and run export_bitmaps jsfl directly onto their XFL project 2 Import your XFL a Select the Import XFL option this will open a prompt where you are to select the XFL you want to import to Flash to Unity If you haven t set Texture Packer s path then a prompt will ask you to do so b Navigate through your directory structure to the location where your XFL file is stored Once done confirm your selection The user might need to wait several minutes depending on the size of their project and the performance of their machine in order to the operation to finish importing the files The proposed standard for XFL projects is summarized as follows e Projects must have exactly 5 folders where the entirety of the project will be 0 66 0 66 0 66 located The folders must be named animations assets sounds texts and textures
14. o FNT files and or exported into Flash to Unity A texts folder can be created on the XFL project s root It may contain movie clips whose sole related object is a text centered to the scene This folder works as an extension of the animations folder so referencing movie clips from this location is permitted Q 2 Scene 1 E button_text TIMELINE a oW 5 10 TERA text se TT ay ay A common text object in its containing scene v I texts v E f2u_ui_components_texts fk hyperlink_button_text fk buttons_text The texts folder FlashtoUnity Monday October 7 2013 dnstance Name T Classic Text lv Dynamic Text v v POSITION AND SIZE X 125 45 Y 18 75 Color ___ E Auto kern Anti alias Use device fonts v ag gt alin PARAGRAPH Common way to set the font on Flash ArialMT xs ArialMT ArialMT_30 uruntrait The same font as in the previous picture this time on Unity FlashtoUnity Monday October 7 2013 The properties the user can set edit on the text are the following e Text type Static text Dynamic Text or Input Text e Font family font style and font size e Letter spacing and line spacing e Behavior Single line multiline or multiple no wrap Please do note that the only property that must be set as part of the standard is the Text Engine It must be set to classic text Using th
15. ocalized versions of the same project e Standards and Good Practices go to Tools F2U Help User Manual 07 F2U Standards Manual in order to learn more about the basic standards and good practices Flash to Unity developers should follow e Other useful Flash to Unity Functionality go to Tools F2U Help User Manual 10 Useful Functionality Manual in order to learn about various methods and utilities Flash to Unity offers to developers e Flash to Unity s Style Sheets go to Tools F2U Help User Manual 08 Style Sheets Manual in order to learn more about how to customize large number of components with a style sheet e Flash to Unity s Wish List go to Tools F2U Help User Manual 11 F2U Wish List in order to learn more about planned functionality to be added into the project in a further release e Flash to Unity s required XFL structure go to Tools F2U Help User Manual 04 XFL structure Manual in order to learn more about the required elements and configurations Flash developers have to adopt while using Flash to Unity e Flash to Unity s Sprite Batching Tutorial go to Tools F2U Help User Manual 06 Sprite Batching Manual in order to learn more about sprite batching You can see these documents in the F2U menu bar option in Unity and if you click an option the selected document will be opened in the web browser
16. ough so this hierarchy was implemented for order purposes o The vo folder may exclusively contain long audio clips to be used as voiceover audio Again Flash to Unity will not force the user to comply with these criteria e The assets folder is a dummy folder where the user may place any symbol image or source they please Any kind of symbol may populate the assets folder FlashtoUnity Monday October 7 2013 e With the exception of the textures folder every folder may have subfolders Additionally due to Unity s nature only audio in the following formats will be imported into your Unity project o WAV Recommended for most projects o AIFF o MP3 o OGG Naming conventions for Flash to Unity Required naming standards e There must be no spaces on any item name If using spaces became an absolute necessity then one may use underscores _ in order to simulate them Suggested naming conventions e Every symbol should have a unique identifier No two symbols may have the same name even if they are on different folders Similar names are discouraged but are a valid workaround e Every single item name be it folder or symbol should be written in all lowercase letters e All movie clips to be imported into Unity should have the suffix _animation on its name For example a walking animation may be named walking_animation e Every graphic to be imported into Unity should have the suffix textur
17. s that were used in the F2U demo scenes Remember that the animations textures prefabs texts atlas fonts that the F2U package includes can be removed from the project to reduce the application size So the game will contain only the assets it really uses Updating to a new version The user must delete all Flash to Unity related files from their project if they would like to either update or downgrade their version Additionally the user must re generate every single asset on their project in order for them to work with their version of Flash to Unity Note that downgrading is not recommended because several features could go missing and your Flash project could no longer be compatible Every version will include a breaking changes list which will define each change that may generate incompatibilities with older versions and will detail on how to modify the project in order to make it comply with the aforementioned changes It s important to back up the XML files such as f2u_build_settings xml style_sheet xml and the localization XML because FlashtoUnity Monday October 7 2013 upgrading the version may overwrite them After the plug in has been updated you may check for any changes made to those XML files and merge them as necessary Uninstalling In order to uninstall Flash to Unity remove every file related to Flash to Unity from your project If you wish so you may also uninstall the complementary software from
18. share textures between XFLs create a new symbol and name it like the symbol you want it to obtain from another project Next select the symbol and go to its properties there click on the Source File button located in the advanced tab Open the project that contains the symbol to be shared and select the desired symbol from the list Finally check the Update Automatically box and confirm your selection Both projects now share the selected symbol and they may be used freely without needing redundant textures Even though this can be performed on movie clips and the like it is not advisable to do so as this functionality is not fully supported by Flash to Unity for symbols not destined to become textures Flash will break the link and duplicate the symbol if you edit it outside its parent project so it is advisable to only share textures that don t need to be modified Creating an animation movie clip easy one may only need to s7 COLOR EFFECT create a movie clip on the Style Advanced ly animations directory It s to be Alpha 100 xA noted though that some of Partially oa ae RS Supported Green 100 xG ee Blue 100 xB Advanced color transformations Values highlighted in yellow are partially supported FlashtoUnity Monday October 7 2013 Flash s functionality was not implemented into Flash to Unity so it would be better if any transformation or effect would be transformed
19. t XFL Project Formatting an XFL Flash project for use in Flash to Unity is a task that must be done to make the software work as expected The next sections will briefly explain how to format one s Flash project as to comply with the format expected by Flash to Unity FlashtoUnity Monday October 7 2013 Naming conventions You can check the Flash to Unity XFL Structure go to Tools F2U Help User Manual 04 XFL structure Manual document in order to learn more about how Flash projects and symbols should be formatted Folder structure The project s folder structure is of importance when using Flash to Unity so one should make sure to create the basic structure from the beginning to avoid future complications Four base folders should be created in particular e The animations folder will hold every single animation to be imported into Unity No symbols may be on this folder save for Movie Clip symbols e The textures folder will hold every single texture to be imported into Unity No symbols may be on this folder save for Graphic symbols e The sounds folder will hold every single audio clip to be imported into Unity No symbols may be on this folder This folder must contain exactly two subfolders aptly named sfx and vo o The sfx folder may exclusively contain short audio clips to be used as sound effects Flash to Unity doesn t restrict which audio clips one places on this folder th
20. ted as graphic symbols on Flash Each texture is composed of one or several key frames with the only restriction being that every frame of a texture must be a key frame The texture doesn t need to describe a whole frame by frame animation of some kind Advanced Cancel Name Reference Type Graphic v Edit ActionScript Linkage Runtime Shared Library Authortime Sharing Source File File C fpl_generic_backend_screen xfl symbol name Sharing textures dialogue FlashtoUnity Monday October 7 2013 totally unrelated images may be strung together in a single texture When importing a texture every image present on each texture will be merged together into a single texture atlas where they can be referenced by methods described later on this manual It s enough to just create a graphic symbol on the textures folder in order to create a texture Please do take into consideration though that textures may only contain references to symbols present in the assets folder Textures must only have a single layer and its actual name is irrelevant as far as Flash to Unity concerns Sharing textures between files Once in a while several XFL projects may use very similar or identical textures for some of their objects Given that textures are normally heavy files it would be convenient to share texture symbols between XFLs as to avoid repetitions and the like In order to
21. ttings castes cecsosinessndenenesnaseeadosextsevianceseoeeeevoneeesnaeees 8 Importing your Flash Project meterne aiai a aE AE ERE A E 9 Creating a Flash to Unity Compliant XFL Project ssssseeesenssenesessseeessseessesseesseeesseeessees 11 Updating toa TV UN sce ec cpaa te ccaecaicn exe cesta acess aes ae es dee eee eee 23 Wat bats 10Gb oo eee ser ater Ee nt er tps sete ten pCa E tere nono yan trey n Scn nr mUr Ste tery many mnmerrer et tere 24 Tips esheets dese Soe aes oa sence naa a dada aE AE NEA E Aa R EE E aE EEE Enn AE ESTE aa iE 24 FlashtoUnity Monday October 7 2013 Introduction Flash to Unity is a tool that allows game developers to import animations made in Flash to the Unity 3D Game Engine The animations imported to Unity can be 2D animations for using them as UI components or animations in 2D Flash to Unity is thought to be a simple API that can be used to import sprites animations sound effects and scenes as well as manipulating them allowing for a complete tool that is able to create and manage every aspect of the game that s being created So far Flash to Unity is able to manipulate sprites animated sprites and audio effects as well as giving several options to create interactive customizable Ul components such as buttons animated buttons sliders checkboxes radio buttons tabbed navigation and scrollable panels all of them capable of adjusting of a plethora of resolutions The software also includes several
22. yer he or she must leave blank frames e Movie clips on the animations folder may only reference other movie clips on their same folder or graphics on the textures folder e Pivots may be used to animate but they must be converted to key frames afterwards This same procedure must be done if using custom easing FlashtoUnity Monday October 7 2013 Similar to movie clips above textures must also abide by a certain number of rules detailed as follows e Every single frame of every single texture must be a key frame e No texture may reference elements that are not located at the assets folder e Every texture must reside directly on the textures folder That is the textures folder may not have any subfolders erary PROPERTIES ALIGN Align a Tbh Distribute a bb My Match size Space m a o i 1 gs oo M Align to stage Alignment menu Appropriate options highlighted in green e Every single key frame of every single texture must contain a PNG image e All textures must be aligned to the center of the stage in both their X and Y axes The user may manually align their components to the center of the stage For this to happen the user must go to the Align menu on Flash and click on the Align to vertical center and Align to horizontal center options making sure the Align to stage option is checked Creating a texture graphic Textures can be represen
23. your machine Tips e Because of how Flash to Unity works the usage of 3D cameras to in order to display 2D components is heavily discouraged Further help This manual was thought to introduce the user to Flash to Unity in a user friendly way and explain the concepts behind the workings of such software If you would like to delve into a detailed rundown of all the classes and method Flash to Unity offers you may want to check the API Reference manual which can be accessed from the F2U menu at the Help submenu API Reference option Additionally you may want to read the following documents in order to learn more about the several utilities Flash to Unity offers e The Flash to Unity Menu go to Tools F2U Help User Manual 02 Menu Manual in order to learn more about the menu this application creates on the Unity editor e Flash to Unity Ul Components go to Tools F2U Help User Manual 03 Ul Components Manual in order to learn more about the user interface functionality Flash to Unity offers e Flash to Unity s Sprite Batching go to Tools F2U Help User Manual 06 Flash to Unity s Sprite Batching Guide in order to learn more about how and when to use sprite batching FlashtoUnity Monday October 7 2013 e Flash to Unity Localization Manager go to Tools F2U Help User Manual 05 Localization Manual in order to learn more about the localization manager a Flash to Unity utility that allows the user to easily switch between l
Download Pdf Manuals
Related Search