# Ascentroid Map Kit Current Build Status: Prototype / Experimental The Ascentroid Map Kit is an Unreal Engine 4 ("UE") plugin you install into the UE editor to assist with the creation of campaigns and levels for Ascentroid. The map kit, essentially, builds a \*.pak file, which treats your campaign/content like a game MOD for Ascentroid. It will also use a custom \*.json file for important, and required, meta data for your campaign. What's great about this is that it allows map creators to utilize almost all of the full features/capabilities of UE! ## Prerequisites 1) Only Windows, x64 is supported right now. Make sure you meet the [required Hardware and Software Specifications for Unreal Engine](https://docs.unrealengine.com/4.26/en-US/Basics/InstallingUnrealEngine/RecommendedSpecifications/). 2) Since UE treats a campaign like a MOD, it requires Microsoft's C++ compiler. You have two options: * Option #1 (free, smaller download size): Install [Visual Studio Code](https://code.visualstudio.com/docs/?dv=win) + [Visual Studio 2019 Build Tools](https://visualstudio.microsoft.com/vs/older-downloads/) following this [installation tutorial](http://jollymonsterstudio.com/2018/11/02/unreal-c-with-visual-studio-code/). ✅ RECOMMENDED * Option 2 (free, larger download size): Install [Visual Studio 2019 or 2017 Community Edition](https://visualstudio.microsoft.com/downloads/) following this [installation tutorial](https://docs.unrealengine.com/4.26/en-US/ProductionPipelines/DevelopmentSetup/VisualStudioSetup/). ❌ NOT RECOMMENDED 3) Install Unreal Engine 4.26.2 by following the [official installation guide](https://docs.unrealengine.com/4.26/en-US/installing-unreal-engine/). When prompted, select the Publishing License. * IMPORTANT: You MUST install the specific UE version 4.26.2. Do NOT install a different version! Ascentroid is built on 4.26.2. If you use a different version, your campaigns will NOT work! If you create a campaign on the wrong engine version, you will have to delete it and re-create it with the correct engine version! ![Imgur](https://camo.githubusercontent.com/7d4bc6da13b678b29b6df38b96bf9b40c7e5ad06162fcf405ff34faa84e62fb4/68747470733a2f2f692e696d6775722e636f6d2f3650356b6a696a2e706e67) * #1: In the Epic Games Launcher, click Unreal Engine on the left menu. * #2: Click Library on the top menu. * #3: Click the [+] icon to the right of Engine Versions. * #4: Click the dropdown on the engine version number. * #5: Select 4.26.2 from the dropdown and click install. When the install is finsihed, this is the version that should appear as installed: ![Imgur](https://camo.githubusercontent.com/b2abe896489366bb2f82cd6a3a34487b6f8f3d78717b1cb0e6f1ab9b5cbf01f4/68747470733a2f2f692e696d6775722e636f6d2f7734617473396f2e706e67) 4) If not already installed, install the [.NET Framework 4.7.2 Runtime](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-web-installer). This is required for the [Ascentroid Map Kit Setup Utility](https://github.com/Ascentroid/Ascentroid/raw/latest-stable/MapKit/Setup/AscMapKitSetup.zip). Note: you may need to run all installations as a Windows Administrator user.

