diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5f43d96 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Hartie95 and the AnimeGameServers Team + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0a0ee3 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# CustomAnimeGameResources (WIP) + +This repo will contain community written scripts, resources and patches to make more PS features usable + + +Usage +===== + +## How to use it with GC +Copy all folders into the resources directory used for GC, then run the AnimeGameResourcePatcher to apply the patches and generate the output in Resources/Generated + +Project structure +===== + +## Overview +Scripts: Community written Lua scripts. These are used by different systems of the Server + +Server: Custom excel files, that are not part of the client, but are requried for server operation. + +Patches: Patches applying missing or custom data to resource files. + +ScriptSceneData: Currently used by ps for rewind purposes, will be replaced/removed in the future. + +## Scripts +Common: Scripts that can be included by other lua code, that contain shared code + +Gadget: Scripts that contain custom controllers used for some gadget logic on the server + +Scene: Scripts used for general overworld logic, like spawning maps and puzzles + +Quest/Share: These are used to define important points and general data used by the client and server + +## Patches +Quest: Patches in the Binout format, applied to quest defintions +Activity: Patches for activityExcelFiles + +Licensing +===== + +This software library is licensed und the terms of the MIT license, with the exemptions noted below. + +You can find a copy of the license in the [LICENSE file](LICENSE). + +Exemptions: +* miHoYo and its subsidiaries are exempt from the MIT licensing and may instead license any source code authored for the AnimeGameServer projects under the Zero-Clause BSD license.