Tutorial: Getting started with the XSI CryExporter

[Leonard]

UPDATED: 5 May 2008
Version 3.2 has been released fixing the export issues on Windows Vista. Download the XSI CryExporter v 3.2 here (http://webrel2.softimage.com/open/products/xsi_addons/crytek/Crytek_XSI_v3.2.zip).

-----

Hi all,

This is a 5 minute tutorial in getting the XSI CryExporter working.

You'll need:
- XSI (commercial version or the free XSI Mod Tool). We only tested with XSI 6.02+
- The original Crysis disc, and the Crysis game must be installed
- SOFTIMAGE|Crosswalk 2.5.x Download it here (http://www.softimage.com/downloads/Crosswalk/crosswalk_2_5_2.aspx).

About the XSI Mod Tool
This is a free version of XSI for non commercial game creation. It is basically XSI Essentials 6.02 with some limitations such as a 64k triangle export limit (per mesh, not scene), and 512x512 rendermap limit. It's free!!

>> Download the Mod Tool here << (http://www.softimage.com/products/modtool/)



Setting up the XSI CryExporter



1. Install the Sandbox Editor.
On the Crysis game disc, go to the directory named "Sandbox2"
Install it by double clicking on the "CryEngine(R)2 Sandbox(TM)2.msi" file

Once you install it, you can now run it from your Crysis\Bin32 directory. By default, this is here:
C:\Program Files\Electronic Arts\Crytek\Crysis\Bin32\Editor.exe

You can get more information and tutorials on Sandbox and Crysis modding here:
http://www.crymod.com


2. Download the XSI CryExporter v3.2 here:
http://webrel2.softimage.com/open/products/xsi_addons/crytek/Crytek_XSI_v3.2.zip

When you unzip the file, you'll see the following directories:
- Crysis - Bin32 directory contains the resource compiler. Game contains the mod export folders where we'll write our files to
- Crytek_XSI_Database
- XSI_Addon


3. Copy files

/Crysis/ -> Copy to your Crysis install path. Default:
C:\Program Files\Electronic Arts\Crytek\

Overwrite all. (if you don't get an "overwrite?" dialog box, you're copying to the wrong folder.

This will copy the directories Bin32 and Game into the Crysis folder


4. Install the XSI Addon
- Open SOFTIMAGE|XSI or Mod Tool.
- In a Windows Explorer window, navigate to the /XSI_Addon directory that you just unzipped.
- Drag and drop "Crytek Addon.xsiaddon" into XSI

Restart XSI. When you restart, you may see a "Crytek" menu bar at the top of XSI. If you don't (some Windows Vista users are saying that they don't and we are investigating this), you can still access the toolbar by clicking on View -> Toolbars -> Crytek Toolbar.



5. Set up the CryExporter paths
Click on the "Crytek" menu item -> Properties (or in the Crytek Toolbar, click on "Properties" in the Others section)

You have to set the Bin32 path and Export path to the directories you copied over just now.

Bin32 default path: C:\Program Files\Electronic Arts\Crytek\Crysis\Bin32

Export default path: C:\Program Files\Electronic Arts\Crytek\Crysis\Game\Objects\XSI_Assets


6. You're done setting up the CryExporter.

Now you can follow this Camtasia tutorial to export models into Sandbox:

http://webrel2.softimage.com/open/video/crytek/cryexporter.flv


Note that there is a level for Sandbox that you can start adding objects to. By default it is here:

C:\Program Files\Electronic Arts\Crytek\Crysis\Game\Levels\XSI_Testobjects



7. Have fun and please help us by giving us feedback!
If you have any problems with the exporter, it throws out strange errors, etc, please let us know by posting in this forum. The exporter really is a production tool used by Crytek to make their latest games, and in the best interest of building a better exporter, we appreciate any feedback!

Also, show us your mods!

Visit the Crymod website to get more information on Sandbox and Crysis modding:
http://www.crymod.com



KNOWN ERROR - "TYPE MISMATCH"
If you're getting a "type mismatch error" on export, please ensure that you are using Crosswalk 2.5.x - download it here (http://www.softimage.com/downloads/Crosswalk/crosswalk_2_5_2.aspx).



Cheers,

Leo


http://www.softimage.com/news/newsimages/2008_02/thmb_xsi_cryengine_1.jpg (http://www.softimage.com/news/newsimages/2008_02/xsi_cryengine_1.jpg)

http://www.softimage.com/news/newsimages/2008_02/thmb_xsi_cryengine_2.jpg (http://www.softimage.com/news/newsimages/2008_02/xsi_cryengine_2.jpg)

[Delirium]

That was fast. Anouncement yesterday and the tool today.
Thanks Leonard.

[Nick3d]

Mod for Crysis? really nice, is a beautiful game, I'm downloading the exporter right now!

[Squid]

It's a rare thing these days for anything remotely associated with modding to be released less than 6 months after the announcements.

very much appreciated Leonard.
:tt1:

[Sysgrunge]

That sounds very good, Thanks Leonard.

[Denfound]

Yes !! Thank you for that plugin xsi/cryengine.

I'll try that.

[Ricko]

Very cool. Thank you!

Ricko

[LowPolyProxy]

Hi there,
I really loved the inital start of this thread very clear and consise, thankyou very much. i am wondering if it would be possible to do a more general tutorial with setting up the shading network within XSI and the exporting process a little more clearly and slowly as the vid that you had made i found not all that clear.

This would be greatly appreciated and Iam sure that a lot of other modders would also get a huge benefit from a more in depth exporting video tutorial from XSI.

Once again many thx

LowPolyProxy

[Bellsey]

Hi,

Thx for the feedback. We will certainly try and look into maybe producing a more deeper introduction video, but its hard to say when this would get done. I'll add it to my ever growing list of things to do though. :)

If you wanted to know more about some of the specific features inside XSI and the ModTool, I would suggest looking at the many tutorials via this site, they are all very good.

Thx

Bellsey

[Hurus_sungod]

The real question is, does it work on Vista? (any version of it, because right now it seems that it does not for many people)

[Bellsey]

hi

XSI system requirements are avaliable on our main website:
http://www.softimage.com/support/xsi/system_requirements/default.aspx

While Softimage does not officially support Vista yet, XSI and Mod Tool can still run under Vista, and some people currently do so without any problems, however we are aware of the issues people are encountering with Vista, and the CryEngine exporter.

We have already replied to peoples concerns in this previous thread:
http://community.softimage.com/showthread.php?t=731

Sorry that we cannot offer any more information at the moment.

Thx

Bellsey

[Barcube]

By export the objects from mod tool ther is an error: "Change the name of the Default Lib"
can you help me??


edit: now it runs i found a post by crymod

(my english is worse i hoope you understand it :))

[dslyecix]

Hello there!

I am just starting to get into the 3d modeling field I suppose, an aspiring architect here :p. I've been searching high and low for a tutorial of some sorts to export 3d studio max or maya into CryEngine2 for a very long time, yet coming up with nothing conclusive. I've dabbled with neither of those, so I would have to completely learn those programs, as well as the Sandbox 2 editor in order to be able to create my "virtual buildings".

Having somewhat dabbled in Softimage XSI way back when it was first created (or at least brought to my attention) with the release of HL2, I'm very pleased to see this Crysis functionality being introduced.

However, I'm having a few problems getting it to work:

EDIT - Ok things aren't giving me weird errors anymore... except the tool still doesnt't work. Crosswalk 2.6, the zip file from the beginning of this thread, Softimage has been updated completely, etc. There's no "Crytek" on the menu, and if I go View > Toolbars > Crytek Toolbar, then every single button gives me a Type mismatch: 'AddCryExportNode', or Type mismatch: 'CryExport' etc.

Any ideas? Thanks again!

[Bellsey]

have you tried uninstalling the Crytek Addon, reinstalling Crosswalk, then installing the Addon again?

[dslyecix]

Yeah, I even completely reinstalled XSI. Unless there's something weird about the order I did it all in.

I went XSI > Crosswalk 2.6 > Crytek addon.

Pretty much followed the tutorial exactly. I don't know if this is one of the (known?) bugs with vista or not.

[Bellsey]

Have you actually been installing the addon file correctly? This might seem obvious, but some guys on the Crymod forums have had problems, but they have just been copying the .addon file in the the relevent XSI directory, instead of actually installing.

Simply coping the addon files will not work, like say DLL's do. You have actually install them.

You can drag and drop the addon file into any viewport of XSI and it will install.

Alternatively, you can also go to the file menu to manually install. File>Add On>Install....then point to the addon file.

[dslyecix]

Unfortunately, yeah, I did drag and drop the file onto the view pane, and it told me I would have to restart XSI to get the functionality.

I'm starting to think I'll just forge ahead without it, I really have to learn how to use XSI on its own before exporting things to the CryEngine 2 will really be of any help to me :p

[Leonard]

Hi all,

Crytek has updated the XSI CryExporter to version 3.2, which works with Vista:
http://webrel2.softimage.com/open/products/xsi_addons/crytek/Crytek_XSI_v3.2.zip

Best,

Leo

[dslyecix]

Still getting the "Type mismatch: *function*" errors :'(

[kwabbott]

I have a question about the installation.

The directions seem to say that we should overwrite the entire Crysis folder or the entire Bin32 folder. However, the Bin32 folder that I would overwrite has a ton more data in it than the new one. It seems this operation would overwite a lot of useful data.

Can someone explain more exactly which files and/or folders should be overwritten?

thanks

Kevin

[Bellsey]

its only the Bin32 directory that you need to copy the exportor files into. The is where the resource compiler for the exportor is.

Don't worry about overwriting anything. When you copy items over, it does not overwrite everything, only updates files.

Basically, when you download the plugin, take the contents of the Bin32 directory that you downloaded and copy it into the Bin32 directory of your Crysis install.

I am prepping some simple videos that explain the whole process. I hope to have them avaliable for viewing soon.

[jgwinner]

Does the tool only do Models and not characters or rigged characters?

The docs say:
Possible types of assets in an XSI scene:
· static rigid geometry (i.e. buildings) (CGF)


This implies it won't do actors. Interestingly, there was a Physics DLL in the download, and the docs also mention NULL's so maybe it does more?

Will the tool be modified to do this? I really wish it would! I'm considering a total conversion, but HL2 is MUCH easier to export assets for.

Thanks,

== John ==

[Leonard]

Right now, the available exporter only supports static geometry but full support for characters is coming. The plug-in is currently in beta testing stage and is being developed by Crytek. Because the exporter is a production tool, it is dependent on Crytek's own internal development cycle, though it is in everyone's best desire to get the plug-in released soon.

Thanks,

Leo

[Vmpre]

Alright then...big question...does this exporter work with v7?

[jgwinner]

Right now, the available exporter only supports static geometry but full support for characters is coming.

Any ETA?

Thanks,

== John ==

[Bellsey]

In answer to Vmpre's post, the answer is yes the exporter does work under v7. I have been using the exporter for while with v7.0

Jgwinners post.........

If anyone has been at Siggraph and seen our booth today (Wednesday), then you would of seen Michael Endres from Crytek demo the XSI to CryEngine exporter, and a preview of the animation support including vehicles.

The precise release date is not known at the moment, so don't ask me for an answer, as I do no have one to give you. However, the fact that we have previewed the new version, in public, should give you some indication on how close it really is.

When we all return from Siggraph, we intend on giving you a little more information and hopefully a more precise idea of the next release.

[trollett]

Is the exporter compatible with XSI 64bit? Cause I can't get it to work.

[Bellsey]

what exactly is the problem? does the addon not install, or do you get an error message? If, so , what is the error you receive?

[trollett]

I can install it, but when I click the properties button in the toolbar it says " incompatible types: 'CryProperties' ". And the same goes on for the rest of the buttons to.

[Bellsey]

try installing Crosswalk 2.5. Even if you have a more recent and up to date version, go to our website and download 2.5

On the Crosswalk download page, there is a option at the bottom to select older versions to download.

[xxArcangel117xx]

hey, i got my model into the sandbox editor, but how do i make it solid, and not so you can walk through it?

also, does your xsi model have to be triangles?

[Bellsey]

to make an object solide, you need to change a setting in the CryShader properties in XSI.

Bring up your Material Manager and select the relevent shader for the surface you wish to make solid. You will see a Physics setting. You need to change this to Physical Proxy. Then re-export.

Look at the plugin documentatiom you downloaded with the plugin and it will explain these settings.

And no, your XSI model does not have to be triangles, but for games it is always good practice to work mostly in triangles.

[jerrycasian]

So this exporter doesn't work with crosswalk 3.1?

[Bellsey]

the current version of the exporter should work with any version of Crosswalk, as long as you do not uninstall Crosswalk v2.5

As long as you keep 2.5 installed, you can also install the subsequent versions of Crosswalk. There's just some strange issue with the current exporter, which we hope to fix with the new updated exporter.

[jerrycasian]

i only have 3.0 and 3.1. So I have Install 2.5 also? I'm getting the mismatch error, so maybe that's the problem.

[Bellsey]

yes, you will have to install Crosswalk 2.5

You can download it from here:
http://www.softimage.com/downloads/Crosswalk/default.aspx

Look under the previous versions menu.

[jerrycasian]

Ok, Thanks!