### Setup Your Campaign Project Install Ascentroid (the game). The latest test builds are posted in the [Ascentroid Discord](https://discord.gg/pktfw78) in the #downloads channel. Start UE and create a new, blank C++ project for your campaign without Starter Content: ![Imgur](https://camo.githubusercontent.com/976c53474b6187196cc84311123d40725794a70bb2e33224f53840cf3aa2941f/68747470733a2f2f692e696d6775722e636f6d2f354d7371304f572e706e67) ![Imgur](https://camo.githubusercontent.com/31013223aff51d966452b314f1691185cca5cab3b14cf06e3d769db8f6143fb1/68747470733a2f2f692e696d6775722e636f6d2f497844425a69392e706e67) ![Imgur](https://camo.githubusercontent.com/1b9d159d682245bd0754db150ecc49fc7625836ed311cd9f0561116183d50f13/68747470733a2f2f692e696d6775722e636f6d2f5947757934385a2e706e67) Open your UE campaign project if it doesn't automatically open after you create it. Once open, click the Show Sources icon in the Content Browser: ![Imgur](https://camo.githubusercontent.com/53e4b4bf0b6188fa2456dd3d4302645a92254e07cc0da8274a0ea9789d026821/68747470733a2f2f692e696d6775722e636f6d2f6133786b47374a2e706e67) In the lower, right-hand corner of the Content Browser, click the View Options and make sure Show C++ Classes and Show Plugin Content options are selected/checked. ![Imgur](https://camo.githubusercontent.com/c2af3cdde4b4e5382763dcdf75248064d97628b0b9f5452c1404c3c9d593068d/68747470733a2f2f692e696d6775722e636f6d2f6a3750455444372e706e67) Now, close the UE campaign project. Download the [Ascentroid Map Kit Setup Utility](https://github.com/Ascentroid/Ascentroid/raw/latest-stable/MapKit/Setup/AscMapKitSetup.zip) (requires [.NET Framework 4.7.2 Runtime](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-web-installer)): https://github.com/Ascentroid/Ascentroid/blob/latest-stable/MapKit/Setup/AscMapKitSetup.zip Unzip anywhere and execute AscMapKitSetup.exe. Run as a Windows Administrator user: ![Imgur](https://camo.githubusercontent.com/4999ebe1c4e05b087b3b5b611f30a90c211e405eeb8466d0925f5a721082f414/68747470733a2f2f692e696d6775722e636f6d2f3669564e5930652e706e67) ![Imgur](https://camo.githubusercontent.com/4291d53a928d788380dd9364ffc13d3a1a721f48bc104142a4e6ad23698465fe/68747470733a2f2f692e696d6775722e636f6d2f473976616433762e706e67) Follow the steps and provide the folder/file locations as requested in the utility. When ready, click the Initialize Now! button. ![Imgur](https://camo.githubusercontent.com/5485576134b741c54e609162c33bab9fcec0924114c384b447156bed1d546ba3/68747470733a2f2f692e696d6775722e636f6d2f4e7a6f394c6a4a2e706e67) The utility will perform the following in the background: 1) Downloads the UE map kit source files and extracts them to the appropriate campaign project folders. 2) It will install a AscMapKit plugin into your UE campaign project. These files contain map kit content and C++ actors you can use in your levels (grates, fans, signs, doors, enemies, powerups, and more). 3) It will install a Campaign plugin in your UE campaign project. This plugin is required in order to cook a *.pak file, which will contain all of your campaign content to be used by the Ascentroid game runtime. 4) It will place an Empty.umap level file into your UE campaign project Content folder. This empty level, and file name, is required in order for the cook process to work. I don't know why... it's some kind of wonky UE thing. 5) It will create a _BatchScripts folder at the root of your UE campaign project. It will contain a few batch files you will need to use later. 6) It will create a *.json file at the root of your UE campaign project. This file contains important, and required, meta data used by the Ascentroid game runtime. When the map kit setup is complete, it should pop-up a series of steps to help guide you through the final setup: ![Imgur](https://camo.githubusercontent.com/0e2c2812d9deabf97c90050700431ab171846fc66f289260fe88d55b72f6ec67/68747470733a2f2f692e696d6775722e636f6d2f754f573447356f2e706e67) 1) Execute (as a Windows Administrator user): ``` [campaign project root]\_BatchScripts\GenerateProject.bat ``` Note: if running this command displays ERROR: Could not find NetFxSDK install dir; this will prevent SwarmInterface from installing. Install a version of .NET Framework SDK at 4.6.0 or higher, you did not install the proper Visual Studio components as instructed in the external tutorial/documentation! However, you can fix it quickly by simply installing the [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer). After that is installed, run the GenerateProject.bat script again. It should (hopefully) work now. 2) Execute (as a Windows Administrator user): ``` [campaign project root]\_BatchScripts\Compile.bat ``` 3) Open your UE campaign project. 4) If UE prompts to update the project, click Update: ![Imgur](https://camo.githubusercontent.com/661c0032f3a7d31e956ba01bdb15a26effd29105d4adb15ce4922267e246257e/68747470733a2f2f692e696d6775722e636f6d2f63364a584d55422e706e67) 5) If UE prompts about new plugins being available, click Dismiss: ![Imgur](https://camo.githubusercontent.com/9cf7f8cf8952e6508e3528c89dace52ee63c8a01757134dad338245be34744a8/68747470733a2f2f692e696d6775722e636f6d2f4e466a617447352e706e67) 6) Create at least one level in your UE project and save it to the Campaign Content folder. 7) Edit campaign *.json (make sure your campaign and level name(s) match): ``` [campaign project root]\[campaign project name].json ``` 8) All assets used in your campaign must be saved in the Campaign Content folder (or they won't cook!). 9) To cook your campaign, execute (as a Windows Administrator user): ``` [campaign project root]\_BatchScripts\Cook.bat ``` 10) The \*.json and \*.pak files for your campaign will be copied to the Ascentroid game folder: ``` [game root]\Ascentroid\Content\Ascentroid\Campaigns ``` 11) If everything worked, you can now test your campaign in the game, Ascentroid! 12) Visit Github for more documentation: https://github.com/Ascentroid/Ascentroid 13) Visit YouTube for tutorials: http://youtube.ascentroid.com

## Important Notes 1) All content must be placed in the Campaign Content folder, or it will not get cooked into your \*.pak file! 2) Everything you see in this map kit and documentation is subject to change as development progresses. If you have a question or comment, [let me know](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com). 3) Ascentroid uses a large scale in order to fix problems with collision. A cube scale of 20m x 20m x 20m is the general standard. 4) Read the [FAQ](https://github.com/Ascentroid/Ascentroid/raw/master/#faq).

