WIP: Creating an Asset from start to finish.

Enriched Uranium · September 27, 2014

:confused:Creating an Asset from start to finish.

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

EDITED: OK, just to have a little update spot at the top :
Here is where I am at.
Lesson one still needs to be updated to more current information.
I have had a chance to look at Blender and I have finished my JGS version of 3DS "Animated Battle Scene" tutorial, SKILL LEVEL: BEGINNER.
I have had a chance to look over a lot of the 3ds Tutorial stuff now and I don't think I will be working in 3dsMax, at least not much from now on.
What I have done has made Blender make a lot more sense to me and i feel comfortable enough with it to start using it.
I am now working on some Blender Tutorials and will make at least one tutorial for blender b4 moving back to updating Lesson One and adding these drawing tutorials to the top, so we can actually get started MODDING (intending on placing them in the Selecting your program box)

Thanks to everyone!

Originally Posted by Claw

If your aim is to repackage the wiki information, please be very clear about that. It can be insulting to some people when they see their works copied and pasted elsewhere. Also, the whole point of the wiki is for users to be able to edit and update information along the way. Feel free to get an account and update links/info up there. The better the info on the wiki, the more useful it is.

Cheers,

~Claw

My aim is to become proficient in Visual C++ and if this helps other GREAT. Im not trying to repackage anything, Im just trying to learn this. But, I guess I am inadvertently "repackaging" it AND fixing dead or broken links. This could be used to update the links in KSP WiKi when i am done, if i continue.

Im hoping a few people will join me learning because 2 minds are better than one. I am retired and learning this for fun. Please do not be offended if you see your work here! Your work is VERY VALUABLE!!!! And I have sited links to ALL the reference material because i want to make sure your recognized for your work. After all, I could not have learned what I have without it. If I need to site extra recognition, I don't have a problem with that! I wouldn't mind if anyone whos work i am using to learn, follows along and helps me and who ever might join this thread.

nice to meet ya Claw

My intention is NOT to offend anyone.

That is why I said from the start that 99% of this is NOT my work, right now. I will be adding, at least one example of my own.

When I am reading to learn I take notes, I have to, and i do it in an outline. I realized that I was organizing all of this info and making it sequence, plus I have found links to relevant information where I was finding dead links.

I just got so frustrated with KSP wiki breaking my concentration every 2 min's with a dead or broken link. When everything is a clicking and you hit a dead link... it breaks the &^^%% out of my concentration, and its hard to get going again, I don't know about you.

If you guys don't want me to post this, fine, I won't. but i already have it a lot done and when I finish with my first asset this could be a great tutorial... Plus I might get some help and help others learn.

I really love this game, so much so that i am learning this. Im FREE HELP USE ME LOL but seriously, I have a lot of time on my hands and Im not afraid to say no if I don't want to do something.

EDIT 2 PLEASE READ THE ENTIRE POST B4 YOU ask questions or comment, your answer may already be here!

------------------------------------------------------------------------------------------------------------------------------------------------------------

Ok, I'm an old guy here and I know a couple OLD computer languages but Im Kinda new to Visual C++

I am self taught and by no means self proficient in C yet. I am learning and that is the point of this Thread.

I did some mods with a few friends on a game when i was in college but haven't messed with C much since then.

I went to school for Computer Information Systems (basically system annalist... Cobol stuff) CADD and Mechanical ENGR/Design,

and minored in psychology.... Wouldn't ya know I ended up working in a hospital and not on computers, much.

Well, Im retired now, both my kids are about grown and gone, Im single, I love this game lol, I want to become proficient

with C++ and all I do now is play, its kinda nice. :kiss: :cool:

Reason # 2 that I am posting this Thread

I tend to be kinda unorganized... looking, but I can find everything in my madness:huh: lol

The information is out there and available but its freaking everywhere and not all the links work.

When the links don't work it breaks my concentration and I lose my place, then start making mistakes and break my game not knowing what the #@%# I did wrong. lol:P

My Plan is to break this down to single entry's, kinda like steps in creating your asset.

