Difference between revisions of "KMP3D"

From Custom Mario Kart
Jump to navigation Jump to search
m
m
(22 intermediate revisions by 4 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]]'s textual representation of [[KMP]].
+
| [[KMP]], [[KCL]]
 
|-
 
|-
−
! Current Version:
+
! Version:
−
| v3.0
+
| v6.0
 +
|-
 +
! Date of latest version:
 +
| 2020-09-23
 
|-
 
|-
 
! Download:
 
! Download:
−
| [https://www.dropbox.com/s/lhjx16kojggljf9/KMP3D.zip Dropbox]
+
| [https://github.com/zach-zajack/kmp3d/releases GitHub]
 
|}
 
|}
  
−
[[File:KMP3D-InModel-Preview.png|800px]]
+
== 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.
  
−
== About ==
+
=== Credits ===
−
'''KMP3D''' is a plugin for [[Google SketchUp]] version 6 and above that is a 3D interface for [[KMP]] files. It uses objects like spheres and arrows to represent points, which may decrease the time it takes to create a [[KMP]].
+
* [[Beaglebark413]], for the item box model used as a placeholder for other objects.
  
−
=== Open Source Policy ===
+
== Media ==
−
If you're interested in modifying the code for KMP3D, please contact the author [[SpacePenguin1804]] before updating to this page. The source code is directly in the download, ready for modification.
+
[[File:KMP3D-InModel-Preview.png|400px]]
  
 
== Installation ==
 
