Difference between revisions of "KMP3D"

From Custom Mario Kart
Jump to navigation Jump to search
m
m
(35 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
|+ KMP3D
 
|+ KMP3D
 
! Author:
 
! Author:
−
| [[SpacePenguin1804]]
+
| [[zatchi]]
 
|-
 
|-
 
! Platform:
 
! Platform:
−
| [[Google SketchUp]] 6+
+
| [[SketchUp]] 6+
 
|-
 
|-
 
! Programming language:
 
! Programming language:
 
| Ruby
 
| Ruby
 
|-
 
|-
−
! Software Type:
+
! Software type:
 
| SketchUp Plugin
 
| SketchUp Plugin
 
|-
 
|-
−
! File Formats:
+
! File formats:
−
| [[Wiimms SZS Tools]]' textual representation of [[KMP]].
+
| [[KMP]], [[KCL]]
 
|-
 
|-
−
! Current Version:
+
! Version:
−
| v1.0
+
| v6.0
 +
|-
 +
! Date of latest version:
 +
| 2020-09-23
 
|-
 
|-
 
! Download:
 
! Download:
−
| [http://puu.sh/rJgV9/c04c8b484c.zip puush]
+
| [https://github.com/zach-zajack/kmp3d/releases GitHub]
 
|}
 
|}
  
−
[[File:KMP3D-HowTo-EnemyPoint.png|900px]]
+
== Overview ==
 +
'''KMP3D''' is a [[SketchUp]] plugin made by [[zatchi]] that functions as a 3D interface for [[Mario Kart Wii]]'s [[KMP]] files, which deal with coordinate information, such as check points, item routes or respawn point positions. Points are represented using spheres and vectors, depending on the point type.
 +
 
 +
=== Credits ===
 +
* [[Beaglebark413]], for the item box model used as a placeholder for other objects.
  
−
'''KMP3D''' is a plugin for [[Google SketchUp]] 6 and above that turns text placed on the model into 3D points in the model, or lines for checkpoints.
+
== Media ==
 +
[[File:KMP3D-InModel-Preview.png|400px]]
  
−
It can get most KMPs done in around 30-60 minutes, as opposed to hours and hours of work.
+
== Installation ==
 +
'''Note''': If you have a previous version of KMP3D (v3.0 or lower), make sure to disable/uninstall the old extension before installing a newer version. Failure to do so will result in a loading error.
 +
=== For SketchUp 2013-2016 ===
 +
# Download the .rbz file.
 +
# In SketchUp, go to Window -> Preferences -> Extensions -> Install Extension..., and select the file.
 +
=== For SketchUp 2017+ ===
 +
# Download the .rbz file.
 +
# In SketchUp, go to Window -> Extension Manager -> Install Extension..., and select the file.
 +
=== For SketchUp 6-8 ===
 +
# Download the .rbz file.
 +
# Rename the .rbz extension to .zip.
 +
# Extract the contents of the folder into the Plugins folder in SketchUp's Program Files for Windows, or Applications folder for Mac.
  
−
==Tutorial==
+
== Tutorial ==
−
* Install by extracting the zip file to SketchUp's program files, under the folder "Tools".
+
=== Adding and editing points ===
−
* Activate tool by using the new GUI button in the toolbar, and start placing the points where you want.
+
* Activate the tool and click anywhere on the model to place points. In the case of vectors and checkpoints, additional steps are required to correctly place the orientation.
 +
* Editing settings can be done through editing the table. Toggling the selection of points can be done by selecting the ID number on the row for the point.
 +
* Points can also be removed by clicking the "x" on the end of the table.
  
−
===Syntax===
+
=== Group editing ===
−
Once you start placing points, you need to rename them a certain way.
+
* Groups can be edited, selected, and deleted like points under the Group Settings tab.
−
* There are several settings that can be defined. A table below will show what each refers to. Some settings are skipped for convenience, and must be edited in another program. Settings are defaulted as 0, 1, 25, or the previous value, depending on which setting.
+
* Certain settings, such as Next Group(s) (found in [[ENPH]], [[ITPH]], and [[CKPH]]), are comma-separated lists of IDs to the next group.
−
* Each setting is separated by a comma; parentheses and spaces are optional. Anything followed by an asterisk will give an error if not entered.
+
* [[Object]] types are also treated like groups, with each group setting denoting the object's name. You can import custom models to visualize how they would be in-game, so long as it is converted to the SKP format first. However, a library of object SKPs are included and used automatically, depending on the object ID.
−
* Every number (including IDs) is in decimal, not hexadecimal.
 
  
 +
=== Importing and exporting ===
 +
* Go under Plugins (or Extensions, depending on the version) -> KMP3D. This is where you will find the options to import and export KMP files, as well as import [[KCL]] files.
 +
* For importing KMPs, make sure to activate the tool to view the points, as everything is hidden by default.
 +
 +
== Version History ==
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Version
 +
! Date of release
 +
! Information
 
|-
 
|-
−
! Type
+
| v1.0
−
! Name
+
| 2016-09-31
−
! colspan=5 | Settings
+
| First release
 
|-
 
|-
−
| Area (AREA)
+
| v2.0
−
| A
+
| 2017-01-15
−
| Type
+
|
−
| Rotation(xyz)
+
* Remade the entire interface.
−
| Scale(xyz)
+
* Added ability to edit multiple points.
−
| -
+
* Added ability to import objects.
−
| -
+
* Added ability to rotate/scale points with a tool.
 
|-
 
|-
−
| Cannon (CNPT)
+
| [https://www.dropbox.com/s/lhjx16kojggljf9 v3.0]
−
| C
+
| 2017-07-03
−
| Rotation(xyz)
+
|
−
| -
+
* Improved interface.
−
| -
+
* The "Add Point" input box can be changed while in use.
−
| -
+
* Added ability to create cannon points and check points.
−
| -
+
* Fixed export and edit bugs.
 
|-
 
|-
−
| CPU (ENPT)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.0/KMP3D.rbz v4.0]
−
| E
+
| 2019-11-03
−
| Current Group*
+
|
−
| Next Group*
+
* Remade the entire interface.
−
| Scale
+
* Fixed compatibility issues.
−
| Setting 1
 
−
| Setting 2
 
 
|-
 
|-
−
| Objects (GOBJ)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.1/KMP3D.rbz v4.1]
−
| O
+
| 2019-11-06
−
| Object ID*
+
|
−
| Route
+
* Changed default value to 1.0 for the Speed Modifier setting in the Stage Info.
−
| Rotation(xyz)
+
* Fixed WKMPT exporting errors for Stage Info settings.
−
| Scale(xyz)
 
