diff --git a/docs/assets/faq/animation.png b/docs/assets/faq/animation.png new file mode 100644 index 0000000..078a090 Binary files /dev/null and b/docs/assets/faq/animation.png differ diff --git a/docs/assets/faq/testing.png b/docs/assets/faq/testing.png new file mode 100644 index 0000000..836ff50 Binary files /dev/null and b/docs/assets/faq/testing.png differ diff --git a/docs/assets/faq/visibility.png b/docs/assets/faq/visibility.png new file mode 100644 index 0000000..1541995 Binary files /dev/null and b/docs/assets/faq/visibility.png differ diff --git a/docs/assets/toolbar.png b/docs/assets/toolbar.png new file mode 100644 index 0000000..207440c Binary files /dev/null and b/docs/assets/toolbar.png differ diff --git a/docs/contributing.md b/docs/contributing.md index 03e1420..e7a5606 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -13,11 +13,11 @@ This will bring you to your own copy of the docs, which you are now free to mess If you cant find your copy of the wiki, click on the user icon in the top right corner of github and hit 'Repositories', then find the one that says docs, that should be your copy. You'll be greated like the screen below if you did it right: -![Fork Creation](assets/create.png) +![Fork Creation](assets/fork.png) From here, you can open the docs folder where all of your work will take place, you can either open a page to edit, or add a new file on the top right hand side. -![File Creation](assets/fork.png) +![File Creation](assets/create.png) All of the files you'll make by hand will end in the .md format, you can find out more about markdown in the [markdown guide](https://www.markdownguide.org/basic-syntax/). diff --git a/docs/faq.md b/docs/faq.md index 83d84c3..8fa5cf5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -5,11 +5,36 @@ description: FAQ for commonly-asked questions & concerns about Ktisis. # Frequently Asked Questions ## How do I install Ktisis v0.3? +Currently, v0.3 is available as the Testing build of Ktisis in Dalamud. What this means is that when you install Ktisis (either from our repository or the Sea of Stars link), you're defaulted to the Main build, which has the v0.2/Alpha version until v0.3 is fully released. In order to switch to v0.3: + +1. Type `/xlsettings` to open Dalamud's settings window; select **Experimental** and enable **Get plugin testing builds**. +2. Type `/xlplugins` to open Dalamud's plugin installer. If Ktisis is already installed, right-click it and select **Receive plugin testing versions**. If not, this can be done from the list of available plugins. +3. **Update plugins**, and an uninstall/reinstall of Ktisis may be necessary. Restart FFXIV and reinstall Ktisis if the update doesn't come through, or contact us for help with any issues. +![Testing Appearance](assets/faq/testing.png){ align=right width=500 } +4. After verifying that v0.3 was installed, enter GPose to initialize Ktisis. Errors may occur if Ktisis' settings are opened before an initial GPose. ## This is overwhelming! Where do I start? +If you're coming to Ktisis as a new user, welcome! This wiki is the perfect place to learn about what Ktisis can do - check out our [guides](./guides.md) for beginner and advanced tips, search for specific questions at the top of the page, or join our [Discord server](https://discord.gg/kUG3W8B8Ny) for any support that you can't find here. + +If you're revisiting Ktisis after having used the v0.2 or Alpha version, check out our [migration guide](./migration.md) to find out everything that's changed and how you can tailor your experience. ## Why can't I see any bones on my character? +Bone overlay visibility is disabled by default so you can see your character as they would appear for screenshots. + +![Visibility Toggle Buttons](assets/faq/visibility.png){ align=left width=200 } +When you need to see bones to move them around in 3D space, use the Workspace's dropdowns on each actor to find and enable any (or all) parts of the skeleton. + +You can also use default or custom **Presets** to toggle groups of bones on and off, found either by right-clicking specific actors or in the Object Editor. ## How do I play different emotes or animations? +The Actor Editor! In addition to changing your character's appearance, this is where you apply any combinations of emotes and expressions. You can also set specific cposes, sitting & lying down, and whether their weapon is drawn. + +You can open this window from the top of the Workspace or Toolbar, or from any actor's right-click menu. + +![Animation Editor](assets/faq/animation.png){ width=400 } +/// caption +Searching for animations shown in the Toolbar UI. +/// ## Where do I send bug reports or feature requests? +You can raise any issues, suggestions, or get support from the devs & community in [our Discord](https://discord.gg/kUG3W8B8Ny). We also accept new issues and PRs [on GitHub](https://github.com/ktisis-tools/Ktisis/issues) if you're handy using it! diff --git a/docs/migration.md b/docs/migration.md index 2f22804..030c785 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -8,6 +8,11 @@ Ktisis has been in development since **2022**, and the plugin ecosystem has matu Despite being the 'main' version of the plugin, v0.2 is wildly out of date in terms of best practices for sane plugin development _and_ for enhancements built on v0.3. The difference between versions has been one of the primary drivers for updates made to v0.3 over the last several months: bringing older features and conveniences into a new and stable interface that we can build on going forward. Features like Gaze Control, Bone Offsets, and Work Camera Speeds were all missing from v0.3 until recently - and v0.2 is missing many more features and stability fixes that were built into v0.3. As a result, v0.3 is now a more stable, more featured, and more extensible platform for us to create new content upon and follow the best practices of Dalamud development. Developing **both** versions in parallel has proved impossible for our small dev team, and more confusing than its worth for our userbase. +![UI Migration](assets/toolbar.png){ width=600 } +/// caption +New looks, same great flavor! +/// + After consulting with our users for a number of important changes to ease this migration, we hope to provide a better experience to more players by focusing our efforts into one product. Thank you for your trust and your patience! ## What's Changed?