Examples Cookbook

Examples Cookbook

This page gives practical, repeatable examples for common addon tasks.

Example 1: Basic Map Edit and Export

Goal: Move terrain pieces and export.

1. Open Project Manager.
2. Load the map variant.
3. Select target meshes and edit in Blender.
4. Export mapgeo to project.
5. Start game and verify result.

Example 2: Create Custom Bucket Grids After Geometry Changes

Goal: Keep bucket data aligned with edited geometry.

1. Edit map geometry.
2. In Bucket Grid section, run Clean All Bucket Grids.
3. Run Create Custom Bucket Grid.
4. Confirm bucket grid collections were generated.
5. Export mapgeo.
6. Validate in game.

Example 3: Material Texture Swap

Goal: Replace a material texture and export.

1. Open Material Editor.
2. Select target material.
3. Change diffuse sampler texture path.
4. Refresh preview.
5. Export materials or full project.

Example 4: Particle Placement Update

Goal: Move existing particles to match scene layout.

1. Import map with particles.
2. Select particle proxy objects.
3. Move/rotate to desired positions.
4. Export particle-related data.
5. Verify runtime placement.

Example 5: Map Object Position Adjustment

Goal: Shift map props and keep stable links.

1. Import map objects.
2. Move target empties.
3. Do not rename stable identity objects.
4. Export project data.

Example 6: Run Integrity Checker Before Export

Goal: Catch data issues early.

1. Open Project Integrity section.
2. Click Check Project.
3. Filter by Errors.
4. Fix missing paths and invalid links.
5. Re-run until clean.

Example 7: Lightgrid Bake Workflow

Goal: Bake and export lightgrid for modded map.

1. Create Lightgrid.
2. Mark occluder and ignore meshes where needed.
3. Bake Lightgrid.
4. Visualize coverage.
5. Export Lightgrid file.

Example 8: Lightmap Bake Workflow

Goal: Bake lightmaps for selected meshes.

1. Prepare lightmap setup.
2. Create lightmap UVs.
3. Assign lightmap texture settings.
4. Bake.
5. Export lightmaps.

Example 9: Update Character Bin Files by Patch

Goal: Migrate character bins to newer patch data.

1. Open Character Bin Updater panel.
2. Scan project for bins.
3. Select old patch and target patch.
4. Run update.
5. Confirm status and backups.

Example 10: Compare Original vs Exported Mapgeo in JSON

Goal: Diagnose differences quickly.

1. Export original mapgeo as JSON.
2. Export modified mapgeo as JSON.
3. Compare mesh counts, bucket grids, and hashes.
4. Apply fixes and re-export.

Example 11: External Mesh Import Into Mapgeo Workflow

Goal: Add custom geometry and make it export-safe.

1. Import external OBJ/FBX.
2. Run setup operator to assign mapgeo properties.
3. Assign material and layer flags.
4. Rebuild bucket grids.
5. Export and test.

Example 12: PREY Round-Trip Editing

Goal: Use readable split files for safer edits.

1. Convert materials binary to prey files.
2. Edit map and VFX prey files.
3. Save All to prey.
4. Rebuild binary.
5. Test in game.