## How do I build stuff? #### You may want to learn some basics about Unreal Engine: * Tutorial to convert old levels using Blender and Unreal Engine: https://www.youtube.com/watch?v=H6XOQAU8rJ8 * https://www.informit.com/articles/article.aspx?p=2819033&seqNum=3 * https://docs.unrealengine.com/en-US/index.html * https://docs.unrealengine.com/en-US/WorkingWithContent/index.html * https://docs.unrealengine.com/en-US/WorkingWithContent/Importing/FBX/StaticMeshes/index.html * https://docs.unrealengine.com/en-US/WorkingWithContent/Importing/HowTo/index.html * https://docs.unrealengine.com/en-US/Resources/ContentExamples/Lighting/index.html * https://docs.unrealengine.com/en-US/Resources/ContentExamples/MaterialNodes/index.html * https://docs.unrealengine.com/en-US/RenderingAndGraphics/index.html * Import 3D meshes: https://www.youtube.com/watch?v=_FgedJWInL0 * Lighting basics: https://www.youtube.com/watch?v=FsjqVIyr0O4 * Hierarchical Instanced Static Meshes: https://www.youtube.com/watch?v=GmFYPotzLhc
#### If you don't want to learn 3D modeling tools, you can try some Marketplace assets: ##### [SuperGrid](https://www.unrealengine.com/marketplace/en-US/product/supergrid-starter-pack) - highly recommended! ![SuperGrid](https://camo.githubusercontent.com/836807731743f549ab3127450c92d16ef69c451675d97394d04ade858ef4a5cc/68747470733a2f2f63646e312e6570696367616d65732e636f6d2f75652f6974656d2f5375706572477269645f53637265656e73686f745f30322d3139323078313038302d61373739356334333633666533326239366530653463646332323236326637312e706e673f726573697a653d3126773d31363030) If you want to make maps quickly without having to learn a 3D modeling program, I highly recommend [SuperGrid](https://www.unrealengine.com/marketplace/en-US/product/supergrid-starter-pack) (which is free!). Download it from the UE Marketplace here: https://www.unrealengine.com/marketplace/en-US/product/supergrid-starter-pack SuperGrid has a series of preview videos here: https://www.youtube.com/playlist?list=PLx7zxUeK-7HiAsH4DyaklZW0NAIyKGc2N Here is another small demo video: https://www.youtube.com/watch?v=NxUq_rD8PVM Tip: you can use SuperGrid in addition to a 3D modeling tool if you wish! It can be very handy to use both in your campaign(s)! To get SuperGrid setup in your campaign project, do the following: 1) From the Marketplace, click Create Project: ![Imgur](https://camo.githubusercontent.com/7cbc2c9277ca4d32a68e74a4e3d308774fd1ed6fcb23a564839a2b5ea229f84d/68747470733a2f2f692e696d6775722e636f6d2f57674c6e734a382e706e67) 2) Use the default project locations and click Create. We will be manually copying the content out of this project and into your campaign project next: ![Imgur](https://camo.githubusercontent.com/5d06f5366af780c95d402fb6565bebb1ac507a8ed51df6dbd44ab58198602d2f/68747470733a2f2f692e696d6775722e636f6d2f6c6258683144772e706e67) 3) Copy the content folder for the default SuperGrid project to the content folder for your campaign project: From: ``` [SuperGrid project root]\Content\SuperGrid ``` To: ``` [campaign project root]\Content\SuperGrid ``` For example, from: ![Imgur](https://camo.githubusercontent.com/400edf4179e03e487bb17fb38b0706fa5c2b2d97ec4aa0983417516da3bb6b27/68747470733a2f2f692e696d6775722e636f6d2f643630373254542e706e67) To: ![Imgur](https://camo.githubusercontent.com/10c558f372a99410fd103535fe2649d5f07c07085e27c483b38c681ff8fefe66/68747470733a2f2f692e696d6775722e636f6d2f71793536336d732e706e67) 4) Now, open your UE campaign project. 5) If it worked, you should now see the SuperGrid folder in the Content Browser under the root Content folder: ![Imgur](https://camo.githubusercontent.com/9f11552a2505436e1e7ae66b87b931a0aaf1a53e1dab67ecdf56d553f982f3ae/68747470733a2f2f692e696d6775722e636f6d2f543257567066482e706e67) Note: You cannot start using SuperGrid yet! The next steps are critical! Remember: all content must be placed in the Campaign Content folder, or it will not get cooked into your \*.pak file! See [Other Marketplace Content](https://github.com/Ascentroid/Ascentroid/raw/master/#other-marketplace-content) for details on why these next steps are absolutely necessary. 6) Drag and drop the SuperGrid folder from the Content folder to the Campaign Content folder (optionally, if you want to place SuperGrid into sub-folder(s) under Campaign Content, create them and move the assets there): ![Imgur](https://camo.githubusercontent.com/eeb957da268e4d9c5aaaa5b8a1015f13e9c6e9bb04383322d68473b774d48bff/68747470733a2f2f692e696d6775722e636f6d2f54506543584d732e706e67) 7) When prompted, select Move Here: ![Imgur](https://camo.githubusercontent.com/c1cb5c8830948bc659dcd3e6930617ef45697714c02f7b8c5af8d0d780692193/68747470733a2f2f692e696d6775722e636f6d2f394c4e4b4e77452e706e67) 8) The UE editor will begin migrating assets to your Campaign Content folder: ![Imgur](https://camo.githubusercontent.com/9183df32192cd4f3863f86c5e4b0d9fffb60b80a86fe59ba66b95d82e121f622/68747470733a2f2f692e696d6775722e636f6d2f4a766f5731375a2e706e67) 9) You should now be able to start using SuperGrid in your level(s). Just be sure you use everything that is in the Campaign Content folder! ![Imgur](https://camo.githubusercontent.com/8be3ac728eb30628c01a62f48ba73d0b28e7a7ee7f14ad078fdc1094ccc8fff0/68747470733a2f2f692e696d6775722e636f6d2f4b67674e464c372e706e67) Tip: if you would like to save on some disk space, I recommend that you delete unused asset files when using Marketplace content. For example, for SuperGrid, I would delete everything in the TutorialLevel folder, the Blueprints folder, and the Overview file(s). Tip: after everything has been moved; if there is a set of empty SuperGrid folders still visible in the Content folder, just delete them from the file system / using file explorer. To reiterate: see [Other Marketplace Content](https://github.com/Ascentroid/Ascentroid/raw/master/#other-marketplace-content) for details on why these steps are absolutely necessary.
##### Built-In Editor UE Mesh Plugins - highly recommended! UE has a few plugins included (free!) you can enable which will allow you to work with 3D meshes directly in the editor. Just go to Edit -> Plugins and enable them: ![Imgur](https://camo.githubusercontent.com/40542f22610aac60b5a5b6593c2e1dbc34fefa673d53a6aee3f4bc0acb3f2ece/68747470733a2f2f692e696d6775722e636f6d2f356e78766a724d2e706e67) ![Imgur](https://camo.githubusercontent.com/a9ba089463ce9c4a05f165e29b54405efd4555956b460c009ec06699116cf5b9/68747470733a2f2f692e696d6775722e636f6d2f6170736673766b2e706e67) Here are some tutorial videos on how to use some of these free UE plugins: * https://www.youtube.com/watch?v=7Ff0zZcHmaU * https://www.youtube.com/watch?v=P75oIsxrYlY * https://www.youtube.com/watch?v=UqR6rnZEidg * https://www.youtube.com/watch?v=hdk5Bf4zZwk
##### [Mesh Tool](https://forums.unrealengine.com/unreal-engine/marketplace/107840-mesh-tool-a-mesh-editor) - highly recommended! [Mesh Tool](https://forums.unrealengine.com/unreal-engine/marketplace/107840-mesh-tool-a-mesh-editor) is a commercial (paid) UE plugin which allows you to edit mesh assets and prototype props and levels without leaving the UE Editor. It also includes basic UV mapping tools! ![MeshTool](https://camo.githubusercontent.com/39596c6924d4f2812c8f1e3a0457f19a4c59c0d062bdce14429dfa10986f62eb/68747470733a2f2f64336b6a6c75683733623968396f2e636c6f756466726f6e742e6e65742f6f726967696e616c2f33582f352f332f353365326431396232303630393466633432313663626464346539356335373639633933646439312e6a706567) ![MeshTool](https://camo.githubusercontent.com/2e1a0ebcc5a9bd8b810533f1a60db3afbb81b4305cf3f08648038f052d11ac08/68747470733a2f2f64336b6a6c75683733623968396f2e636c6f756466726f6e742e6e65742f6f726967696e616c2f33582f632f342f633464663863666235633164353265636635353061663537303862626631363262326263396138652e6a706567) Mesh Tool links: * [Unreal Engine Forums](https://forums.unrealengine.com/unreal-engine/marketplace/107840-mesh-tool-a-mesh-editor) * [Get Mesh Tool on the Marketplace](https://www.unrealengine.com/marketplace/mesh-tool) * [Get Mesh Tool on itch.io](https://marynate.itch.io/mesh-tool) * [YouTube Tutorials](https://www.youtube.com/playlist?list=PLAKCoctl4aHxyY9fZbQIpdtEdzlj09GSn) * [User Guide](https://docs.google.com/document/d/1yCEFGz4LEWdhZEw3bk_tCPI3Gg6D-29_AhtkeWJqm1g/pub) * [Issue Tracker](https://github.com/marynate/mesh-tool/issues) Tip: Keep an eye out for asset sales. Sometimes you can get a helpful tool for less, or even sometimes free, during a sale.
##### [Instance Tool](https://www.unrealengine.com/marketplace/en-US/product/instance-tool) - highly recommended! [Instance Tool](https://www.unrealengine.com/marketplace/en-US/product/instance-tool) is a commercial (paid) UE plugin which allows you to quickly select/edit/convert Instanced Static Meshes in editor viewports. This is a good tool to have for [performance/optimization](https://github.com/Ascentroid/Ascentroid/raw/master/#performance-optimization). ![Imgur](https://camo.githubusercontent.com/b86137beb12588493833134e82342669f91ea99766e863998a83c7e88453522e/68747470733a2f2f63646e312e6570696367616d65732e636f6d2f75652f6974656d2f496e7374616e6365546f6f6c5f73637265656e73686f745f372d3139323078313038302d63653131653134393765386630353239626337333461623666343662326431382e6a70673f726573697a653d3126773d31363030) * [Get Instance Tool on the Marketplace](https://www.unrealengine.com/marketplace/en-US/product/instance-tool) Tip: Keep an eye out for asset sales. Sometimes you can get a helpful tool for less, or even sometimes free, during a sale.
##### Other Marketplace Content You can try using more [Marketplace](https://www.unrealengine.com/marketplace) assets from the UE Marketplace here: https://www.unrealengine.com/marketplace Epic has a lot of free assets available as well: https://www.unrealengine.com/marketplace/en-US/free When using assets from the UE Marketplace, be sure to follow these guidelines: * If the asset requires the creation of a UE project, always create the default project somewhere temporary, first, and then manually copy the assets to the Content folder of your UE project. * If the asset is able to install directly into your UE campaign project, the asset should always get installed to the Content folder of your UE project, first (this is typically the default anyway). * The reason assets need to go in the Content folder first is because UE uses an internal reference path system to associate dependencies between assets. * For example, let's say you have an asset pack called SomeMarketplaceAssetPack with a material and a texture inside of it: ``` /Content/SomeMarketplaceAssetPack/Materials/M_SomeMaterial /Content/SomeMarketplaceAssetPack/Textures/T_SomeTexture ``` * If the material asset M_SomeMaterial is utilizing/referencing the texture T_SomeTexture inside of it, then the material will be pointing to the absolute path of the texture asset, like this: ``` /Content/SomeMarketplaceAssetPack/Textures/T_SomeTexture ``` * If you made the mistake of only copying/moving M_SomeMaterial to your Campaign Content folder, but not T_SomeTexture, then M_SomeMaterial would still be referencing the wrong absolute path (above). This means the asset will not be cooked! * To make sure the paths are migrated to the Campaign Content folder properly, you can follow a few steps and the UE editor will automatically fix/resolve most of the dependencies for the absolute paths for you! * Drag and drop the marketplace asset folder from the Content folder to the Campaign Content folder (optionally, if you want to place marketplace asset into sub-folder(s) under Campaign Content, create them and move the assets there): ![Imgur](https://camo.githubusercontent.com/eeb957da268e4d9c5aaaa5b8a1015f13e9c6e9bb04383322d68473b774d48bff/68747470733a2f2f692e696d6775722e636f6d2f54506543584d732e706e67) * When prompted, select Move Here: ![Imgur](https://camo.githubusercontent.com/c1cb5c8830948bc659dcd3e6930617ef45697714c02f7b8c5af8d0d780692193/68747470733a2f2f692e696d6775722e636f6d2f394c4e4b4e77452e706e67) * The UE editor will begin migrating assets to your Campaign Content folder. It's at this point the editor will automatically fix/resolve all of the dependencies for the absolute paths for you. ![Imgur](https://camo.githubusercontent.com/9183df32192cd4f3863f86c5e4b0d9fffb60b80a86fe59ba66b95d82e121f622/68747470733a2f2f692e696d6775722e636f6d2f4a766f5731375a2e706e67) * You can try this out by following the installation instructions for [SuperGrid](https://github.com/Ascentroid/Ascentroid/raw/master/#supergrid). Note: this may or may not have adverse affects on different types of assets contained within the marketplace content (for example: Blueprint dependencies). It has not been fully tested and results may vary, depending on how complicated the marketplace asset(s) you are working with are. You may have to perform additional manual work to make certain things compatible when moving things over to the Campaign Content folder. It's up to you to decide how advanced you want to make things. Tip: remember, if you would like to save disk space for your UE campaign project, analyze all marketplace assets and delete assets which are unnecessary.
#### Use 3D tools: * [Blender](https://www.blender.org/) (free) * [MagicaVoxel](http://ephtracy.github.io/) (free) * [Silo 3D](https://nevercenter.com/silo/) (paid) * [Maya](https://makeanything.autodesk.com/maya-indie-usa) (paid) * [3D Studio Max](https://makeanything.autodesk.com/3dsmax-indie-usa) (paid) * [Modo](https://www.foundry.com/products/modo) (paid) * [Lightwave](https://www.lightwave3d.com/buy-lightwave/) (paid) * [Rhino 3D](https://www.rhino3d.com/) (paid) * [Sketchup](https://www.sketchup.com/plans-and-pricing/sketchup-free) (free) * [Substance Designer](https://www.substance3d.com/products/substance-designer/) (paid) * [Houdini](https://www.sidefx.com/products/houdini/houdini-indie/) (paid) * Want more tools listed here? [Contact me](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com)