I have not written MOST of this but i have reorganized ALL of it AND added Links (where I could, of the broken ones)

I have a lot of time on my hands right now so I have been working on this almost everyday.

I am not going to go back to everything that brought me to this point, unless I need a refresher at some point.

Anyone is welcome to join in... or just follow along.

To keep my time on this forum to a minim, so I can keep learning, I will only check this once per day UNTIL I get to the end of creating my first asset.

So when this is finished, the last post will be up todate and should contain EVERYTHING you need to build your Asset.

This is NOT going to be finished over night but i will be moving fast, try to keep up if your doing this with me.

New posts will be added when I get tired and stop for the day.

In the post I will note where I stopped and there will be info after that so i know what i didn't get to so I can remember where i left off,

my memory sucks, I gotta take notes, or I WONT remember.

If I forget something don't get mad cuz I forgot, remember. lol

Anyway, this next post will be the Start. Day one Outline ONE.

Im tired and ready to quit for the day, after I get this posted.

Thanks in advance for anyone who would like to join me learning

or help US learn.

This is my Kerbin/Earth conversion. Its going to be a future Earth, Hot and Dry. It is a work in progress, I just started it last night.

Have a GREAT Night SQUAD, AND THANK YOU ALL for such an awesome game!

Edited October 6, 2014 by Enriched Uranium
Just updating 'where Im at'

Enriched Uranium · September 27, 2014

Edited *draft 2* Lesson ONE

First I would like to say that This is my second draft. I am CURRENTLY taking a break, You may read but know this is a long way from finished.

If you do read this and see points that are obviously wrong and i need to find updated info, feel free to point it out. If nobody else has. :sticktongue:

My plan is to be the first person to use this tutorial. So when I am finished... if you learn, close to the way I do, you will be able to follow

this, step by step until your mod is finished and working. (That is my hope for the mod I will be creating as my example.)

At this point, I am planning for my mod to be a small, modular, Beer/Soda cooler for Jeb when he is out on a moon rover somewhere.

I don't know if Ill be able to make it follow the rover around or not but that is what i am hoping. As I said, it will be modular so you will be able

to build it how you would like, in game, but I hope to make it look... somewhat like R2D2 lol... It may be more work than i know what im getting

myself into but I would also like for Jeb to be able to use it as a UAV and have the option of giving it the ability to fly.