== Installation ==
−
* Install by extracting the ZIP file to SketchUp's program files (Program Files on Windows, Applications on Mac), under the folder "ShippedExtensions", "Plugins", "Tools", or something similar, depending on the version you're using.
+
'''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.
−
* Two buttons should appear: One to add points, one to edit points.
+
=== For SketchUp 2013-2016 ===
−
* Tutorial for KMP3D usage is below.
+
# Download the .rbz file.
−
 
+
# In SketchUp, go to Window -> Preferences -> Extensions -> Install Extension..., and select the file.
−
== Arguments Table ==
+
=== For SketchUp 2017+ ===
−
All arguments use decimal (as opposed to hexadecimal), including Object IDs.
+
# Download the .rbz file.
−
 
+
# In SketchUp, go to Window -> Extension Manager -> Install Extension..., and select the file.
−
=== Table ===
+
=== For SketchUp 6-8 ===
−
{| class="wikitable"
+
# Download the .rbz file.
−
|-
+
# Rename the .rbz extension to .zip.
−
! Point Name
+
# Extract the contents of the folder into the Plugins folder in SketchUp's Program Files for Windows, or Applications folder for Mac.
−
! colspan=10 | Settings (In Order)
 
−
|-
 
−
| Checkpoint (CKPT)
 
−
| Current Group*
 
−
| Next Group*
 
−
| Key Type (0 = not key, 1 = key)
 
−
| Respawn ID
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| CNPT (CNPT)
 
−
| Shoot Effect
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| CPU (ENPT)
 
−
| Current Group*
 
−
| Next Group*
 
−
| Scale
 
−
| Setting 1
 
−
| Setting 2
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| Objects (GOBJ)
 
−
| Object ID*
 
−
| Route
 
−
| Setting 1
 
−
| Setting 2
 
−
| Setting 3
 
−
| Setting 4
 
−
| Setting 5
 
−
| Setting 6
 
−
| Setting 7
 
−
| Setting 8
 
−
|-
 
−
| Item (ITPT)
 
−
| Current Group*
 
−
| Next Group*
 
−
| Scale
 
−
| Setting 1
 
−
| Setting 2
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| Respawn (JGPT)
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| Start (KTPT)
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|-
 
−
| Routes (POTI)
 
−
| Route  ID Number*
 
−
| Smooth Motion (0 or 1)
 
−
| Rotation Type (0 or 1)
 
−
| Speed
 
−
| Setting 1
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
| -
 
−
|}
 
−
 
 
−
=== Table Usage and Syntax ===
 
−
* Anything followed by an asterisk is a required setting, and will result in an error when exporting otherwise.
 
−
* For example, if you want Enemy Points in Group 1 with the next being Group 2, it would say "ENPT(1,2)"
 
−
* If you want a group leading to a split path, it would be ENPT(1,2&3).
 
−
* To rotate points, you can use the the rotate tool that comes with SketchUp. This is the same with scaling for GOBJ and CKPT. Scale is a setting for ENPT and ITPT, however.
 
−
* You can also combine multiple points under one text. For example, if you want "ENPT(1,2)" and "ITPT(1,2)" under the same point, you can have it as "ENPT(1,2) ITPT(1,2)".
 
  
 
== Tutorial ==
 
== Tutorial ==
−
=== Adding Points ===
+
=== Adding and editing points ===
−
* You can add points by clicking the first of the two new icons: the arrow with the plus sign. You can add points with the settings you specify in the dialog that is opened.
+
* 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.
−
* Each point type has varying settings, and can be found in the Arguments Table listed above, and more info is listed below the table.
+
* 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.
−
* You can add most points by simply clicking in the area you want them to be placed, with a few exceptions:
+
* Points can also be removed by clicking the "x" on the end of the table.
−
'''CKPT''': First and second clicks are the start/end of the checkpoint line. The third click specifies which way the checkpoint arrow is facing on the line.
 
−
 
 
−
'''CNPT''': The first click is the starting position of the cannon, whereas the ending point is the ending of the cannon. The y rotation is automatically calculated.
 
−
* If you want to change the settings for the next point you will add, simply change what is in the dialog.
 
−
 
 
−
=== Editing Points ===
 
−
* If you want to edit pre-existing points, you can highlight them and then press the second of the two icons: the arrow with the gear.
 
−
* The dialog that pops up will rename all of the points selected, so be careful. If nothing is entered, the points will be deleted.
 
−
* The points will automatically change to the correct shape when entered.
 
  
−
=== Objects ===
+
=== Group editing ===
−
* If you use the GOBJ on a point, KMP3D can automatically select a model to use.
+
* Groups can be edited, selected, and deleted like points under the Group Settings tab.
−
# Choose an object file and convert it to an SKP. (See [[Importing 3D models]]).
+
* Certain settings, such as Next Group(s) (found in [[ENPH]], [[ITPH]], and [[CKPH]]), are comma-separated lists of IDs to the next group.
−
# Save the file, and put it under the folder you extracted KMP3D -> KMP3D -> Data -> Models -> Objects.
+
* [[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.
−
# Open the file OBJIndex.txt located in the folder you moved the SKP file to.
 
−
# Add a line to OBJIndex.txt, that has the ID used, put into decimal and with three digits (ID 1 would be 001). Then, add the name of the skp file.
 
−
=== Exporting Points ===
 
−
To export, simply go under Plugins (or Extensions, depending on version) -> KMP3D -> Export.
 
−
# Select a place to save the file to.
 
−
# Select how many laps the track will be.
 
−
# In order to convert the newly created txt file to a KMP, you will have to use [[Wiimms SZS Tools]].
 
−
# Everything will then be exported in the order placed down.
 
  
−
=== Importing Points ===
+
=== Importing and exporting ===
−
To import , simply go under Plugins (or Extensions, depending on version) -> KMP3D -> Import.
+
* 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.
−
# Select the txt file you want to import.
+
* For importing KMPs, make sure to activate the tool to view the points, as everything is hidden by default.
−
# If you only have a KMP, you will have to use [[Wiimms SZS Tools]] to convert it from a KMP to a txt file.
 
−
# The program will then ask what point types you want to import. For example, if you wanted to import the ENPTs, JGPTs, GOBJs, and CKPTs, you would type "ENPT JGPT GOBJ CKPT".
 
−
# You are now free to edit the points.
 
  
 
== Version History ==
 
== Version History ==
 
{| class="wikitable"
 
{| class="wikitable"
−
|-
+
! Version
−
! align=left| Version
+
! Date of release
−
! align=left| Date of release
+
! Information
−
! align=left| Information
 
 
|-
 
|-
 
| v1.0
 
| v1.0
Line 197: Line 75:
 
| v2.0
 
| v2.0
 
| 2017-01-15
 
| 2017-01-15
−
| Entire interface redone.
+
|
−
* Ability to edit multiple points
+
* Remade the entire interface.
−
* Ability to import objects
+
* Added ability to edit multiple points.
−
* Ability to rotate/scale points with a tool.
+
* Added ability to import objects.
 +
* Added ability to rotate/scale points with a tool.
 
|-
 
|-
−
| v3.0
+
| [https://www.dropbox.com/s/lhjx16kojggljf9 v3.0]
 
| 2017-07-03
 
| 2017-07-03
−
| Improved interface.
+
|
−
* Ability to import points from textual representation of a [[KMP]].
+
* Improved interface.
 
* The "Add Point" input box can be changed while in use.
 
* The "Add Point" input box can be changed while in use.
−
* Cannon points can be added.
+
* Added ability to create cannon points and check points.
−
* Checkpoints can be added.
+
* Fixed export and edit bugs.
−
* Export and edit bugs fixed.
+
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.0/KMP3D.rbz v4.0]
 +
| 2019-11-03
 +
|
 +
* Remade the entire interface.
 +
* Fixed compatibility issues.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.1/KMP3D.rbz 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.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v4.2/KMP3D.rbz 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.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.0/KMP3D.rbz 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.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.1/KMP3D.rbz v5.1]
 +
| 2019-12-01
 +
|
 +
* 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.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.2/KMP3D.rbz v5.2]
 +
| 2020-02-10
 +
| Added read/write capability for [[extended presence flags]] (XPF).
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v5.3/KMP3D.rbz 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.
 +
|-
 +
| [https://github.com/zach-zajack/kmp3d/releases/download/v6.0/KMP3D.rbz 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.
 
|}
 
|}
  
−
== Future Plans ==
+
{{Template:Custom Track Tutorial}}
−
These may or may not be added, but it will be attempted in future updates of the program.
+
{{User-zatchi-Link}}
−
* Add cameras, and a way to play them in SketchUp.
 
−
* Add AREAs.
 
−
* Have an interface capable of displaying a 2D map of the points and being able to reorder them.
 
−
* Add a wildcard option for the Edit dialog.
 
−
* Better interface for the addition of objects.
 
−
 
 
−
{{User-SpacePenguin1804-Link}}
 
 
[[Category:Software]]
 
[[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"