Makinom 2 https://makinom.com ------------------------------------------------------------------------------------------------------------------------------------------------------- Content ------------------------------------------------------------------------------------------------------------------------------------------------------- - Licence and Version Information - General Information - Dependencies - Documentation and Tutorials - Scripting and Extensions - Support - Folder Description - iOS Hints ------------------------------------------------------------------------------------------------------------------------------------------------------- Licence and Version Information ------------------------------------------------------------------------------------------------------------------------------------------------------- There are 2 versions of Makinom available - the 'Free' and 'Pro' version. Both offer the same, unlimited access to Makinom's features, but only the 'Pro' version contains the full C# source code. Please see the details in the version comparison found here: https://makinom.com/download/ ------------------------------------------------------------------------------------------------------------------------------------------------------- General Information ------------------------------------------------------------------------------------------------------------------------------------------------------- - Opening Makinom editor. You can open the Makinom editor to view or change settings and create/edit schematics using the Unity menu: 'Window > Gaming Is Love > Makinom' - Makinom Project asset When you first open the Makinom editor, a new Makinom Project asset will be created. This asset will contain all general Makinom settings made in the editor. It's located in: 'Assets/Gaming Is Love/_Data/' This folder will also contain additional sub-folders with individual data assets when saving the project. It's recommended to leave the project/data assets at this location to make use of Makinom's backup functionality. - Schematic assets When you create schematics, each schematic is stored in a separate asset file. You can save the schematic assets anywhere in your Unity project. To keep things organized, it's recommended to create a folder structure mirroring the purpose of the schematics or scenes they're used in. - DLL information Makinom is included in your Unity project using DLLs. This will decrease your project's compile time if you change any of your own scripts. The full C# source code is only included in the 'Pro' version. ------------------------------------------------------------------------------------------------------------------------------------------------------- Dependencies ------------------------------------------------------------------------------------------------------------------------------------------------------- The optional 'Unity UI' UI module requires using the following packages: - Unity UI - TextMesh Pro ------------------------------------------------------------------------------------------------------------------------------------------------------- Documentation and Tutorials ------------------------------------------------------------------------------------------------------------------------------------------------------- You can find the documentation and different types of tutorials here: https://makinom.com/guide/ As a first read, I'd recommend to check out the introduction and documentations on schematics and machines: https://makinom.com/guide/documentation/getting-started/introduction/ https://makinom.com/guide/documentation/getting-started/schematics/ https://makinom.com/guide/documentation/machines/machine-components-overview/ It's recommended to start with one of the game tutorial series, e.g. the Breakout tutorial: https://makinom.com/guide/tutorials/breakout/breakout-tutorial-introduction/ If you're seeking information/help with a specific feature, take a look at the documentation: https://makinom.com/guide/documentation/ If you have any tutorial requests or need help, don't hesitate and contact me: contact@makinom.com If you want to upgrade a Makinom 1 project to Makinom 2, check out the Makinom Upgrade Tool: https://makinom.com/guide/documentation/getting-started/upgrading-a-makinom-1-project/ The Makinom editor includes a built-in documentation. All settings are explained in the help window at the lower left corner of the Makinom editor. Information and help texts will be displayed if you hover with the mouse over a setting or foldout. You can change this behaviour in the editor settings (Editor > Editor Settings). There currently is no separate documentation of the individual settings available, other than the documentation and tutorials mentioned above. ------------------------------------------------------------------------------------------------------------------------------------------------------- Scripting and Extensions ------------------------------------------------------------------------------------------------------------------------------------------------------- You can extend Makinom's functionality using plugins, custom nodes and code extensions (via custom scripts). Learn more about scripting with Makinom here: https://makinom.com/guide/documentation/scripting/scripting-overview/ Check out available plugins, custom nodes and other scripts here: https://makinom.com/guide/extensions/ You can also use the Makinom Extension Manager in Unity to download and import available extensions into your project. Open the extension manager using the Unity menu: 'Window > Gaming Is Love > Makinom Extension Manager' ------------------------------------------------------------------------------------------------------------------------------------------------------- Support ------------------------------------------------------------------------------------------------------------------------------------------------------- Need help or found a bug? Please search for a solution or report the bug in the 'Support & Community' forum: https://forum.orkframework.com/ Didn't find anything or don't want to post in the forum? Contact me: contact@makinom.com ------------------------------------------------------------------------------------------------------------------------------------------------------- Folder Description ------------------------------------------------------------------------------------------------------------------------------------------------------- Upon import you'll get the following folders: - 'Assets/Gaming Is Love/Makinom 2/' This folder and sub-folders contains Makinom 2 and UI modules ('DLL' folder). You'll also find the source code (VS project), zipped-up in the 'Makinom_Source_Code.zip' file. - 'Assets/Gizmos/GamingIsLove/' This folder and sub-folders contain the gizmo icons for Makinom components and assets (in 128x128 pixels). After opening and saving in the Makinom editor you'll get additional folders: - 'Assets/Gaming Is Love/_Data/' This folder and sub folders contain your Makinom Project and data assets. It's recommended to keep them at this place. - 'Assets/Gaming Is Love/_Backups/' This folder contains backups created when saving changes in the Makinom editor. You can restore backups via the Makinom editor in: 'Editor > Backups' Backups will bundle all assets in the Makinom data folder as a unitypackage-file. - 'Assets/Gaming Is Love/_Downloads/' Packages you've downloaded via the extension manager will be stored in this folder. ------------------------------------------------------------------------------------------------------------------------------------------------------- iOS Hints ------------------------------------------------------------------------------------------------------------------------------------------------------- If you're building your project for iOS and run into issues, check out the Unity trouble shooting page: https://docs.unity3d.com/Manual/TroubleShootingIPhone.html