−
| Settings 1...8
 
 
|-
 
|-
−
| Item (ITPT)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.2/KMP3D.rbz v4.2]
−
| I
+
| 2019-11-09
−
| Current Group*
+
|
−
| Next Group*
+
* Added point hybridization feature.
−
| Scale
+
* Model updates when points are combined.
−
| Setting 1
+
* Updated CSS interface.
−
| Setting 2
+
* Added dropdown menus and checkboxes for settings.
 +
* More specific limitations on settings.
 +
* Fixed various bugs for exporting WKMPT files.
 
|-
 
|-
−
| Respawn (JGPT)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.0/KMP3D.rbz v5.0]
−
| R
+
| 2019-11-25
−
| Rotation(xyz)
+
|
−
| -
+
* Added "Import KMP" feature.
−
| -
+
* Can now directly export to KMPs, rather than WKMPT.
−
| -
+
* Now utilizes SketchUp layers to hide points from other sections.
−
| -
 
 
|-
 
|-
−
| Start (KTPT)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.1/KMP3D.rbz v5.1]
−
| S
+
| 2019-12-01
−
| Rotation(xyz)
+
|
−
| -
+
* Added "Import [[KCL]]" feature.
−
| -
+
* Added [[AREA]]s.
−
| -
+
* Fixed various [[GOBJ]] placement errors.
−
| -
+
* Fixed various compatibility issues.
 +
* Improved group editing, allowing whole groups to be selected.
 
