{"id":17250126,"url":"https://github.com/stephengold/wes","last_synced_at":"2025-04-14T05:31:54.176Z","repository":{"id":39342754,"uuid":"165975264","full_name":"stephengold/Wes","owner":"stephengold","description":"An animation editing and retargeting library for jMonkeyEngine (code has New BSD license)","archived":false,"fork":false,"pushed_at":"2025-04-07T23:35:55.000Z","size":33553,"stargazers_count":17,"open_issues_count":2,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-08T00:28:19.600Z","etag":null,"topics":["animation","java","jme3","jmonkeyengine","jmonkeyengine3","jvm-library","library","retargeting-animations","skeleton-map"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephengold.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-16T04:45:45.000Z","updated_at":"2025-04-07T23:35:59.000Z","dependencies_parsed_at":"2024-03-15T19:42:46.549Z","dependency_job_id":"f03bfc60-5715-4068-8415-d8aee830e586","html_url":"https://github.com/stephengold/Wes","commit_stats":null,"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FWes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FWes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FWes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FWes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephengold","download_url":"https://codeload.github.com/stephengold/Wes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248826662,"owners_count":21167728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animation","java","jme3","jmonkeyengine","jmonkeyengine3","jvm-library","library","retargeting-animations","skeleton-map"],"created_at":"2024-10-15T06:46:16.175Z","updated_at":"2025-04-14T05:31:54.163Z","avatar_url":"https://github.com/stephengold.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg height=\"150\" src=\"https://i.imgur.com/1iPoJpl.png\" alt=\"Wes Project logo\"\u003e\n\n[The Wes Project][wes] is about editing animations used in\n[the jMonkeyEngine (JME) game engine][jme].\n\nIt contains 2 subprojects:\n\n1. WesLibrary: the Wes [JVM] runtime library\n2. WesExamples: demos, examples, and non-automated test software\n\nComplete source code (in [Java]) is provided under\n[a 3-clause BSD license][license].\n\n\n\u003ca name=\"toc\"\u003e\u003c/a\u003e\n\n## Contents of this document\n\n+ [Important features](#features)\n+ [How to add Wes to an existing project](#add)\n+ [How to build Wes from source](#build)\n+ [Downloads](#downloads)\n+ [Conventions](#conventions)\n+ [An overview of the demo applications](#demos)\n+ [External links](#links)\n+ [History](#history)\n+ [Acknowledgments](#acks)\n\n\n\u003ca name=\"features\"\u003e\u003c/a\u003e\n\n## Important features\n\n+ extract a time-range from an animation\n+ resample an animation track at a new frame rate\n+ retarget animations from one model/skeleton to another\n+ interpolate between keyframes using a wide assortment of algorithms\n+ reverse an animation track\n+ chain 2 tracks together\n+ repair certain issues with animation tracks\n+ convert a traveling animation to an in-place cyclic animation\n\nMost of the features work with both the old and new animation systems.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"add\"\u003e\u003c/a\u003e\n\n## How to add Wes to an existing project\n\nWes comes pre-built as a single library dependent on\n[the Heart Library][heart], which in turn depends on\nthe standard \"jme3-core\" library from jMonkeyEngine.\nAdding Wes to an existing [jMonkeyEngine][jme] project should be\na simple matter of adding these libraries to the classpath.\n\nFor projects built using [Maven] or [Gradle], it is sufficient to add a\ndependency on the Wes Library.\nThe build tool should automatically resolve the remaining dependencies.\n\n### Gradle-built projects\n\nAdd to the project’s \"build.gradle\" or \"build.gradle.kts\" file:\n\n    repositories {\n        mavenCentral()\n    }\n    dependencies {\n        implementation(\"com.github.stephengold:Wes:0.8.1\")\n    }\n\nFor some older versions of Gradle,\nit's necessary to replace `implementation` with `compile`.\n\n### Maven-built projects\n\nAdd to the project’s \"pom.xml\" file:\n\n    \u003crepositories\u003e\n      \u003crepository\u003e\n        \u003cid\u003emvnrepository\u003c/id\u003e\n        \u003curl\u003ehttps://repo1.maven.org/maven2/\u003c/url\u003e\n      \u003c/repository\u003e\n    \u003c/repositories\u003e\n\n    \u003cdependency\u003e\n      \u003cgroupId\u003ecom.github.stephengold\u003c/groupId\u003e\n      \u003cartifactId\u003eWes\u003c/artifactId\u003e\n      \u003cversion\u003e0.8.1\u003c/version\u003e\n    \u003c/dependency\u003e\n\n### Ant-built projects\n\nFor projects built using [Ant], download the Wes and [Heart]\nlibraries from GitHub:\n\n+ https://github.com/stephengold/Wes/releases/tag/latest\n+ https://github.com/stephengold/Heart/releases/tag/8.8.0\n\nYou'll definitely want both class jars\nand probably the \"-sources\" and \"-javadoc\" jars as well.\n\nOpen the project's properties in the IDE (JME SDK or NetBeans):\n\n1. Right-click on the project (not its assets) in the \"Projects\" window.\n2. Select \"Properties\" to open the \"Project Properties\" dialog.\n3. Under \"Categories:\" select \"Libraries\".\n4. Click on the \"Compile\" tab.\n5. Add the [Heart] class jar:\n  + Click on the \"Add JAR/Folder\" button.\n  + Navigate to the download folder.\n  + Select the \"Heart-8.8.0.jar\" file.\n  + Click on the \"Open\" button.\n6. (optional) Add jars for javadoc and sources:\n  + Click on the \"Edit\" button.\n  + Click on the \"Browse...\" button to the right of \"Javadoc:\"\n  + Select the \"Heart-8.8.0-javadoc.jar\" file.\n  + Click on the \"Open\" button.\n  + Click on the \"Browse...\" button to the right of \"Sources:\"\n  + Select the \"Heart-8.8.0-sources.jar\" file.\n  + Click on the \"Open\" button again.\n  + Click on the \"OK\" button to close the \"Edit Jar Reference\" dialog.\n7. Similarly, add the Wes jar(s).\n8. Click on the \"OK\" button to exit the \"Project Properties\" dialog.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"build\"\u003e\u003c/a\u003e\n\n## How to build Wes from source\n\n1. Install a [Java Development Kit (JDK)][adoptium],\n   if you don't already have one.\n2. Point the `JAVA_HOME` environment variable to your JDK installation:\n   (In other words, set it to the path of a directory/folder\n   containing a \"bin\" that contains a Java executable.\n   That path might look something like\n   \"C:\\Program Files\\Eclipse Adoptium\\jdk-17.0.3.7-hotspot\"\n   or \"/usr/lib/jvm/java-17-openjdk-amd64/\" or\n   \"/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home\" .)\n  + using Bash or Zsh: `export JAVA_HOME=\"` *path to installation* `\"`\n  + using [Fish]: `set -g JAVA_HOME \"` *path to installation* `\"`\n  + using Windows Command Prompt: `set JAVA_HOME=\"` *path to installation* `\"`\n  + using PowerShell: `$env:JAVA_HOME = '` *path to installation* `'`\n3. Download and extract the Wes source code from GitHub:\n  + using [Git]:\n    + `git clone https://github.com/stephengold/Wes.git`\n    + `cd Wes`\n    + `git checkout -b latest 0.8.1`\n  + using a web browser:\n    + browse to [the latest release][latest]\n    + follow the \"Source code (zip)\" link at the bottom of the page\n    + save the ZIP file\n    + extract the contents of the saved ZIP file\n    + `cd` to the extracted directory/folder\n4. Run the [Gradle] wrapper:\n  + using Bash or Fish or PowerShell or Zsh: `./gradlew build`\n  + using Windows Command Prompt: `.\\gradlew build`\n\nAfter a successful build,\nartifacts will be found in \"WesLibrary/build/libs\".\n\nYou can install the artifacts to your local Maven repository:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew install`\n+ using Windows Command Prompt: `.\\gradlew install`\n\nYou can restore the project to a pristine state:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`\n+ using Windows Command Prompt: `.\\gradlew clean`\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"downloads\"\u003e\u003c/a\u003e\n\n## Downloads\n\nNewer releases (since v0.3.9) can be downloaded from\n[GitHub](https://github.com/stephengold/Wes/releases).\n\nOld releases (v0.2.1 through v0.3.8) can be downloaded from\n[the Jme3-utilities Project](https://github.com/stephengold/jme3-utilities/releases).\n\nNewer Maven artifacts (since v0.6.2) are available from\n[MavenCentral](https://central.sonatype.com/artifact/com.github.stephengold/Wes/0.8.1/versions).\n\nOld Maven artifacts (v0.4.8 thru v0.6.1) are available from JCenter.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"conventions\"\u003e\u003c/a\u003e\n\n## Conventions\n\nPackage names begin with\n`jme3utilities.` (if Stephen Gold holds the copyright) or\n`com.jme3.` (if the jMonkeyEngine Project holds the copyright).\n\nThe source code is compatible with JDK 7.\nThe pre-built libraries are compatible with JDK 8.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"demos\"\u003e\u003c/a\u003e\n\n## An overview of the demo applications\n\nApplications have been created to showcase\ncertain features of Wes.\nThe following demos are found in the WesExamples subproject:\n\n### ConvertToInPlace\n\nDemonstrates converting the \"hurricane_kick\" animation\n(from Adi Barda's ninja-fighter model) to an in-place cyclic animation.\nThe unmodified animation is shown on a white skeleton,\nsynchronized with the converted animation, which is shown on a yellow skeleton.\n\n### FlashMobDemo\n\nDemonstrates retargeting the \"Dance\" animation clip of the Sinbad model\nto 4 unrelated models: Jaime, MhGame, Oto, and Puppet.\n\n### ReverseAnimation\n\nDemonstrates reversing the \"StandUpBack\" animation clip of the Sinbad model to\ngenerate a \"LieDown\" clip.\n\n### TrimAnimation\n\nDemonstrates trimming and stretching the \"SliceHorizontal\" animation clip of\nthe Sinbad model to generate a \"warn\" clip.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"links\"\u003e\u003c/a\u003e\n\n## External links\n\n+ [the Wes Animation Toolkit page](https://library.jmonkeyengine.org/#!entry=11511%2F15054f52-c439-4bfb-9a73-80260b486333)\n  in [the JmonkeyEngine Library][library]\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"history\"\u003e\u003c/a\u003e\n\n## History\n\nThe evolution of this project is chronicled in\n[its release log][log].\n\nMuch of the Wes code was originally developed for the [Maud editor][maud].\n\nThe retargeting code is derived from [the Bvhretarget Project][bvhretarget].\n\nFrom September 2017 to January 2019, Wes was a subproject of\n[the Jme3-utilities Project][utilities].\n\nSince January 2019, Wes has been a separate project, hosted at\n[GitHub][wes].\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"acks\"\u003e\u003c/a\u003e\n\n## Acknowledgments\n\nLike most projects, the Wes Project builds on the work of many who\nhave gone before.  I therefore acknowledge the following\nartists and software developers:\n\n+ Rémy Bouquet (aka \"nehon\") for creating the Jaime model and\n  the [Bvhretarget Project][bvhretarget]\n  (on which `BoneMapping` and `SkeletonMapping` are based)\n  and also for many helpful insights\n+ Adi Barda, for creating the ninja-fighter model\n+ Zi Ye, for creating the Sinbad model\n+ [Nathan Vegdahl][vegdahl], for creating the Puppet model\n+ Paul Speed, for helpful insights\n+ Ali (aka \"Ali_RS\") for sharing a code snippet that inspired\n  the `convertToInPlace()` methods\n+ plus the creators of (and contributors to) the following software:\n    + the [Checkstyle] tool\n    + the [FindBugs] source-code analyzer\n    + the [Firefox] and [Google Chrome][chrome] web browsers\n    + the [Git] revision-control system and GitK commit viewer\n    + the [GitKraken] client\n    + the [Gradle] build tool\n    + the [IntelliJ IDEA][idea] and [NetBeans] integrated development environments\n    + the [Java] compiler, standard doclet, and runtime environment\n    + [jMonkeyEngine][jme] and the jME3 Software Development Kit\n    + the [Linux Mint][mint] operating system\n    + [LWJGL], the Lightweight Java Game Library\n    + the [MakeHuman] 3-D character creation tool\n    + the [Markdown] document-conversion tool\n    + the [Meld] visual merge tool\n    + Microsoft Windows\n    + the PMD source-code analyzer\n    + the [WinMerge] differencing and merging tool\n\nI am grateful to [GitHub], [Sonatype], [JFrog], and [Imgur]\nfor providing free hosting for this project\nand many other open-source projects.\n\nI'm also grateful to my dear Holly, for keeping me sane.\n\nIf I've misattributed anything or left anyone out, please let me know, so I can\ncorrect the situation: sgold@sonic.net\n\n[Jump to the table of contents](#toc)\n\n\n[adoptium]: https://adoptium.net/releases.html \"Adoptium Project\"\n[ant]: https://ant.apache.org \"Apache Ant Project\"\n[blender]: https://docs.blender.org \"Blender Project\"\n[bvhretarget]: https://github.com/Nehon/bvhretarget \"Bvhretarget Project\"\n[checkstyle]: https://checkstyle.org \"Checkstyle\"\n[chrome]: https://www.google.com/chrome \"Chrome\"\n[elements]: https://www.adobe.com/products/photoshop-elements.html \"Photoshop Elements\"\n[findbugs]: http://findbugs.sourceforge.net \"FindBugs Project\"\n[firefox]: https://www.mozilla.org/en-US/firefox \"Firefox\"\n[fish]: https://fishshell.com/ \"Fish command-line shell\"\n[git]: https://git-scm.com \"Git\"\n[github]: https://github.com \"GitHub\"\n[gitkraken]: https://www.gitkraken.com \"GitKraken client\"\n[gltf]: https://www.khronos.org/gltf \"glTF Project\"\n[gradle]: https://gradle.org \"Gradle Project\"\n[heart]: https://github.com/stephengold/Heart \"Heart Project\"\n[idea]: https://www.jetbrains.com/idea/ \"IntelliJ IDEA\"\n[imgur]: https://imgur.com/ \"Imgur\"\n[java]: https://en.wikipedia.org/wiki/Java_(programming_language) \"Java programming language\"\n[jfrog]: https://www.jfrog.com \"JFrog\"\n[jme]: https://jmonkeyengine.org \"jMonkeyEngine Project\"\n[jvm]: https://en.wikipedia.org/wiki/Java_virtual_machine \"Java virtual machine\"\n[latest]: https://github.com/stephengold/Wes/releases/latest \"latest release\"\n[library]: https://library.jmonkeyengine.org \"jMonkeyEngine Library\"\n[license]: https://github.com/stephengold/Wes/blob/master/LICENSE \"Wes license\"\n[log]: https://github.com/stephengold/Wes/blob/master/WesLibrary/release-notes.md \"release log\"\n[lwjgl]: https://www.lwjgl.org \"Lightweight Java Game Library\"\n[makehuman]: http://www.makehumancommunity.org/ \"MakeHuman Community\"\n[markdown]: https://daringfireball.net/projects/markdown \"Markdown Project\"\n[maud]: https://github.com/stephengold/Maud \"Maud editor\"\n[maven]: https://maven.apache.org \"Maven Project\"\n[meld]: https://meldmerge.org \"Meld merge tool\"\n[mint]: https://linuxmint.com \"Linux Mint Project\"\n[netbeans]: https://netbeans.org \"NetBeans Project\"\n[ogre]: http://www.ogre3d.org \"Ogre Project\"\n[sonatype]: https://www.sonatype.com \"Sonatype\"\n[utilities]: https://github.com/stephengold/jme3-utilities \"Jme3-utilities Project\"\n[vegdahl]: https://www.cessen.com \"Nathan Vegdahl\"\n[wes]: https://github.com/stephengold/Wes \"Wes Project\"\n[winmerge]: https://winmerge.org \"WinMerge Project\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Fwes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephengold%2Fwes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Fwes/lists"}