diff --git a/README.md b/README.md index 00e4cbf39dbad57a024f72d67332745a3d6a137a..9ef8cd32012a4b6e460035724e6b24fcccac8979 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # Character Plugin -A currently **very preliminary** plugin to embedd virtual characters (virtual agents) into our Unreal projects. Al features are demonstrated in separate maps in our test project called [Unreal Character Test](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/demos/unreal-character-test). To follow our group's CI/CD process, this test project also uses Nightly Builds. +A currently **very preliminary** plugin to embed virtual characters (virtual agents) into our Unreal projects. +All features are demonstrated in separate maps in our test project called +[Unreal Character Test](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/demos/unreal-character-test). +To follow our group's CI/CD process, this test project also uses Nightly Builds. -If you are using the [VAServer](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/VAServerLauncher) for the audio, please ensure that you always have the newest version (due to sound files being stored there). +If you are using the [VAServer](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/VAServerLauncher) for the audio, +please ensure that you always have the newest version (due to sound files being stored there). ## Branches | Branch | Working Unreal Versions | @@ -12,7 +16,10 @@ If you are using the [VAServer](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/VA | deprecated/4.22 | 4.22 | ## Contributions -If you want to contribute new features to this project, please open a respective feature-branch and open a merge-request once the feature is finished (including: testing, documentation, and issue update). Please ensure to also open a feature-branch of the same name in the Character Test project to test and demonstrate the new feature with a character of your choice. Models can be found here: [growing collection of character models](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/virtualcharactermodels). +If you want to contribute new features to this project, please open a respective feature-branch and open a merge-request once the feature is finished +(including: testing, documentation, and issue update). +Please ensure to also open a feature-branch of the same name in the Character Test project to test and demonstrate the new feature with a character of your choice. +Models can be found here: [growing collection of character models](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/virtualcharactermodels). ## Contacts Originally created by Jonathan Ehret and Andrea Bönsch.