#### Importing 3D Meshes into UE If you want per-poly collision on the 3D mesh you are going to import into UE: * When importing your FBX, uncheck Auto Generate Collision: ![Imgur](https://camo.githubusercontent.com/67ee6d27b8b09f481335e60e8d9fa1e5b9b0d3977ff0df3b5ccd4e100b7eeb7b/68747470733a2f2f692e696d6775722e636f6d2f41357a564f76692e706e67) * Once it has been imported, edit your mesh in UE and go to the collision properties. Set the Collision Complexity to Use Complex Collision As Simple. This tells the engine to use per-poly collision on this mesh. ![Imgur](https://camo.githubusercontent.com/21051fa10c735806a1eb195a96f0c3a9b47e5fe188db09e6fafebe7992cf2361/68747470733a2f2f692e696d6775722e636f6d2f366569345467372e706e67) * Note: keep in mind any additional work you may need to consider for [performance/optimization](https://github.com/Ascentroid/Ascentroid/raw/master/#performance-optimization).

#### Import levels from other games Descent 1 and 2: Tutorial to convert old levels using Blender and Unreal Engine: * https://www.youtube.com/watch?v=H6XOQAU8rJ8 It's even *easier* to convert a level using [Mesh Tool](https://www.unrealengine.com/marketplace/en-US/product/mesh-tool), a commercial Unreal Engine plugin ($50). We will create a tutorial video for this plugin in the near future. * Setup [OTDVM](http://www.columbia.edu/~em36/otvdm.html) (easy), **OR** (harder) setup a [Windows 98](https://winworldpc.com/product/windows-98/98-second-edition) virtual machine (consider using [VirtualBox](https://www.virtualbox.org/), which is free). * [Download](https://drive.google.com/file/d/1E4M43I8zox58ODjqulhXaBSMnyYJu2z5/view?usp=sharing) and setup [LVLVIEW32](https://drive.google.com/file/d/1E4M43I8zox58ODjqulhXaBSMnyYJu2z5/view?usp=sharing) with OTDVM, **OR** on your Windows 98 virtual machine. Instructions/details are not included here; you will have to sort that out yourself since the process can be subjective depending on how you setup your environment. * In [LVLVIEW32](https://drive.google.com/file/d/1E4M43I8zox58ODjqulhXaBSMnyYJu2z5/view?usp=sharing), export your level to a DXF file. * Convert the DXF file to a FBX file. You can use a [3D tool](https://github.com/Ascentroid/Ascentroid/raw/master/#3d-tools), or try a free 3D file converter like this one: https://products.aspose.app/3d/conversion/dxf-to-fbx * Some of the 3D mesh normals may be flipped. You can use a [3D tool](https://github.com/Ascentroid/Ascentroid/raw/master/#3d-tools), or [Mesh Tool](https://github.com/Ascentroid/Ascentroid/raw/master/#mesh-tool), to fix your normals. * You will probably need to scale your level to match Ascentroid's scale. A cube at Ascentroid scale is 20m x 20m x 20m. You can use a [3D tool](https://github.com/Ascentroid/Ascentroid/raw/master/#3d-tools), or [Mesh Tool](https://github.com/Ascentroid/Ascentroid/raw/master/#mesh-tool) to re-scale your level 3D mesh. * Texture your level 3D mesh by setting up UV mapping. You can use a [3D tool](https://github.com/Ascentroid/Ascentroid/raw/master/#3d-tools), or [Mesh Tool](https://github.com/Ascentroid/Ascentroid/raw/master/#mesh-tool). * Import your level 3D mesh into your UE campaign project. Remember: all assets used in your campaign must be saved in the Campaign Content folder (or they won't cook!). * Optional, subjective: When you [import your level 3D mesh](https://github.com/Ascentroid/Ascentroid/raw/master/#import-3d-meshes) into the UE editor, you will probably want to disable collision generation. After it has been imported, edit the level 3D mesh and enable per-poly collision by setting Collision Complexity to Use Complex Collision as Simple: ![Imgur](https://camo.githubusercontent.com/d5d6e8a5bd10ddc3ddb505b927b2ee07cb08117e3fedc4fa119264770ccf3ace/68747470733a2f2f692e696d6775722e636f6d2f5062646a6f50622e706e67) Common steps in Unreal Engine's editor (not in order) to perform a level conversion: * Unreal Engine project settings: Generate project a ID, otherwise the campaign won't cook * Unreal Engine world settings: Set num skylights to 0 (this saves some light build processing time) * Unreal Engine world settings: Check "Force no precompute lights" (this sets lights to fully dynamic, so you can build without having to light build) * Unreal Engine level: Place global items and effects (copy from Template campaign) * Unreal Engine level: Place global lights, amount, positioning (copy from Template campaign) * Unreal Engine level: Setup navmap, positioning, sizing to encompass the level with some padding (necessary, otherwise the navmap fog of war won't work) * Unreal Engine world outliner: Folder organization! * Unreal Engine content manager: Folder organization! * Unreal Engine content manager: Import FBX of your level and review the import options * Unreal Engine content manager: Update your level static mesh to set Collision Complexity to "Use Complex Collision as Simple" * Unreal Engine content manager: Update your level static mesh Light Map Resolution to something high like "1024" or "2048" ("1024" is usually high enough) * Unreal Engine content manager: Move textures to its own content folder * Unreal Engine content manager: Move materials to its own content folder * Unreal Engine content manager: Edit materials (for cartoony style, set Metallic and Specular to "0" (zero), and Roughness to "1") * Unreal Engine level: Add player starts from the map kit * Unreal Engine level: Add powerup respawn triggers from the map kit * Unreal Engine level: Add doors from the map kit (remember to set unique IDs for all!) * Unreal Engine level: Add decor (grates, signs, etc) * Unreal Engine level: Add lights (copy from template campaign if you want) * Unreal Engine level: Add powerups from the map kit * Unreal Engine level: Add level author decor letters and lights for them (if you want) * Unreal Engine world settings: Uncheck "Force no precompute lights" (turns off dynamic lights to prepare for light building) * Unreal Engine level: Add any desired triggers from the map kit (if applicable) * Unreal Engine level: Add any desired Blueprint scripting (if applicable) * Unreal Engine level: Adjust global lights (lights will be brighter when light building, so turn them down) * Unreal Engine light build settings: Set the light build quality to "Production" * Unreal Engine level: Build lights * Unreal Engine content manager: Fix level light map UVs and resolution if necessary * Unreal Engine level: Tweak and build lights repeatedly until you get it right (toggle "Force no precompute lights" in world settings to help; switch from dynamic to static to dynamic to static repeatedly to help figure out good lighting techniques in combination with light building [with the goal of producing final, baked, static lights]) * Unreal Engine level: Run Cook.bat * Finally: Test your campaign in the game. If it looks good, zip the campaign json and pak files, and offer to players (mission database may become available in the future, recommend something like Google Drive in the meantime)

