smlu / blender-sith Goto Github PK

View Code? Open in Web Editor NEW

22.0 4.0 3.0 40.77 MB

Blender addon for games based on the Sith game engine.

License: Other

Python 99.52% Shell 0.48%

blender 3d-model animation blender-addon blender-plugin 3do key mat star-wars-jkdf2 star-wars-mots

blender-sith's Introduction

Blender 2.79 addon for the games based on Sith game engine

Addon provides Blender game assets import/export scripts for the games based on Sith game engine:

Star Wars Jedi Knight: Dark Forces II
Star Wars Jedi Knight: Mysteries of the Sith
Star Wars: DroidWorks
Indiana Jones and the Infernal Machine
Grim Fandango - Importing of text format 3DO models is only supported

Features

Import/Export .3do models
Edit 3DO mesh & polygon properties in Blender
Import/Export .key mesh animations
Armature animations not supported (yet)
Import .mat textures

Requirements

The latest Blender 2.79b, you can download it here.

Installation

Download sith.zip file from the Releases page.
Open Blender and select File > User Preferences > Add-ons > Install Add-on from File
and select the downloaded sith.zip file.
Enable the addon by clicking the checkbox next to the add-on name.
Click the Save User Settings button in the lower left and close the preferences window.

Usage

Importing 3DO model

Go to File > Import > Sith Game Engine 3D Model (.3do)
Find and select *.3do model file
Import options
In the opened import dialog window you have import options under Import 3DO section (bottom left). Here you can check/uncheck different options and set path to the folder containing texture files (.mat) and ColorMap file (.cmp)

Note: By default addon tries to find required texture(s) and ColorMap file of the imported model at the location of it's file.
I.e.: <model_path>/mat, <model_path>/misc/cmp, <model_path>/../mat, <model_path>/../misc/cmp, <model_path>/../../misc/cmp
Then click the Import 3DO button to import model into Blender.

Exporting 3DO model

Go to File > Export > Sith Game Engine 3D Model (.3do)
Select path, name the file
Note: The file name must not be longer than 32 characters (IJIM 64 characters).
In the export options section select the 3DO file version
Then click the Export 3DO button to export object(s) to 3DO file.

Importing KEY animation

First import 3DO model that animation is for
Note: Which key file belongs to which 3DO model cannot be easy to figured out because single model can have many different animations. One thing to do is opening puppet file (.pup) located in misc/pup folder and see which animations belongs to the same game "actor". Another way is to open up .3do and .key file and see if .3do file contains all mesh names used by the .key file.
Go to File > Import > Sith Game Engine Animation (.key)
Select the *.key file and click the Import KEY button

Exporting KEY animation

Go to File > Export > Sith Game Engine Animation (.key)
(Optional) Set additional export options in the Export KEY section (bottom left)
Select path, name the file and click Export KEY
Note: The file name must not be longer than 32 characters (IJIM 64 characters).

Importing MAT texture

Go to File > Import > Sith Game Engine Texture (.mat)
Select the *.mat file and click the Import MAT button

Editing

Additional from importing and exporting Sith engine formats addon adds extra UI panels for editing 3DO file specific data.

1. Object 3DO Properties

The Sequence number is the node position number in the mesh node hierarchy list in the 3DO file. When creating the new model by default this number is -1 and addon will auto-set the node position in the hierarchy list based on the object's hierarchy in Blender when exporting to 3DO file. If the node name is not set addon will take the object mesh name from Blender when exporting to 3DO file.

2. Mesh Face Properties

blender-sith's People

Contributors

Stargazers

Watchers

Forkers

blendercn-org cansecodev sithmartyr

blender-sith's Issues

Doesn't install on Blender 2.79

The addon doesn't install on 2.79. The page says for 2.79. Was this updated for a newer version? I tried a few later versions but none of them appear to be working. Please advise.
https://cdn.discordapp.com/attachments/881034839401328683/1151470094384373852/image.png

Exporting animation without keying all axis breaks animation

If there is keyframe which doesn't have all location or rotation axis keyed the exported animation will be wrong because non-keyed axis will have value 0.0 instead of values from previous frame.

Export error for 2 models

Hello Smlu, I send you a private message in GOG.com concerning Indy modding (HD 3do files) and .CND to .NDY conversion... But I'm here to report a bug, when I try to export "gen_ij.3do" and "gen_im.3do" (even if I don't modify the file). The error message is in the picture:

It's the same error for Indy in the minecar (gen_im.3do) but It work good for all others models.

Thanks for all your tools! (Sorry for my language: I'm french)

3do import failure

Whenever I import any kind of Grim Fandango 3DO I am met with some sort of long error.

Broken exported animation

Some exported KEY animations such as ib_stand2.key, ib_rotate_left.key and ib_rotate_right.key are broken in the game due to interpolation issue. Could be reverse issue of #4

Blender 3.x?

I installed blender 3.0.1 on Linux Mint. I can install the addon, and I get this message:

Modules Installed (sith) from '/home/brian/Desktop/JK Stuff/sith.zip' into '/home/brian/.config/blender/3.0/scripts/addons'

Once it's installed, I see a note next to it that says "Upgrade to 2.8x required." But I already have 3.0.1.

When I try to enable it I get this message:

Traceback (most recent call last):
  File "/usr/share/blender/scripts/modules/addon_utils.py", line 387, in enable
    mod.register()
  File "/home/brian/.config/blender/3.0/scripts/addons/sith/__init__.py", line 675, in register
    bpy.types.INFO_MT_file_export.append(menu_func_export)
AttributeError: 'module' object has no attribute 'INFO_MT_file_export'

Any ideas? Thank you!

Trying to enabling addon in last 2.79 release gives errors.

The add-on installs fine in the blender version 2.79 listed under requirements, but when trying to enable it in the Blender User Add-ons Preferences it throws up an error message and doesn't enable it.

Traceback (most recent call last):
  File "/var/lib/snapd/snap/blender/20/2.79/scripts/modules/addon_utils.py", line 331, in enable
    mod = __import__(module_name)
  File "/home/retro/.config/blender/2.79/scripts/addons/ijim/__init__.py", line 50, in <module>
    import ijim.model.model3doExporter as model3doExporter
  File "/home/retro/.config/blender/2.79/scripts/addons/ijim/model/model3doExporter.py", line 13, in <module>
    from .model3do import *
  File "/home/retro/.config/blender/2.79/scripts/addons/ijim/model/model3do.py", line 61
    self.material_idx: int      = -1
                     ^
SyntaxError: invalid syntax

How are other people getting this enabled to use it?

Animation interpolation issue for some imported animations

Some imported KEY animations such as ib_stand2.key, ib_rotate_left.key and ib_rotate_right.key have some frames wrongly interpolated. Background of this issue: https://blender.stackexchange.com/questions/58866/keyframe-interpolation-instability/60560#60560