the user manual as pdf - Pixels-Hub
Contents
1. CONFIG UL USER MANUAL CONTENTS A O A a 2 AIN o O 2 o cc gsee ie cgetecs se setetne eane es uence seeepcaae ete tenee a nees 3 Sao PA o a o o o 3 Adding and deleting scenes from the configuratiON occcccoocncncnnncnnnonaconnnnnacnnonnncnnnonaronnnnanonos 4 A Teee ae SC to Ce eee Bere 4 DRA Po E E E 4 Disabine a Cehe a a a ene EP ee ee ere ne 4 Sve I ONE ess 010 eee ne ne ere Re ern eee ee ee ee eer 4 AGU ale Mola AU Ez tdo q ys CO O En een ura eae cee oe eels rea ae Seed nan reel Seete eu ena ee 5 A Ulery 0 nn ree nar ee ane tee rer oe aps ern oe Se a eer ee ee 5 Delete ar Ol CU Fall O ame ae eae Sone ee ee ae 5 Configure GameObjects depending on the configuration ooccccnncccnnncnnnnaninonacinonacinonicnnnarononaso 6 ON SON a res weer ere a nee a Sea caret seater eke E pene ete ete nee eae E E atte nose 6 Setting up the layout The FastConfig WINGOW ccccsssccccesseccecenseccceesececeeeceeseeeceesaeecessunesss 6 Example of general use Configure Local Position occccoocccncnnocnnnonacnnnonaronnnnnncnnnnnaronnonanonnos 7 SPECIE CONMSUFALION le oa encia 8 A A 8 A yaesen cerca terne tates eaters Serene eee eee teres ees areca ce 9 A asses are eace eaaee ees ea austen ee eenaseeiea sauna cases ca aen masenens 9 A 0 Ec 4 cere ree rn re err ren en re ear ere te eee ee 10 Ele prides roe Sy WHA Re ae 1g cee soe ere ee te Une ON 10 O US Materiali e cee a a vaste eee Sass esteem ee sr ce ae nares c2. NewO App Name ConfigToolkit Platform Standalone Icon 1024x1024 Scenes Compiler Definitions Image 3 Edit configuration window By default the icons when you create a new configuration are the icons defined in the Build Settings EDITING A CONFIGURATION To edit a configuration select its name in the top bar of the Configuration window ConfigurationW Configurations When you select a configuration the configuration window will show up as seen in Image 3 Edit configuration window and the configuration name will change its color to yellow CONFIGURATION PROPERTIES The fields in the Edit Configuration window are described below Config name The name of the configuration used to identify your configurations on ConfigurationToolkit This name is used only by the ConfigurationToolkit and to identify the configuration when building from command line App Name This sets the field Product Name in PlayerSettings Plattform The target platform to build to When the platform can have different targets a second drop down list will show next to this to select the specific build target Icon The icons to use with this configuration By default the icons defined in PlayerSettings are put here Scenes The list of scenes on this configuration For adding removing scenes see Adding and deleting scenes to the configuration Add Scene Field to add a new scene to the configuration Compil
3. a path etc quit Tells Unity to close after build If you remove this parameter it will remain opened after the build batchmode Tells Unity to run in batchmode no popups or dialogs logfile win2log txt Saves a build log to the specified file Useful to locate build errors
4. ation it must be selected by pressing the configuration name on top of the configurations window Once the configuration name is highlighted in yellow you can delete it by pressing the Delete button If you are using a Configure XXX script with the configuration you ve deleted the setting for that configuration will be removed only on the active scene In other scenes it will take the next configuration on the list You ll have to manually remove the settings for the deleted configuration from your Configure scripts that use this configuration in other scenes CONFIGURE GAMEOBJECTS DEPENDING ON THE CONFIGURATION With ConfigurationToolkit comes a sample scene called ConfigurationToolkitSample This scene contains examples about different tools to configure GameObjects OVERVIEW The Configure GameObject tools allows you to set specific values for each configuration to a GameObject With one of these scripts attached you have to set values for each configuration you need If no values are set for a specific configuration the default config in the GameObject will be taken SETTING UP THE LAYOUT THE FASTCONFIG WINDOW To quickly switch between active configurations without opening the Configuration Window you can use the FastConfig window The window is located on Edit ConfigurationToolkit Fast Config This opens a small window with a drop down list of the defined configs Image 9 The Fast C
5. e contig 1 Texture contig2 Texture Image 18 Configure GUlTexture script CONFIGURE MATERIAL This allows you to define a Mesh Renderer s material for each configuration Multiple materials are allowed Configure Material Script Script ConfigureMaterial Materials contig 1 Elernents 2 Materiald Mati Material Default Particle contfig2 Elements Materiald Materiall Default Particle Image 19 Configure Material script CONFIGURE MESHFILTER This script allows you to define a mesh from a MeshFilter component for each configuration Combined with it s a simple way of having different meshes for each platform IE low poly for mobile plattforms and hi poly for PC Gs Configure Mesh Filter Script Script A ConfigureMeshFilter Mesh contigl Mesh M cabeza config 2 Mesh A ojo dch Image 20 Configure MeshFilter script CONFIGURE TEXT MESH Similar to Configure GUI Text this script allows you to define the Text value of a TextMesh for each configuration defined Configure Text Mesh Script Script A ConfigureTextMesh contigl Text Visionary contig2 Text Visionary Clinic contig Text Text Image 21 Configure TextMesh script BUILDING CONFIGURATIONS FROM COMMAND LINE To use this feature you need to have Unity Pro for the target platform you want to build to You can build a configuration you ve defined with Configuration Toolkit from command line This come
6. er List of definitions so you can make configuration dependent code with if definitions elif and Helse ADDING AND DELETING SCENES FROM THE CONFIGURATION ADDING A SCENE To add a scene to the configuration select it from the Add Scene field of the configuration window Image 4 Add scene field without scene selected Once selected a new button will appear below the Add scene field Press it to add the selected scene to the current config amp ConfigDependentTest Image 5 Add scene field with a scene selected Warning If you don t press the button the scene will not be added to the configuration Once you have added the scene it will appear in the scenes list as shown below Scenes Y Assets Scenes ConfigDependentTest unity Add Scene None Object Image 6 Scenes list with a scene added DELETING A SCENE To delete a scene from the configuration press the name in the Scenes list DISABLING A SCENE From the config manager you can disable a scene without removing it from the list Simply click the checkbox at the left of the scene name to disable it The scene will not be added to the build SAVE A CONFIGURATION Once you have defined a configuration you must save it When you create or edit a configuration a message will be shown at the bottom left corner of the configuration window warning you that the configuration is not saved elt button located at t
7. ers oeer aaa Gna een 11 Conneune MeshFiter a aa ses ce coerce enero eee ete ce seaman ca test areas on crease uarge ee 11 Conneure Text Ios ccre accion eect eee aces ae an tice ane ct ee tea sees ana ata wate ea etna e Seven nan arta 12 BUIIGINS conil tom command iNe soree eee e a esse 13 Howto DUO A INe oea A eco 13 MANAGING CONFIGURATIONS To start defining and managing configurations you must open the configuration window on Edit ConfigurationToolkit Settings and the configuration window will appear EF a 7 Peas o a Edit Assets GameObject Undo Selection Change Ctrl Z Redo Ctrl Y Cut Ctrl X Copy Ctrl C Paste Ctrl V Duplicate Ctrl D Delete Shift Del Frame Selected F Lock View to Selected Shift F Find Ctrl F Select All Ctri A Preferences Play Ctrl P Pause Ctrl Shift P Step Ctrl Alt P Selection b Project Settings Render Settings Network Emulation g Graphics Emulation Snap Settings ConfigurationToolkit Settings Fast config Image 1 Opening the configurations window The configuration window is where you will manage all the configurations of your project ADDING A NEW CONFIGURATION To add a new configuration press the button in the configuration window The edit configuration window will show Confi guration wW Configurations Image 2 Configuration window Configuration W Configurations NewO Config Name
8. he right of the scene Compiler Definitions Build Image 7 Config not saved message To save the configuration simply press the Save button The Config not saved message will disappear The first time you use the toolkit a new file called config txt will be created on Assets Resources This is where we ll save all your configurations ACTIVATE A CONFIGURATION To apply all your configuration settings to the project you must activate a configuration To activate a configuration it must be selected by pressing the configuration name on top of the configurations window Once the configuration name is highlighted in yellow you can activate it by pressing the Activate button When you activate a configuration the target platform for Unity build is also changed ConfigurationW Configurations config1 Config Name config2 App Name ConfigToolkit Platform Standalone Icon 1024x1024 Scenes Add Scene None Object Compiler Definitions Activate Image 8 The configuration name will turn yellow when it s selected A faster mode of activating a configuration is by using the FastConfig window BUILD A CONFIGURATION To build a configuration it must be selected by pressing the configuration name on top of the configurations window Once the configuration name is highlighted in yellow you can build it by pressing the Build button DELETE A CONFIGURATION To delete a configur
9. ition only changes when pressing play not when switching the active config In the Editor the position of the object will be defined by its Transform ConfigToolkit tools only affect the GameObject s properties on Run time SPECIFIC CONFIGURATION TOOLS The ConfigurationToolkitSample scene contains an empty GameObject named ExampleGameObject with one child for each Specific Configuration tool that ConfigToolkit has showing the use them Below is a description of how each script works To see a guide step by step on how to use this scripts go to Example of general use Configure Local Position CONFIGURE ACTIVATION This script is used to enable disable a GameObject depending on the selected configuration The value for each configuration is set with the checkbox labelled Active f Configure Activation Script Script A ConfigureActivation Default Activation wh Y Active state config config l Active config2 Active contigs A cti W Image 14 Configure Activation script This script has a default value Default State that will be applied if a configuration is not set in the script In the above example for config1 the GameObject will be enabled disabled for config2 and enabled for config3 CONFIGURE POSITION This script allows you to set a position for a specific configuration If no position is set the GameObject will take the values set on the Transform component Configure Local Po
10. ject will take the values set in the Transform component of the Inspector To set a specific value for a configuration we ll press the button and the ConfigureLocalPosition fields will change into this Configure Local Position Script Script MA ConfigurelocalPosition contigl Pos Image 12 Adding a specific value for a config in ConfigureLocalPosition Here we can define the position for one of the configurations we have defined l Il configure a position for config2 configuration selecting it from the drop down list and lIl add a new specific position for config3 by pressing the button and selecing it from the list To remove a configuration you have to press the button at the right of the configuration name The Script values should be like this Configure Local Position Script Script MA ConfigureLocalPosition Local position config config2 Pos contigs Pos Image 13 Configure Local Position script for two configurations Now if set the config2 configuration as active either using the FastConfig window or the Activate button and press Play my GameObject will have a position of 0 5 O If set the config3 as active and press Play my GameObject will have a position of 0 0 5 0 and if set any other config as active and press Play the GameObject will have the position defined in the Transform component of the GameObject Note that the pos
11. onfig window highlighted in red We usually dock this small window on the bottom right corner of the unity editor to have a quick access to the tool Using this window doesn t perform the Switch Platform action because of the time it can consume It changes the icons for the configuration platform the scripting symbols for all the platforms so dependent compilation could be done and the product name Image 10 Fast Config window docked To quickly switch between configurations simply select it from the drop down list of the FastConfig window EXAMPLE OF GENERAL USE CONFIGURE LOCAL POSITION The basic principles of setting up values for different configuration applies to all the scripts To show how we can add specific values for a configuration we ll take for example the ConfigureLocalPosition script First we ll define three configurations called config1 config2 and config3 as described in Adding a new configuration Then we ll add a GameObject cylinder in this example to the scene and attach out ConfigureLocalPosition script When attached the values in the inspector will look like this Configure Local Position Script Script MB ConfigureLocalPosition Image 11 Configure Local Position script after attachment to GameObject If we press play the cylinder will be placed in the same position we have defined in the Transform field of the Inspector If the active config is not set in the script the GameOb
12. s handy when building a Continuous Integration Server To build from command line you have to user the CommandLineBuild class You have an overview of calling scripts from command line here HOW TO BUILD FROM COMMAND LINE First you have to have at least a configuration defined as seen in Adding a new configuration Then you can close Unity and launch a build from command line To do so you ll have to write a command like the following works on DOS window and bat file D Unity43 Editor Unity exe projectPath D ConfigToolkitTest executeMethod CommandLineBuild Build config Win2 buildPath D ConfigToolkitTest Binary Win2 TestWin2 exe quit batchmode logfile win2log txt Let s break down the previous line and explain the arguments D Unity43 Editor Unity exe is the path to my Unity executable file It s usually located on the Program Files folder projectPath D ConfigToolkitTest sets the path to the root my project You have to put the path to your project executeMethod CommandLineBuild Build Calls the Build method of the CommandLineBuild class The following two arguments must be right next to executeMethod config Win2 This is the name of your config as defined on Config Toolkit buildPath D ConfigToolkitTest Binary Win2 TestWin2 exe This sets the output file path for the build If you were developing for Android you should put a path to an APK for example for iOS it sould be
13. sition Script Script ConfigurelocalPosition Y Local position config config 1 Pos config2 efault Difiuse Image 15 Configure Local Position script In the above example the GameObject will have a position of 0 2 0 for config1 0 4 0 for config2 and will not change its position for config3 CONFIGURE LOCAL SCALE This script allows you to configure the local scale of a GameObject Configure Local Scale Script A ConfigureLocalScale scale config Image 16 Configure Local Scale script CONFIGURE GUI TEXT This script changes the Text value of a GUIText for each configuration defined If a configuration is not set in the script the value will be the same as in the GUIText component E Y GUIText Other configs Anchor upper left Alignment left Pixel Offset A O Line Spacing 1 Tab Size 4 Font Arial Material None Material Font Size 0 Font Style Normal Pixel Correct e Rich Text el Configure GUIText Script Script A ConfigureGUIText GUI Text config 1 Text Config 1 config2 Text Contig 2 Image 17 Configure GUIText script In the example above the text for config1 will be Config 1 for config2 will be Config 2 and for config3 and any other config will be Other configs CONFIGURE GUITEXTURE This allows you to change the texture image from a GUlTexture component for each configuration G Configure GUITexture Script Script A ConfigureGUlTexture Y GUI Textur
Download Pdf Manuals
Related Search