(kinda like the UAV's infantry use to get a better view of... the battle field.)

Something like this but much much smaller

Anyway, Here it is:


[URL="http://wiki.kerbalspaceprogram.com/wiki/Main_Page"]SPECIAL THANKS TO
  [/URL][URL="http://wiki.kerbalspaceprogram.com/w/index.php?title=User:Darrknox&action=edit&redlink=1"]Darrknox[/URL][URL="http://wiki.kerbalspaceprogram.com/wiki/Making_an_asset_from_start_to_finish"] & [/URL][URL="http://wiki.kerbalspaceprogram.com/w/index.php?title=User:Killerhurtz&action=edit&redlink=1"]Killerhurtz 
 [/URL][URL="http://wiki.kerbalspaceprogram.com/wiki/Making_an_asset_from_start_to_finish"]FOR THE WORK THEY HAVE CONTRIBUTED TO KSP WIKI[/URL]

[URL="http://forum.kerbalspaceprogram.com/threads/7529-Plugin-Posting-Rules-And-Official-Documentation?p=156430&viewfull=1#post156430"]This is a special Thanks to Mu for posting his hard work, and allowing us to use it so we can learn this stuff.
Awesome work Mu, i couldn't have even started this without the work you have already put into this, i hope
you like how this turns out.[/URL]

Creating a Mod

Step 1 - Choosing your programs


    A list of 3d software with links to download goes here - plus a conversation about selecting your programs with a tutorial using 3ds and one using Blender.

Step 2 - Understanding Folder Design

First of all, there's your main folder.


You can name this folder anything you would like to, just make sure there's no underscore. 

This Folder has what i call a VariableName, simply meaning you
can name it what ever you would like to. HOWEVER, you want to keep your
VariableName folders as short as you can yet allow youself to easily identify it.
DO NOT USE AN UNDERSCORE ON THIS FOLDER!

For my example, My main folder will be named JGSMods

Keep those names short and identifiable, by you.


When you test your mod and extract it into your game, your folder names will 
work fine but you do not know the install location of the final user.

If the User is using, for example, a Steam version of KSP, it could be located as deep
into their directory as:

c:\Program Files (x86)\Steam\SteamApps\common\Kerbal Space Program\GameData\VariableName

So, you can see how, if your mods directory structer goes very deep, the end user might end up
with an error during extraction that the folder name is too long and anything that was in those
folders will not be extracted into their game. Then your mod will not work for them and you might hear about it.
There is an easy work around for the user, if they know it, but they will never get it working if they don't know it.

Did you know that you can trace from Christopher Columbus to Nikola Tesla with an EGG!

If I told you that you could place an egg, standing on end, on a table and it would stay like that...

until it rotted, you could try all day and never succeed until I tell you how to do it... Or if you

already know about the story of Christopher Columbus, Nikola Tesla, and the egg. I would let you try

until you gave up, then simply stand the egg on end, press down until the egg cracks (but not let the inner sack break)

and the egg will stand until it rots, or you throw it away... or eat it lol

The point of comparing these two stories is to show that there can be more than one acceptable solution,

to the goal of your code.

Christoper Columbus Egg Story Wiki

Prof. Dr. J. W. Kolar's 'TeslaÃ¢â‚¬â„¢s Egg of Columbus:...'

Steam Version Users

[Steam Version NOTE]
EDITED: If you have the Steam Version, I recommend trying to get a refund and buying it 
             Threw the KSP store. I am done with Steam! Im in the process of removing Steam 
             and, it looks like I will have to re-purchase some software I bought threw them.

I had the Steam version of the game, and i ran it in Steam most of the time.
 If you have the Steam version of KSP, you do not have to run it from the Steam Folder.
I have found that sometimes the game will run from c:\(your folder name)\ Kerbal Space Program
when you have problems with a mod and the game crashes from the Steam install location.

I am still not sure what causes the crash but i think it is the Steam Overlay (when your 
mods messing up and your game is unstable because of it). So if using Steam, and your game crashs,
try running it from a different location so you can get to debugging, might save you some time. Or you
can try to get a refund and buy it from the KSP store.

2. Allowed sub-folders


            a. Textures    - Your texture must be in the folder labeled Textures. (a drawing for the game) 
                                  That "s" is important, tiny things like that will corrupt your part.

            b. Resources  - your model mesh (usually a .dae) Your part.DAE is simply your exported mesh and
                                   its collision

            c. Parts          - Part.CFG is your text config file correlating all of your names (case sensitive) so the
                                   game can run from the locations. 

            d. sounds       - If you wish to include sounds, an additional folder named "sounds" should be created.

Step 3 - Creating The Asset (Asset being the modifcation, or mod, that you are making in the game)

A. Some things to keep in your mind while creating an asset(s);

Triscount, Unwrapping, Textures, and Boundingbox (Collision mesh)


        1. Triscount 
            a. Tris are what every model is made out of in any 3D game to date.
                No matter what program you use a game engine will split your model into the smallest geometric
                shape; a triangle. This should be your unit of measure when judging the complexity of a model.
                The vanilla, or stock parts, default pieces issued with the game are the best judge for what the 
                KSP is built for, and the mod packs on the forums are the best judge for what the limit is. 

            b. The triscount for most of the stock pieces are around 300 tris for small pieces like the
                TT-38K Radial Decoupler, and 2000 tris for pieces like the LV-T30 Liquid Fuel Engine 
                and a general 1000 tris count for the boosters, fuel tanks, and pods.

            c. When assessing your tris count it's necessarily to keep in mind you want an optimized number.
               You want to have the lowest tricount possible, without taking away from the integrity of the
               model's silhouette.

            d. When modeling one can get lost in adding detail, and whilst finishing up its important to give 
                your model a twice over. Don't feel bad if you aren't quite satisfied with your model:
                remember that what gives a soul to the model really is the texture.

Step 4 - Creating The Collision Mesh

2. Boundingbox (Collision mesh)



            a. This will be the object KSP uses to calculate collisions and physics with respect to your part.

                It is simply a matter of creating another separate mesh in the program you are using that has a
                reasonably close resemblance to the object you have made. It must be convex, and must NOT
                be parented/joined to the main mesh.

             b. This collision mesh is to be called -

                 "node_collider"

               Once it is named, add one empty material to it, and you are set to go.

Step 5 - Unwrapping Your Asset


 - This step varies from program to program. Refer to your program's documentation to make sure. 

        1. Essentially, this part binds the faces of your model to a specific spot in your texture file. 
           There really isn't much to be said about this; experience is what makes good unwraps.

        2. Once you have distributed the faces around the UV plan, make sure to make a render/snapshot 
            of the UV position, saving the resulting image in a PNG file that has a format in powers of two
            (128x128 or 256x256 is ideal, 512x512 for high-detail meshes. 1024x1024 is beginning to be a bit large.)

    **Location of the UV unwrapping tool in...

        Maya: Polygon menu set, upper left. There's an icon for it at the very end of the lane.

        3ds Max: Select an object or a group of objects. Open Modifiers menu, on the right, and select UV Unwrap.
                      Scroll down, click edit.

Step 6 - Exporting Your Asset


        1. Again, it depends on the program, but usually you're going to want to export it using the 
            COLLADA exporter plugin.
            (for Maya and 3ds, it's available on the Autodesk website).

        2. Export it as a .dae - although here's a list of things to make sure your plugin is well configured: 
            a. -Your axes: make sure that the plugin is set to convert your model to the Y-up convention, 
                    else you risk having a sideways model.

            b. -The scale: set your plugin to convert your model to a scale of 1unit=1m 
                                 (setting the units measurements to meters) or You're going to have 
                                 an oversized/undersized model.

**************************this is your spot***********************************************

Step 7 - Preliminary configuration

1. At this point, you may open the part.cfg to allow partslab to load it (refer to this tutorial for the format).

>> http://wiki.kerbalspaceprogram.com/wiki/User:Greys/The_CFG_File_and_ConfigNodes

>>

>> **this is another page explaining CFG_File and ConfigNodes** http://wiki.kerbalspaceprogram.com/wiki/User:Greys/The_CFG_File_and_ConfigNodes

>>*************************************************************************************************************************************************
>> Tutorials >> [URL]http://wiki.kerbalspaceprogram.com/wiki/Tutorials[/URL]
>>
>> Complete up to asset parameters, inclusively - the rest isn't too important for now.
>>
>>> From above - Preliminary configuration - [URL]http://wiki.kerbalspaceprogram.com/wiki/CFG_File_Documentation[/URL]

I. Basic Part Making Guidelines
A. Ensure that the model itself will not break the game on loading:
B. The file must be a .dae file.
C. EveryÃ¢â‚¬â€even the collision meshÃ¢â‚¬â€mesh must have a material.
D. The parts must be correctly named; e.g., the collision mesh should always be called "node_collider"

E. Ultimately KSP will need a .mu file to load the file into the Game Database.
Unity contains a .mu exporting function with the KSP Part Tools.

1. 0.23 PartTools by - Mu - Developer - *might be install issues - this must be added to Unity, then using tools set it to KSP GameData directory.*

a. Here is the link for the 0.23 PartTools package.
[URL]https://kerbalspaceprogram.com/parttools/PartTools023.zip[/URL]
Not much else has changed really but will now let you export .mu files with KSPParticleEmitters for use in your mods.

b. KSPParticleEmitter was built because Unity particle emitters are notoriously hard to script and serialize.
It was impossible to save/load them from files without a wrapper of some kind.
Sadly it does lead to some limitations in the space orientation and spawning of the particles.
However for simple thrust and rcs jets it should be fine.
If Unity ever open the particle emitters up to be able to script for them properly then we will update KSPParticleEmitter
to match.

c. If you require more extreme particle emitters then you will need UnityPro and AssetBundles to export them,
alternatively you can spawn our inbuilt ones via code. -- might be

2. PartTools - from README within package - ??0.20 WTF?? this is 0.23 - ok whatever---

a. Overview -
PartTools has had a refresh and is now a lot easier to use. It comes in precompiled dlls and a nicer directory structure
and supports some more advanced features. Because of the ability to read another model's textures by name, it no longer
forces renaming of textures to modelXXX. The 'model name' is now used as the actual filename of the model.
Do not add an extension to this field.

b. To make PartTools work -
1. you need to add the new package to Unity and then set your GameData directory via Tools -

2. Tools - >KSP PartTools. This will set the GameData directory and make all paths used in PartTools relative to that.

3. KSPParticleEmitter -
a. PartTools now also supports a particle emitter, KSPParticleEmitter which is included in the PartTools package.
Unity native particle emitters will not work as they are not fully serializable. KSPParticleEmitter
is based upon the legacy particle emitter, see the unity docs for information, however it also
supports a variety of emitter shapes. The KSPParticleEmitter is fully animatable via the standard
unity animation system like other PartTools assets.

b. To create a material for a KSPParticleEmitter use the two included KSP/Particle shaders. There is an alpha blended and additive shader.

4. PropTools - PropTools, the system to create internal spaces for KSP, has had a major rebuild. It can now load and save internal space configs
and also load models and textures of the props and internal spaces. No longer having to use the awful proxy system!

a. If you are working on an existing internal space then open the PartTools window (Tools->KSP PartTools), set the game's GameData
directory and then you can instantiate internal spaces and props via that window.

b. If you are creating a new internal space then you currently need to create an INTERNAL config manually. That can then be loaded by PartTools.

NOTE: Always keep the PartTools window open as it assists in prop selection to sidestep a Unity editor bug.

II. Part file creation -

A. Save an empty notepad file, which will become the .cfg
in the directory of your addonÃ¢â‚¬â€usually "
../KerbalSpaceProgramDirectory/Parts/yourAddon".

This empty file will become the .cfg (your config file)

B. Config file order -

PART {

// Title
// Name of your part
//

// --- general parameters ---

// --- asset parameters ---

// --- node definitions ---

// --- FX definitions ---

// --- Sound FX definition ---

// --- editor parameters ---

// --- attachment rules: stck, srfAttach, allowStack, allowSrfAttach, allowCollision ---

// --- standard part parameters ---

// --- specific part parameters ---

MODULE {

// ---specific module parameters ---

}

// --- other MODULEs ---

}

note - The slashes before each title indicate that the line thereof has been commented out; the program ignores such lines. (rem lines)

C. Title -

1. Atop most part files are a couple of lines that resemble the ones below:

// Kerbal Space Program - Configuration file
// My super awesome engine that can go at a kajillion miles per hour, lol

2. These lines are useful when others want to learn from your part file.
The first line states that this file is a part file for KSP; the second states its name.

// Kerbal Space Program - Part CFG file
// Mark V Rocket Engine

>> Onwards!

D. General Parameters -

// --- general parameters ---

1. This section follows the title and describes several properties of all parts. Below is a list of what goes under General Parameters:

name = solidBooster
//Leave this next line as is unless you have a reason
module = Part
author = Il Carnefice

a. name - It can be anything that is unique, one word, and without an underscore;
it's not commented out because KSP will internally (the user will not see this name) thus refer to the part.

name = solidBooster

b. module - This used to describe the specific part class behavior but now this is handled by the Module tags later in the file.
Set it to Part.

module = Part

d. author - Author name

e. Parts -

Part Name Description

SolidRocket Resembles a solid rocket booster - a continually burning rocket that lacks thrust control and
cannot be deactivated once lit.

LiquidEngine Resmebles an orbital maneuvering system - a rocket engine with controllable thrust.

FuelTank Contains fuel.

CommandPod Contains crew and a control system.

SASModule Holds course.

SASModule2 ???

Strut Connects rocket parts. Has no special abilities.

Decoupler Connects rocket parts and can jettison itself and the parts it's connected to.

RadialDecoupler Connects and can jettison parts much as does a Decoupler, but radially.

Parachutes Deploys a parachute.

ControlSurface Movable wing-like surface. Can act as a rudder, aileron, elevator, canard or other
aerodynamic control surface - function depends on placement on a ship.

WarpEngine A warp engine. Not functional as of 0.15.2.

Winglet A fixed, lifting part.

Stabilizer Similar to ControlSurface (recommend to not use)

StrutConnector ???

RCSFuelTank A RCS tank.

RCSModule A RCS thruster.

AtmosphericEngine Atmospheric engine with air flow parameters.

AdvSASModule An SAS-type module that alters user input allowing for control of RCS, pod torque,
gimballing engines and control surfaces.

DecouplerGUI A normal decoupler that can be disconnected via the right-click GUI.

DockingPort An unfinished docking port?

FuelLine Transfers fuel.

FuelTankGUI A fuel tank with a right-click GUI to disable flow.

LandingLeg A moving landing leg, using .cfg parameters to move.

HLandingLeg A moving landing leg, using animations to move.

HParachutes An animated parachute module?

LandingGear Wheeled, animated landing gear for spaceplanes.

SatELight A flash-light module.

LiquidFuelEngine A liquid fuel engine that uses Thrust and Isp, rather than Thrust and fuel units.

>>> f. Part Modules - Please read: "0.15 code update - PartModule, KSPField, KSPEvent, ConfigNode and PartResource"
>>>
>>
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

***************************************this is your place***********************************************************

Step 8 - Texturing your Asset


        1. Open your UV render in your image editing program of choice
         (I personally recommend Gimp or Photoshop, but MSPaint is fine too).
        2. Get artistic, following the lines of the UV map so it actually shows on your model.
        3. Save it the same format, but try not overwriting the UV - it's always handy to have.
        4. Again, here, there is only experience which will make you good 
            - although a quick tip: premade textures are quite handy to have 
            (such as metal textures and such) if you're feeling lazy/unambitious/unskilled.
             Trial and error is quite often used here. 

****        5. You may use the PartLab, available on the download page, to check the progress/if it's right.
            Some say it's possible to do so before exporting the model by importing the texture into the 3d modelling program,
            but I have never found out how. Keep me updated (Killerhurtz on the forums) on how to do this if you figure it out.
                side note - Nutt007 Capsule Communicator - PartLab is very out dated, and probably cannot read .mu. 
                                        I recommend not using it 11th October 2012, 12:30 #2
***********************************************************************************************

Step 9 - Back to the config

1. Now that you're satisfied with your texture, it's time to finalize your .cfg file.
Again, refer to the documentation as to how to outfit it.

2.Quick tips:
a. -NODES- Having your mesh open can help setting the different nodes
(under 3ds Max, there is even a plugin to get the correct, high-accuracy node vector available with the SDK).
b. The angles aren't really angles: they show the second point of a line with which the model is going to align itself.

c. -EFFECTSÃ¢â‚¬â€Graphical effects You may refer to this thread for a list of effects you may use for your parts. (dead link)

Step 10 - The Last Checkup and the preparation

1. Now, in theory, you should have your full part.
However, don't get ahead of yourself - you'll only attract shrapnel if you jump right in.
Be sure to test your part thoroughly
(an easy way to do this is to have a clean install dedicated to testing new parts to make sure it works
before sending it into your main install).

2. Tweak it as you want it to feel.
Once you're satisfied, make sure to take a few screenshots of what your part(s) look like.
Upload your pictures and part(s) somewhere, and save the links.
(I wouldn't recommend dropbox - too high traffic might get your public folder disabled for sharing)

3. Once all of this is done, you may proceed to...

Step 11 - The Release

1. Using the links you have previously acquired, make a thread in the Projects and Release section of the KSP forums.
Post it, wait, and bask in your newfound success!

*********************************************************************************************************************************************************

- Preliminary configuration - [URL]http://wiki.kerbalspaceprogram.com/wiki/CFG_File_Documentation[/URL]