### Ascentroid Map Kit Usage Overview The Ascentroid map kit contains pre-fab assets and actors you can use in your UE campaign project level(s). Pre-fab Content * Placeable pre-fab content can be found in the AscMapKit Content folder. Feel free to explore this content to use in your project: ![Imgur](https://camo.githubusercontent.com/551b8c496b1062bac20cd144a1674d79e5853212a628be96afa3022b837ba05a/68747470733a2f2f692e696d6775722e636f6d2f4d7a3159746d732e706e67) * You can drag and drop static meshes into your level(s). You can also use some of the materials, particles, textures and other assets that are available as part of pre-fab content. * For example, I swapped out the color of the sign text using a pre-fab material instance here: ![Imgur](https://camo.githubusercontent.com/dc509e032e714b1f39088ce3ae9d8422d71c171154ad3bb592f33c615b174b22/68747470733a2f2f692e696d6775722e636f6d2f37466f3673315a2e706e67) * Another example, a pre-fab particle is included you could use as a power station effect: ![Imgur](https://camo.githubusercontent.com/2fda9789bac0cda6c8ecd599ab259fa25493b328d6fd3dbba51f874c9ee0825f/68747470733a2f2f692e696d6775722e636f6d2f554465385673672e706e67) * If you instead wanted to use your own material(s), create them in the Campaign Content folder, and then use it on a pre-fab. It should work. All content in the AscMapKit Content folder is shared with the game runtime. You should even be able to, for example, create material instances that reference base materials inside the AscMapKit Content folder. However, if this doesn't work, [please let me know](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com) right away. * I'll be adding more pre-fab asset content to the map kit as it is developed. Eventually, I foresee the community developing and submitting new assets for the map kit as well! Perhaps, in the future, we could even build a completely separate, community asset pack system! Actors * Placeable game actors can be found in the AscMapKit C++ Classes folder: ![Imgur](https://camo.githubusercontent.com/ab89b439a4e9baabaeadfe9a65fbf1374d8d517c8044cf511b80176c729798e2/68747470733a2f2f692e696d6775722e636f6d2f524954465059582e706e67) Player Start Positions * Just drag and drop an AscMapKitPlayerStart from the Player folder. The 3D mesh and white arrow will show which direction the player will be oriented when spawning. You will want to add eight (8) player start positions to your level(s): ![Imgur](https://camo.githubusercontent.com/637f11918127ff092b0e3799942eeeb97c5dfa35545335a2bacbdc9c6583007f/68747470733a2f2f692e696d6775722e636f6d2f7965516157456c2e706e67) Powerups * Just drag and drop an AscMapKitPowerupActor from the Powerup folder, and select a Powerup Type from the properties on the right-hand side of the editor: ![Imgur](https://camo.githubusercontent.com/3b12d474e1ef501aae7ee6e880f2b9159a95041611365a8924ded6f898a8acf2/68747470733a2f2f692e696d6775722e636f6d2f34634450446d6d2e706e67) Tip: copy and paste powerup actors to quickly fill your level(s) with powerup spawn points! Doors * Just drag and drop an AscMapKitDoorActor from the Door folder, and select a Door Type from the properties on the right-hand side of the editor: ![Imgur](https://camo.githubusercontent.com/177ba0444320163ca35adb8eb9f10161f622fe26dd2c543b9ccdc9520d34f7ba/68747470733a2f2f692e696d6775722e636f6d2f465474443731482e706e67) Tip: there are tons of actor properties you can tweak! Hover your mouse over the property in the editor. They should all be fully documented! ![Imgur](https://camo.githubusercontent.com/ae43bd3d5fdac234c8f709cea12506affa99eeeaae985377940e7e57986d0c7d/68747470733a2f2f692e696d6775722e636f6d2f6c745751554e662e706e67) Note: Doors cannot be scaled yet. This may be coming in the future. Environment Areas * Just drag and drop an AscMapKitEnvironmentAreaActor from the Area folder, and select an Environment Area Type from the properties on the right-hand side of the editor: ![Imgur](https://camo.githubusercontent.com/0148e2a84fcf18a0ee54b490f475d76b39ca0dd23ef57574c9a6ed17acf30849/68747470733a2f2f692e696d6775722e636f6d2f52364465544b362e706e67) Tip: power stations are considered environment areas. Just select Power Station without Effects or Power Station with Effects from the Environment Area Type property. Tip: environment area actors do not have pre-defined visual assets available (other than a power station particle). It's up to you to create/import the visual assets you want to use for things like water, acid, lava, etc. I highly recommend the Cartoon Water Shader (paid): https://www.unrealengine.com/marketplace/en-US/product/cartoon-water-shader Tip: there are tons of actor properties you can tweak! Hover your mouse over the property in the editor. They should all be fully documented! Powerup Respawn Trigger Volumes * In order for the Ascentroid game runtime to know where and how to respawn powerups, you need to place Powerup Respawn Trigger Volumes in your level(s). * Just drag and drop an AscMapKitPowerupRespawnTriggerBox from the Powerup folder, and select which Powerups are allowed to spawn in this volume from the properties on the right-hand side of the editor: ![Imgur](https://camo.githubusercontent.com/be7d8cb8a986df087b1ddeaad865d2a524e604d89e69103ff859b6bde6e2070c/68747470733a2f2f692e696d6775722e636f6d2f7166594f5572712e706e67) Tip: you can create many Powerup Respawn Trigger Volumes in your level(s) and scale them to size to fit your needs. For example, this level has them setup like this: ![Imgur](https://camo.githubusercontent.com/9dbe58ee3067f3cad6bac159b5e5d17b98cd00c3e17ad7cb5d292fa8a9da9d22/68747470733a2f2f692e696d6775722e636f6d2f487733637439592e706e67) Note: if you don't add Powerup Respawn Trigger Volumes to your level(s), then powerups will not respawn after despawning in multiplayer! Enemies * Just drag and drop an AscMapKitEnemyActor from the Enemy folder, and select an Enemy Type from the properties on the right-hand side of the editor: ![Imgur](https://camo.githubusercontent.com/3c76ef5e94fa839df76b7290bb382637c789d9cfd4e4b4891ac41e63c7349161/68747470733a2f2f692e696d6775722e636f6d2f4e5359536467482e706e67) Note: enemies are represented as billboards/sprites in the editor because the static meshes are commercial assets (purchased) and cannot not be distributed in the map kit. If you would like to modify properties like colors, they are displayed on the cube and sphere meshes attached to the map kit actor (so you can preview them while working). Note: at the time of this writing, single player and cooperative game modes are still under heavy development, so a lot of properties related to enemies are still in progress. Some of them may not even be functional. Tip: there are tons of actor properties you can tweak! Hover your mouse over the property in the editor. They should all be fully documented! Summary It's important to remember, in general, that not all actor properties are enabled/functional yet. All properties and behaviors are subject to change as development of the map kit progresses. If you have any questions about the map kit content, properties, etc, please [email me](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com), or find me on the [Ascentroid Discord](https://discord.gg/pktfw78).

