Difference between revisions of "KMP3D"

From Custom Mario Kart
Jump to navigation Jump to search
m (update for consistency with username change)
(Update KMP3D to version 1.0.0)
Line 17: Line 17:
 
|-
 
|-
 
! Current Version:
 
! Current Version:
−
| v3.0
+
| v1.0.0
 
|-
 
|-
 
! Download:
 
! Download:
−
| [https://www.dropbox.com/s/lhjx16kojggljf9/KMP3D.zip Dropbox]
+
| [https://github.com/zach-zajack/kmp3d/releases/tag/v1.0.0 GitHub]
 
|}
 
|}
−
 
−
[[File:KMP3D-InModel-Preview.png|400px]]
 
  
 
== About ==
 
== About ==
−
'''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]].
+
'''KMP3D''' is a [[Google SketchUp]] plugin that functions as a 3D interface for Mario Kart Wii's [[KMP]] files, which deal with coordinate information, such as checkpoints, item routes, or respawn positions. Points are represented using spheres and vectors, depending on the point type.
  
−
=== Open Source Policy ===
+
=== Credits ===
−
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.
+
The Itembox model used as a placeholder for other objects was created by [[Beaglebark413]].
  
 
== 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.
+
=== For SketchUp 2013-2016 ===
−
* Two buttons should appear: One to add points, one to edit points.
+
# Download the .rbz file.
−
* Tutorial for KMP3D usage is below.
+
# In SketchUp, go to Window -> Preferences -> Extensions -> Install Extension..., and select the file.
−
 
+
=== For SketchUp 2017+ ===
−
== Arguments Table ==
+
# Download the .rbz file.
−
All arguments use decimal (as opposed to hexadecimal), including Object IDs.
+
# In SketchUp, go to Window -> Extension Manager -> Install Extension..., and select the file.
−
 
+
=== For SketchUp 6-8 ===
−
=== Table ===
+
# Download the .rbz file.
−
{| class="wikitable"
+
# 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.
−
! Point Name
 
−
! 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 combining points ===
−
* You can add points by clicking the first of the two new icons.
+
* Points can be added to the model by pointing and clicking in the desired area. If a given type of point is a vector, the second click determines what direction the point is facing in the horizontal (x-z) plane.
−
* Each point type has varying settings, and can be found in the Arguments Table listed above, and more info is listed below the table.
+
* Points can similarly be combined, if points are different types. This can be done by hovering over a point of a different type and clicking on it. '''Note:''' the order of the point for either type will be at the time the former point was placed.
−
* You can add most points by simply clicking in the area you want them to be placed, with a few exceptions:
 
−
'''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 ===
+
=== Editing points ===
−
* If you want to edit pre-existing points, you can highlight them and then press the second of the two icons.
+
* Points can be translated, rotated, and scaled using any SketchUp tool or plugin. When exporting, KMP3D will automatically adjust for these changes.
−
* The dialog that pops up will rename all of the points selected, so be careful. If nothing is entered, the points will be deleted.
+
* Settings can be edited through the use of input tables. Settings mostly follow [[KMP Cloud]]'s naming and organization.
−
* The points will automatically change to the correct shape when entered.
 
  
−
=== Objects ===
+
=== Selecting points ===
−
* If you use the GOBJ on a point, KMP3D can automatically select a model to use.
+
* Points can be selected and deselected either by clicking on the points in SketchUp, or in the input table's ID section. From here, any normal SketchUp operation can be done on them.
−
# Choose an object file and convert it to an SKP. (See [[Importing 3D models]]).
 
−
# Save the file, and put it under the folder you extracted KMP3D -> KMP3D -> Data -> Models -> Objects.
 
−
# 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 ===
+
=== Exporting KMP3D points ===
−
To import, simply go under Plugins (or Extensions, depending on version) -> KMP3D -> Import.
+
* Exporting KMP3D points can be done under Plugins -> KMP3D -> Export WKMPT...
−
# Select the txt file you want to import.
+
* Files can be converted through downloading and installing [[Wiimms SZS Tools]], and using the <code>wkmpt encode</code> command.
−
# 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 ==
Line 199: Line 72:
 
