Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 4.31 KB

SETUP.md

File metadata and controls

77 lines (57 loc) · 4.31 KB
Raw

Setup Guide

Depending on your current situation, the setup for the Map Editor may take around 30 minutes to complete.
Please complete all steps below.

Download

Software Version / Option Recommendation
Python 3.10.7 Required
Microsoft C++ Build Tools Desktop development with C++ Required
Blender Latest Strongly recommended
Visual Studio Code Latest Strongly recommended

Installation

Python

  • Click on Add Python to PATH in the Setup Wizard and then choose Install

Microsoft C++ Build Tools

  • After the installation is complete, reboot your computer

Blender

  • No additional information required. Just follow the installation wizard

Visual Studio Code

  • No additional information required. Just follow the installation wizard

Test Python & Install Required Libraries

  • In 📁 Setup, double click on 📄INSTALLER.bat to start the process

Install Blender-Python Libraries

  • Since Blender uses its own Python interpreter, you must install a few libraries from the previous step into Blender's Python Environment
  • Open Blender as administrator, then click on the Scripting tab (top right corner)
  • A new grey window appears, click on 📁 Open
  • Navigate to ...\MM1-Map-Editor\Setup and select blender_python_libraries.txt
  • The grey window is now filled with Python code. Next, click on the ▶️ button or hold ALT + P to start
  • The process may take 30 - 120 seconds and Blender may freeze
  • After the libraries have been installed, a log file will automatically open with the results
  • Verify that all libraries (6) have been installed succesfully
  • Close Blender (the application will likely be frozen)

Preview

Connect Visual Studio Code to Blender

  • Launch Visual Studio Code as administrator and open MAP_EDITOR_ALPHA_v1.py
  • Next, click on the three-line menu icon at the top left corner. Then click on File and then on Add Folder to Workspace...
  • Make sure that the folder you select is MM1-Map-Editor and you click on Add at the bottom right of explorer menu
    • If you get a pop up asking for confirmation, click Trust Workspace & Continue
  • Go back to Visual Studio Code with MAP_EDITOR_ALPHA_v1.py open, and hold CTRL + SHIFT + P.
  • A Command Palette opens. Now type and search for Blender: Start and click it

Preview

  • Next, click on the Blender executable - if available, or click on Choose a new Blender executable... and navigate to e.g.:
    C:\Program Files\Blender Foundation\Blender 4.0 and select the blender.exe
  • Now hold CTRL + SHIFT + P to open the Command Palette again. Type and search for Blender: Start and click it
  • If you see the following message in Visual Studio Code, it means VScode and Blender have succesfully connected:

Preview

Building your Map

  • Note: MAP_EDITOR_ALPHA_v1.py contains a Test City, you may find the polygon data by searching for ===TEST_CITY=== in the script (hold CTRL + F to search)
  • Next, in VScode (with Blender connected), hold CTRL + SHIFT + P and type and search for Blender: Run Script and click it. The script will now start
  • Only and only when you see a message very similar to this, it means the script has fully ran:

Preview

  • Note if the VScode Keybindings installed succesfully, you can invoke Blender: Start by holding Shift + Q, and subsequently Blender: Run Script by holding Shift + W

  • Alternatively, you can build the prepared Map without Blender connected. To do this, open powershell.exe in the main folder, then type:

python MAP_EDITOR_ALPHA_v1.py
  • Tip: type python m and press TAB to autofill the script's name
  • If you are building without Blender connected and have play_game = True in the script, the script will automatically boot the game after it finished processing