### Keep in mind performance/optimization * Use baked lighting. Avoid full dynamic lighting. What I've learned to do is to use full dynamic lighting while developing a level and testing it out. When I get close to finishing a level, I will switch all of the lighting from dynamic to baked. When ready for production, I'll change the Lighting Quality to Production, and change all of my static mesh asset's Lightmap Resolutions to 1024 (or higher). Caution: baking lights requires lightmap UVs to be setup on your static meshes, and none of them can be overlapping. Different kinds of [3D Tools](https://github.com/Ascentroid/Ascentroid/raw/master/#3d-tools) handle this by placing the lightmap UVs on a separate channel. Due to the subjective nature of this process, you will have to handle this on your own. You should be able to find tutorials on [YouTube](https://www.youtube.com/results?search_query=UE+blender+lightmap) to figure out how to do this. * If possible, use [Instanced Static Meshes](https://www.google.com/search?q=UE+instanced+static+mesh+site%3Aanswers.unrealengine.com) and/or [Hierarchical Instanced Static Meshes (HISM)](https://www.google.com/search?q=UE+hierarchical+instanced+static+mesh+site:answers.unrealengine.com). You can do [amazing optimizations](https://www.youtube.com/watch?v=oMIbV2rQO4k) using these techniques/tools: ![Imgur](https://camo.githubusercontent.com/d558d586defa520ec0384273c8a4efb6debec7a50961ec8989d3abf649207dbd/68747470733a2f2f692e696d6775722e636f6d2f51725868694d422e6a7067) * If you are going to use high-poly 3D meshes, I recommend learning how to setup LOD groups. Here is a tutorial: https://www.youtube.com/watch?v=li5qraDIZIM * If your level static meshes are high-poly, it would be a good idea to break them apart into several smaller mesh pieces (instead of one big mesh). If you are using per-poly collision for your level mesh, a giant mesh will require more computation and likely affect game performance. Smaller meshes should perform better. However, if your level is small and doesn't have many polygons, a single mesh is probably fine. You will have to test it out and decide for yourself. * If you have more performance/optimization tips you'd like added, please [email me](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com), or find me on the [Ascentroid Discord](https://discord.gg/pktfw78).