|-
 
|-
−
| Routes (POTI)
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.2/KMP3D.rbz v5.2]
−
| P
+
| 2020-02-10
−
| Route Number*
+
| Added read/write capability for [[extended presence flags]] (XPF).
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|}
 
−
 
 
−
For example, if you want Enemy Points in Group 1 with the next Group being 2, it would say "E(1,2)"
 
−
 
 
−
If you want a group leading to a split path, it would be E(1,2&3).
 
−
 
 
−
You can also combine multiple points under one text. For example, if you want "E(1,2)" and "I(1,2)" under the same point, you can have it as "E(1,2)I(1,2)".
 
−
 
 
−
When you are finished with placing down all of the points, go to File -> "Export Coordinates to txt...".
 
−
 
 
−
==Version History==
 
−
{| class="wikitable"
 
 
|-
 
|-
−
! align=left| Version
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.3/KMP3D.rbz v5.3]
−
! align=left| Date of release
+
| 2020-07-01
−
! align=left| Information
+
|
 +
* Cannons now go to the destination point properly.
 +
* Object IDs have been changed to names to reference them.
 +
* Objects can be imported optionally via an SKP.
 
|-
 
|-
−
| [http://puu.sh/rJgV9/c04c8b484c.zip v1.0]
+
| [https://github.com/zach-zajack/kmp3d/releases/download/v6.0/KMP3D.rbz v6.0]
−
| 2015-09-31
+
| 2020-09-23
−
| First release
+
|
 +
* Added [[Cameras]].
 +
* Added library of common objects for importing.
 +
* Added ability to see checkpoint quads and route connections.
 +
* Fixed various group deletion and object export bugs.
 +
* Fixed unnecessary files from being loaded at the start of loading the plugin.
 +
* AREA no longer changes to cylinder when a different type is selected.
 +
* Fixed the importer reading the speed modifier in the reverse endian order.
 
|}
 
|}
  
−
{{User-SpacePenguin1804-Link}}
+
{{Template:Custom Track Tutorial}}
 +
{{User-zatchi-Link}}
 +
[[Category:Software]]
 +
[[Category:Custom Track Tutorial]]

Revision as of 17:56, 23 September 2020

KMP3D
Author: zatchi
Platform: SketchUp 6+
Programming language: Ruby
Software type: SketchUp Plugin
File formats: KMP, KCL
Version: v6.0
Date of latest version: 2020-09-23
Download: GitHub

Overview

KMP3D is a SketchUp plugin made by zatchi that functions as a 3D interface for Mario Kart Wii's KMP files, which deal with coordinate information, such as check points, item routes or respawn point positions. Points are represented using spheres and vectors, depending on the point type.

Credits

  • Beaglebark413, for the item box model used as a placeholder for other objects.

Media

KMP3D-InModel-Preview.png

Installation

Note: If you have a previous version of KMP3D (v3.0 or lower), make sure to disable/uninstall the old extension before installing a newer version. Failure to do so will result in a loading error.

For SketchUp 2013-2016

  1. Download the .rbz file.
  2. In SketchUp, go to Window -> Preferences -> Extensions -> Install Extension..., and select the file.

For SketchUp 2017+

  1. Download the .rbz file.
  2. In SketchUp, go to Window -> Extension Manager -> Install Extension..., and select the file.

For SketchUp 6-8

  1. Download the .rbz file.
  2. Rename the .rbz extension to .zip.
  3. Extract the contents of the folder into the Plugins folder in SketchUp's Program Files for Windows, or Applications folder for Mac.

Tutorial

Adding and editing points

  • Activate the tool and click anywhere on the model to place points. In the case of vectors and checkpoints, additional steps are required to correctly place the orientation.
  • Editing settings can be done through editing the table. Toggling the selection of points can be done by selecting the ID number on the row for the point.
  • Points can also be removed by clicking the "x" on the end of the table.

