Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephengold/ryzomconverter
Adapt models from the Ryzom Asset Repository for use with jMonkeyEngine.
https://github.com/stephengold/ryzomconverter
3d-models animation file-conversion java jme3 jmonkeyengine3 ryzom
Last synced: about 1 month ago
JSON representation
Adapt models from the Ryzom Asset Repository for use with jMonkeyEngine.
- Host: GitHub
- URL: https://github.com/stephengold/ryzomconverter
- Owner: stephengold
- License: other
- Created: 2019-11-14T21:35:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T18:40:28.000Z (2 months ago)
- Last Synced: 2024-09-12T04:56:42.541Z (2 months ago)
- Topics: 3d-models, animation, file-conversion, java, jme3, jmonkeyengine3, ryzom
- Language: Java
- Homepage:
- Size: 506 KB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RyzomConverter adapts character models and animations
from the Ryzom Asset Repository
for use with [jMonkeyEngine](http://jmonkeyengine.org).
RyzomConverter derives from Java software created by Alweth.
Before using, modifying, selling, or distributing
this software or its output, please read
[Alweth's license](https://github.com/stephengold/RyzomConverter/blob/master/LICENSE)
very carefully.
The Ryzom Asset Repository is available under a
[CC-BY-SA 3.0 license](https://creativecommons.org/licenses/by-sa/3.0/),
so if you distribute the converted files or anything built from them,
you should do so under that license.
## Screenshot gallery
The screenshot is derived from Ryzom Asset Repository, licensed CC-BY-SA 3.0.
Alweth is acknowledged for authoring `RyzomConverter`
and providing it free of charge.
## Conversion procedure
The suggested procedure (for Bash users) is:
1. `mkdir RyzomAssets`
2. `cd RyzomAssets`
3. `git clone https://bitbucket.org/ccxvii/ryzom-assets.git`
4. `cd ..`
5. `git clone https://github.com/stephengold/RyzomConverter.git`
6. `cd RyzomConverter`
7. `./gradlew run`
The final step may take 4 minutes or more.
Converted assets are written to the
`RyzomConverter/assets/ryzom-assets/export` folder.
They should occupy about 750 MBytes of filesystem storage.
There should be 4 J3O animations files,
1958 J3O geometries files, and 1183 PNG texture files.
Once the converter has successfully run to completion,
the RyzomAssets folder
(which should occupy about 3.5 GBytes of storage) may be deleted.
The converted assets occupy less storage space
because not all assets in the Ryzom Asset Repository get converted:
only assets in the "actors" folder, and even there, the
"banners", "tools", and "weapons" sub-folders are skipped.
The asset names and animation names are in a mixture of French and English.
## Next steps
To construct a character in Java code:
1. register a locator:
```
assetManager.registerLocator("../RyzomConverter/assets", FileLocator.class);
```
2. load an animations asset and attach it to the scene graph:
```
ModelKey key = new ModelKey("ryzom-assets/export/animations_ca_hom.j3o");
Node characterNode = (Node) assetManager.loadAsset(key);
rootNode.attachChild(characterNode);
```
3. load a geometries asset for each body part
and attach it to the character node.
If using the `ca` skeletal group, the code might look something like this:
```
key = new ModelKey("ryzom-assets/export/fy_hom_armor01_armpad.j3o");
Spatial arms = manager.loadAsset(key);
characterNode.attachChild(arms);
key = new ModelKey("ryzom-assets/export/fy_hom_armor01_gilet.j3o");
Spatial chest = manager.loadAsset(key);
characterNode.attachChild(chest);
key = new ModelKey("ryzom-assets/export/fy_hom_visage.j3o");
Spatial face = manager.loadAsset(key);
characterNode.attachChild(face);
key = new ModelKey("ryzom-assets/export/fy_hom_armor01_bottes.j3o");
Spatial feet = manager.loadAsset(key);
characterNode.attachChild(feet);
key = new ModelKey("ryzom-assets/export/fy_hom_cheveux_basic01.j3o");
Spatial hair = manager.loadAsset(key);
characterNode.attachChild(hair);
key = new ModelKey("ryzom-assets/export/fy_hom_armor01_hand.j3o");
Spatial hands = manager.loadAsset(key);
characterNode.attachChild(hands);
key = new ModelKey("ryzom-assets/export/fy_hom_armor01_pantabottes.j3o");
Spatial legs = manager.loadAsset(key);
characterNode.attachChild(legs);
```
5. disable scene-graph culling for all model spatials
Each geometry is designed for a specific skeletal group, either `ca` or `ge`.
Geometries returned by `loadAsset()` are for the `ca` skeletal group.
Geometries for the `ge` skeletal group
are stashed in the `ryzom_alternative` user data of each geometry asset.
+ The `ca` group provides 76 animations for males and 53 for females.
+ The `ge` group provides 1654 animations for males and 1452 for females.
## External links
Open-source demo software is available
from [GitHub](https://github.com/stephengold/RyzomDemos).
For more information about RyzomConverter, read
[its topic at the jME Forum](https://hub.jmonkeyengine.org/t/convert-all-ryzom-character-models-and-animations-to-j3o-format/37859).
For more information about *The Saga of Ryzom* (the MMORPG for which
the assets were created) read
[its Wikipedia article](https://en.wikipedia.org/wiki/Ryzom).
For more information about the licensing of the Ryzom Asset Repository, read
[the May 2010 Creative Commons press release](https://creativecommons.org/2010/05/06/massively-multiplayer-game-ryzom-released-as-free-culture-and-free-software/).