#### Scripting is possible, however... Currently, most scripting capabilities will only run on the client and are not replicated in multiplayer (except in the case where Ascentroid map kit actors send explicit network commands). Eventually, Ascentroid map kit actors will have events you can attach to in order to perform client-side scripting operations. This is still highly experimental, but here is an example of an event emitted by an Ascentroid map kit trigger actor using [Blueprints](https://docs.unrealengine.com/en-US/ProgrammingAndScripting/Blueprints/GettingStarted/index.html): ![Imgur](https://camo.githubusercontent.com/b786792251a3a1eaf109a485bc807590cdb32616255fef256384073c53c9ad7b/68747470733a2f2f692e696d6775722e636f6d2f676a34335139582e706e67) When this trigger is deactivated, it will change the visibility of a few static meshes in the level, and spawn some particles. It opens up a secret area in the map, and spawns a grate mesh. This Blueprint is embedded entirely in the Campaign Content and considered client-side scripting. The trigger deactivation is an explicit network command sent by the Ascentroid map kit trigger actor, so all of the clients in the game scripts will operate in the same way. In the future, I may add generic [RPC-like](https://en.wikipedia.org/wiki/Remote_procedure_call) features for Blueprint-only network communication (depending on how things go). Lastly, only Blueprints scripting is supported. Ascentroid does not yet support scripting in C++. This is still being researched.