| Entire interface redone.
 
| Entire interface redone.
 
* Ability to edit multiple points
 
* Ability to edit multiple points
−
* Ability to import objects
+
* Ability to import objects.
 
* Ability to rotate/scale points with a tool.
 
* Ability to rotate/scale points with a tool.
 
|-
 
|-
Line 205: Line 78:
 
| 2017-07-03
 
| 2017-07-03
 
| Improved interface.
 
| Improved interface.
−
* Ability to import points from textual representation of a [[KMP]].
 
 
* 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.
 
* Cannon points can be added.
 
* Checkpoints can be added.
 
* Checkpoints can be added.
 
* Export and edit bugs fixed.
 
* Export and edit bugs fixed.
 +
|-
 +
| v1.0.0
 +
| 2019-11-03
 +
| Remade from scratch.
 +
* Entire interface redone.
 +
* Compatibility issues fixed.
 
|}
 
|}
  
 
== Future Plans ==
 
== Future Plans ==
−
These may or may not be added, but it will be attempted in future updates of the program.
+
* Replace textboxes with other input types, e.g. checkboxes or dropdowns
−
* Add cameras, and a way to play them in SketchUp.
+
* Ability to import from WKMPT files
−
* Add AREAs.
+
* Comprehensive database for GOBJ points and their settings
−
* Have an interface capable of displaying a 2D map of the points and being able to reorder them.
+
* CAME and AREA support
−
* Add a wildcard option for the Edit dialog.
+
* Ability to reorder points
−
* Better interface for the addition of objects.
+
* Preview of paths
 +
* Updated models
 +
* Direct KMP exporting
  
 
{{User-Zatchi-Link}}
 
{{User-Zatchi-Link}}
 
[[Category:Software]]
 
[[Category:Software]]

Revision as of 20:05, 3 November 2019

KMP3D
Author: zatchi
Platform: Google SketchUp 6+
Programming language: Ruby
Software Type: SketchUp Plugin
File Formats: Wiimms SZS Tools's textual representation of KMP.
Current Version: v1.0.0
Download: GitHub

About

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

Credits

The Itembox model used as a placeholder for other objects was created by Beaglebark413.

Installation

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 combining points

  • Points can be added to the model by pointing and clicking in the desired area. If a given type of point is a vector, the second click determines what direction the point is facing in the horizontal (x-z) plane.
  • Points can similarly be combined, if points are different types. This can be done by hovering over a point of a different type and clicking on it. Note: the order of the point for either type will be at the time the former point was placed.

Editing points

  • Points can be translated, rotated, and scaled using any SketchUp tool or plugin. When exporting, KMP3D will automatically adjust for these changes.
  • Settings can be edited through the use of input tables. Settings mostly follow KMP Cloud's naming and organization.

Selecting points

  • Points can be selected and deselected either by clicking on the points in SketchUp, or in the input table's ID section. From here, any normal SketchUp operation can be done on them.

Exporting KMP3D points

  • Exporting KMP3D points can be done under Plugins -> KMP3D -> Export WKMPT...
  • Files can be converted through downloading and installing Wiimms SZS Tools, and using the wkmpt encode command.

Version History

Version Date of release Information
v1.0 2016-09-31 First release
v2.0 2017-01-15 Entire interface redone.
  • Ability to edit multiple points
  • Ability to import objects.
  • 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.
  • Cannon points can be added.
  • Checkpoints can be added.
  • Export and edit bugs fixed.
v1.0.0 2019-11-03 Remade from scratch.
  • Entire interface redone.
  • Compatibility issues fixed.

Future Plans

  • Replace textboxes with other input types, e.g. checkboxes or dropdowns
  • Ability to import from WKMPT files
  • Comprehensive database for GOBJ points and their settings
  • CAME and AREA support
  • Ability to reorder points
  • Preview of paths
  • Updated models
  • Direct KMP exporting

Template:User-Zatchi-Link

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