Group editing

  • Groups can be edited, selected, and deleted like points under the Group Settings tab.
  • Certain settings, such as Next Group(s) (found in ENPH, ITPH, and CKPH), are comma-separated lists of IDs to the next group.
  • Object types are also treated like groups, with each group setting denoting the object's name. You can import custom models to visualize how they would be in-game, so long as it is converted to the SKP format first. However, a library of object SKPs are included and used automatically, depending on the object ID.

Importing and exporting

  • Go under Plugins (or Extensions, depending on the version) -> KMP3D. This is where you will find the options to import and export KMP files, as well as import KCL files.
  • For importing KMPs, make sure to activate the tool to view the points, as everything is hidden by default.

Version History

Version Date of release Information
v1.0 2016-09-31 First release
v2.0 2017-01-15
  • Remade the entire interface.
  • Added ability to edit multiple points.
  • Added ability to import objects.
  • Added ability to rotate/scale points with a tool.
v3.0 2017-07-03
  • Improved interface.
  • The "Add Point" input box can be changed while in use.
  • Added ability to create cannon points and check points.
  • Fixed export and edit bugs.
v4.0 2019-11-03
  • Remade the entire interface.
  • Fixed compatibility issues.
v4.1 2019-11-06
  • Changed default value to 1.0 for the Speed Modifier setting in the Stage Info.
  • Fixed WKMPT exporting errors for Stage Info settings.
v4.2 2019-11-09
  • Added point hybridization feature.
  • Model updates when points are combined.
  • Updated CSS interface.
  • Added dropdown menus and checkboxes for settings.
  • More specific limitations on settings.
  • Fixed various bugs for exporting WKMPT files.
v5.0 2019-11-25
  • Added "Import KMP" feature.
  • Can now directly export to KMPs, rather than WKMPT.
  • Now utilizes SketchUp layers to hide points from other sections.
v5.1 2019-12-01
  • Added "Import KCL" feature.
  • Added AREAs.
  • Fixed various GOBJ placement errors.
  • Fixed various compatibility issues.
  • Improved group editing, allowing whole groups to be selected.
v5.2 2020-02-10 Added read/write capability for extended presence flags (XPF).
v5.3 2020-07-01
  • Cannons now go to the destination point properly.
  • Object IDs have been changed to names to reference them.
  • Objects can be imported optionally via an SKP.
v6.0 2020-09-23
  • Added Cameras.
  • Added library of common objects for importing.
  • Added ability to see checkpoint quads and route connections.
  • Fixed various group deletion and object export bugs.
  • Fixed unnecessary files from being loaded at the start of loading the plugin.
  • AREA no longer changes to cylinder when a different type is selected.
  • Fixed the importer reading the speed modifier in the reverse endian order.
Custom Track Tutorials

Main Tutorials
Introduction – Textures – Scale – Modeling ⇒ Using Blender – BRRES: CTools
BRRES: BrawlBox – BRRES: RiiStudio – Minimap – Solidity – KCL: Wiimms Tools – KMP Editing
Object Editing – Cameras – Cannons – Post-effects – Videos

Battle Arenas
Battle Arenas – Enemy routes in battle arenas ⇒ Using Wiimm's Tools – Coins

Misc. Tutorials
Getting Files – BrawlBox Tricks – Animations – Shadows – Mipmaps
Custom Effects – Moving Terrain – Music – Ports – Paint Remakes – Tutorial Archive
Extended presence flags: Track Tutorial – LE-CODE Track FAQ

Testing and Reviewing
Testing a Track – Visual Review – Track Transformation – Fixing Errors

Software
3D Tools – BrawlBox – CTools Pack – KMP3D – KMP Cloud – KMP Modifier
Lorenzi's KMP Editor – MagicY – Material Tool – Post-Effect Editor – Wiimms SZS Tools – Wiimm's Tool Manager

Other
KMP Objects – Custom Objects – Model Database – Tutorial Archive

By the same author: zatchi

Custom Tracks:
Drip-Drop Cavern – Hidden Cove – Sea Stadium – Forest of Magic – Adrastea Station – Haunted Library

Software:
KMP3D – Material/Shader Replace

Retrieved from "https://wiki.tockdom.com/w/index.php?title=KMP3D&oldid=217852"