## Demo Campaign Project A UE demo campaign project has been created, which you can download and inspect for learning purposes. It includes three levels and various free content sources. Be sure to read the included Readme.txt file. Download the UE demo campaign project zip file from here: https://drive.google.com/file/d/1zlutTZXBK4Vy-YLGeMa7izCC1L5hhVVt/view?usp=sharing ![Imgur](https://camo.githubusercontent.com/850e7a80aa4e008f38e7b9da65ad3225cfb891a59cefc7f58aea1164420116d2/68747470733a2f2f692e696d6775722e636f6d2f577230424e6a782e706e67) ![Imgur](https://camo.githubusercontent.com/71e253a6f9f5aea84d17ea5b9c10488db4c5d49b085e654b40651c6320264ac4/68747470733a2f2f692e696d6775722e636f6d2f777055587467432e706e67) ![Imgur](https://camo.githubusercontent.com/8fa043dc9f66e2dbe8976555ebb347ba87ebb411bf40512734a8ccb0b93fe9ca/68747470733a2f2f692e696d6775722e636f6d2f6d5977343265622e706e67)

## Template Campaign Project A UE template campaign project has been created, which you can download and open, then copy and paste assets from into your own campaign! Just have both projects open and you can copy and paste (CTRL+C, CTRL+V) assets from one level to the other seamlessly. Just remember to adjust locations and settings of the assets for your own campaign. Be sure not to delete anything out of the template campaign, or change/save it. If you do, you may have to delete it and re-download it again. Download the UE template campaign project zip file from here: https://drive.google.com/file/d/1jskTpWxB0KLx1hdVMsVNNXpgbg1ElNax/view?usp=share_link ![Imgur](https://camo.githubusercontent.com/a79138d80204e9f2340583660b815e61eb778a962a04930deaea72824833cab3/68747470733a2f2f692e696d6775722e636f6d2f775556736367592e706e67)

## FAQ Where can I learn more about the game? `See: ` https://ascentroid.com/faq.html How do I handle different game modes? `Ascentroid currently only has one game mode: deathmatch. When that changes, this documentation will be updated.` How do I handle single player versus multiplayer? `Currently, you can run campaigns in either mode (no restrictions). However, cooperative does not work. All enemies will run client-side and are not replicated in multiplayer (yet).` Why don't you have more pre-defined assets we can use? `This is a solo indie game development effort, currently without funding.` Why is it so difficult to convert levels from other games? `Well, this is a solo indie game development effort, currently without funding.` Why do I have to use 3D tools to build maps? Why didn't you build something easier for people? `UE is capable to doing a lot out-of-the-box, however, this means you have to put in the effort and learn how to do things yourself. To get started quickly, I highly recommend using ` [SuperGrid](https://github.com/Ascentroid/Ascentroid/raw/master/#supergrid) Why is the setup so complicated? `It depends on your capabilities. When testing the setup utility, Blarget2 was up and running with his first campaign in about 15 minutes. If you are not technically capable, you probably shouldn't be trying to make campaigns in Ascentroid.` Is there a reactor? `No. Single player and cooperative game modes have yet to be developed.` Is there an escape tunnel? `Well, no. Single player and cooperative game modes have yet to be developed.` Do campaigns/levels auto-download if other players don't have them? `Currently, no. You have to send the file(s) to other players manually. If this changes, I will update this documentation.` How can I setup my campaign to transition between levels? `This is not supported yet. It should be coming in the future. However, currently, you can select individual levels in a campaign when starting a single player game, or when hosting a new multiplayer game.` Can I contribute to the map kit to provide more pre-fab asset content? `Maybe! Let's chat! See: ` [Contact](https://github.com/Ascentroid/Ascentroid/raw/master/#contact) Why does the Ascentroid map kit limit modding abilities? `Because I'm learning how to do this stuff while working on this project. Depending on how much effort it will take, and where the direction of the project goes, I may expand what it is capable of. For now, it is limited.` I have more questions, what should I do? `See:` [Contact](https://github.com/Ascentroid/Ascentroid/raw/master/#contact)

## Version Control You should keep your UE campaign projects saved somewhere! I highly recommend something like [Git](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) (with [LFS enabled](https://git-lfs.github.com/)) (and [learning it](https://www.udemy.com/course/intro-to-git/) if you don't know it). You can setup free accounts with services like [Github](https://github.com/), or [Bitbucket](https://bitbucket.org/product). Alternatively, you could setup a local Git server using something like [Bonobo Git Server](https://bonobogitserver.com/). You could also use [Linux](https://www.linux.com/training-tutorials/how-run-your-own-git-server/) to host a Git server. At the bare minimum, using something as simple as [Google Drive](https://www.google.com/intl/en_jm/drive/), [OneDrive](https://office.live.com/start/onedrive.aspx) and/or [Backblaze](https://www.backblaze.com/) would be a good idea. You decide. Note: when Ascentroid gets updated, sometimes I have to upgrade UE core engine versions. This will impact the Ascentroid map kit, and your campaign project(s)! Keep your campaign projects backed up somewhere, because you will be required to go through these upgrades in the future, too, if you want your maps to be compatible with upgrades! I don't have all the details on how this will work yet, but when I do, I'll be adding more information to this documentation. The main thing is, for now: keep your campaign projects backed up!

## Acknowledgments * Special thanks to Diamond Wolf for contributing a lot of feedback on the map kit while it was being developed. A lot of his ideas were incorporated into what you see. He also made the level in the campaign Rubicon, which was the first community-based level imported into Ascentroid using the map kit. * Special thanks to [Blarget2](https://www.twitch.tv/blarget2) for testing out the [Ascentroid Map Kit Setup Utility](https://github.com/Ascentroid/Ascentroid/raw/latest-stable/MapKit/Setup/AscMapKitSetup.zip), and being the first person to start using the map kit. ## Contact Please email me at [ascentroid@gmail.com](https://github.com/Ascentroid/Ascentroid/raw/master/mailto:ascentroid@gmail.com), or find me on the [Ascentroid Discord](https://discord.gg/pktfw78). My online handle is Verran. ## License This project is licensed under the MIT License - see the [LICENSE](https://github.com/Ascentroid/Ascentroid/raw/master/LICENSE) file for details.