Initial commit

README.md

@@ -0,0 +1,41 @@
+# Customize+
+Customize+ is a Dalamud plugin designed to give you better control over your Final Fantasy XIV character appearance. Namely it allows you to apply character bone manipulations during gameplay.
+
+## Installing
+After doing that add the following URL to the Dalamud Custom Plugin Repositories list:  
+`https://raw.githubusercontent.com/Aether-Tools/DalamudPlugins/main/repo.json`
+
+Alternatively use the Collective repo Sea of Stars which you can get from here:
+https://github.com/Ottermandias/SeaOfStars
+
+Then search for Customize+ in the plugin manager.
+
+## FAQ
+
+### How do I report an issue with Customize+?
+Please join [XIV Tools Discord](https://discord.gg/KvGJCCnG8t) to report issues with Customize+.
+
+### Where do I learn how to use Customize+?
+Most of the things should be self-explanatory, if you do need help you can join the [XIV Tools Discord](https://discord.gg/KvGJCCnG8t) and ask in the appropriate channel.
+
+### When will it be updated?
+This plugin is being worked on when developers have free time and have a desire to do so, therefore update schedule does not exist. Real life and paid employment take priority over this project.
+
+### IPC
+Current IPC is mostly designed around it being used by Mare Synchronos, it is not recommended to rely on it. In the future general purpose IPC will be introduced with functionality better designed for usage by other plugins.
+
+### Contributing
+Before you contribute your code and features we would like to ask you to first discuss your ideas with us so you don't spend your time making something that possibly won't be accepted. It is possible that your idea might be either out of scope for this project or we have a specific vision for how it should be implemented.
+
+We expect contributed code to adhere to the code style of already existing code and be reasonably well tested. We kindly ask you to be ready to make changes to the code in your Pull Requests if we feel like it needs to be changed.
+
+## Acknowledgements
+* User interface and general plugin architecture is heavily based on the code written as a part of [Glamourer](https://github.com/Ottermandias/Glamourer) and [OtterGui](https://github.com/Ottermandias/OtterGui/) projects. Original code is licensed under Apache License 2.0.
+* Bone manipulation code is based on the code contributed to Customize+ 1.x by [dendr01d](https://github.com/dendr01d/).
+* Some of the game object interaction code is copied from [Penumbra](https://github.com/xivdev/Penumbra) and [Glamourer](https://github.com/Ottermandias/Glamourer) projects in order to make Customize+ not rely on Penumbra being installed.
+* Everyone who contributed code and features through pull requests.
+
+## License
+All files in this repository are licensed under the license listed in LICENSE.md file unless stated otherwise. By contributing the code into this repository you agreeing with licensing submitted code under this license.
+
+##### Final Fantasy XIV © SQUARE ENIX CO., LTD. All Rights Reserved. Customize+ and its developers are not affiliated with SQUARE ENIX CO., LTD. in any way.