add License Headers, update Readme

Author: moehreag

CHANGELOG.md

@@ -52,3 +52,8 @@
 
 - fix a critical crash that could totally have been avoided 
 
+### 2.2.5
+
+- update README, add license headers in files, add missing credits
+- add turkish translation of the README
+

HEADER

@@ -0,0 +1,22 @@
+Copyright © 2021-${YEAR} moehreag <[email protected]> & Contributors
+
+This file is part of AxolotlClient.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program; if not, write to the Free Software Foundation,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+For more information, see the LICENSE file.
+
+;;year_selection: file
+;;year_display: project

README.md

@@ -1,69 +1,62 @@
-# Axolotlclient-Mod
-
-The mod for Axolotlclient.
-
-AxolotlClient is your customizable alternative to popular pvp clients, such as Lunar and Badlion.
-
-Our goal is to create a better environment for everyone, including you, the user.
-
-You should be in charge to decide what mods you want to use, and what data is sent to other people's servers (The only thing we use is your public UUID). This is only achievable through making everything open-source (You probably know what this means as you're currently using an open-source platform).
-
-With AxolotlClient you are deciding what to use and what not. Every aspect of the mod is toggleable in over 200 options.
-Features
-
-    Custom Skies (all formats)
-    Discord RPC
-    Player Badges
-    HUD modules
-        Ping
-        FPS
-        CPS
-        Keystrokes
-        Speed
-        Scoreboard
-        and others...
-    Hypixel mods
-        LevelHead
-        AutoGG
-        AutoTip
-        AutoBoop
-        NickHider
-    Zoom
-    Time Changer
-    Custom Block Outlines
-    Motion Blur
-    Fullbright
-
-Even better: Since we rely on existing mod loaders, you are able to add your own mods as well, even when using our custom launcher.
-
-A little overview of options is available in the Gallery
-
-For more information take a look at our Website or visit our discord server.
-Dependencies
-
-Before downloading, please also download the respective API package for your version:
-
-    1.8.9 requires Legacy Fabric API
-    1.16 (TBD) requires Fabric API
-    1.19+ requires QSL
-
-Disclaimers
-
-I do not endorse nor support cheats/hacks. If you feel like one or more options packaged by this mod could be regarded as one of the above, please let us know and we'll remove the said options.
-
-A pvp client in the context used above are launcher + game modifications combinations widely used on popular servers such as Hypixel and others. This is not meant in the context of cheats and/or hacks.
-
-This mod is part of a larger package, which is available in our launcher (and soon also modpack). Since some people wished for it separately, it is also released here. All the other mods available and/or downloaded are respective property of their authors. We do not intend to infringe any copyright. If you are the author of a mod used by us and wish for it to be removed, please let us know.
-
-To connect with things said above, the only thing that gets sent to our server is your public Minecraft account UUID. It will not be stored longer than one game session (from when you connect to a server/start a lan server to when you close the game). If you wish for your data to be deleted if it, for any instance has gotten to lure around the server longer, please also let us know and we will follow your request as soon as possible.
-Credits
-
-Credit to these wonderful people who create open-source mods.
-
-DarkKronicle, the creator of KronHUD on which the hud modules in this mod are based.
-
-AMereBagatelle, the author of the wonderful FabricSkyBoxes mod.
+# AxolotlClient-mod (1.19.2)
+
+A Complete (nearly) mod to have various features on Quilt, 1.19.2
+
+*Also available in other Languages: [Türkçe](doc/README-tr.md)*
+
+### Features
+
+- an implementation of Custom Skies
+- Zoom key
+- various Hud modules (port of [KronHUD](https://github.com/DarkKronicle/KronHUD))
+    - including, but not limited to:
+        - Chat
+        - Scoreboard
+        - CPS
+        - FPS
+        - Ping
+        - Bossbar
+        - Coordinates
+        - and others!
+- Hypixel Mods
+    - AutoGG / GF / GLHF
+    - LevelHead
+    - AutoTip
+- Custom Block Outlines
+- Discord RPC
+- Badges for players using the mod
+- and more!
+
+### Downloads
+
+[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_64h.png)](https://modrinth.com/mod/axolotlclient)
+[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/github_64h.png)](https://github.com/AxolotlClient/AxolotlClient-mod)
+
+### Contributing
+
+- feel free to join the discord to discuss new features
+- if you have a feature or a new/updated translation, feel free to open a pull request.
+- note your changes in CHANGELOG.md to be added to the next version's changelog.
 
 ### Licensing
-This mod (and all of its branches) is licensed under the LGPL 3 (or later). This means you need to give credit to the authors of the code you use in your own project.
-I also want you to modify this code in a fork of this repository (and make it public), or ask for permission first to have it in a different repo.
+
+- This mod is licensed under the LGPL-3.0 License.
+```
+AxolotlClient-mod
+Copyright (C) 2021-present moehreag + Contributors
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program; if not, write to the Free Software Foundation,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+```
+- For more information see the [LICENSE](LICENSE) file.

build.gradle

@@ -3,6 +3,7 @@ plugins {
 	id 'org.quiltmc.loom' version '1.0.+'
 	id "io.freefair.lombok" version "6.5.1"
 	id 'com.modrinth.minotaur' version '2.+'
+	id 'org.quiltmc.gradle.licenser' version '1.+'
 }
 
 archivesBaseName = project.archives_base_name
@@ -86,6 +87,11 @@ jar {
 	}
 }
 
+license {
+	rule file('HEADER')
+	include '**/*.java'
+}
+
 // Configure the maven publication
 publishing {
 	publications {

doc/README-tr.md

@@ -0,0 +1,62 @@
+# AxolotlClient-mod (1.19.2)
+
+Quilt 1.19.2'da çeşitli özelliklere sahip olmak için tamamlanmış (neredeyse) bir mod
+
+*Diğer dillerde de kullanılabilir: [English](../README.md)*
+
+### Features
+
+- Bir Özel Gökyüzü uygulanımı
+- Zoom tuşu
+- çeşitli Arayüz modülleri ([KronHUD](https://github.com/DarkKronicle/KronHUD)'un bir alınımı)
+  - bunları içerir, ama bunlarla limitli değil:
+    - Sohbet
+    - Skor Tahtası
+    - CPS
+    - FPS
+    - Gecikme
+    - Can Barı Arayüzü
+    - Koordinatlar
+    - ve başka!
+- Hypixel Modları
+  - OtomatikGG / GF / GLHF
+  - Seviye Etiketi
+  - Otomatik Bağış
+- Özel Blok Anahatları
+- Discord RPC
+- Mod'u kullanan oyuncular için rozetler
+- ve başka!
+
+### İndirme
+
+[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_64h.png)](https://modrinth.com/mod/axolotlclient)
+[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/github_64h.png)](https://github.com/AxolotlClient/AxolotlClient-mod)
+
+### Katılım
+
+- yeni özellikleri tartışmak için discord'a katıl
+- eğer bir özelliğin veya yeni/güncellenmiş çevirin varsa, bir pull request açmaya açık ol.
+- değişikliklerini sonraki sürümün güncelleme notlarına eklenmesi için CHANGELOG.md'ye not al.
+
+### Lisans
+
+- Bu mod LGPL-3.0 Lisansı altında lisanslanmıştır.
+
+NOT! Aşağıdaki gri kutunun içinde yazılan yazı gerçek lisansın bir Türkçe çevirisidir,yasal durumlarda bu lisansın sadece İngilizce hali geçerlidir.
+```
+AxolotlClient-mod
+Telif hakkı (C) 2021-günümüz moehreag + Katılımcılar
+
+Bu program özgür bir yazılımdır; bunu yeniden yayınlayabilir ve/ya da
+Özgür Yazılım Kurumunun yayınladığı GNU Daha Az Genel Herkese Açık Lisansının koşulları altında modifiye edebilirsiniz; 
+Lisansın üçüncü sürümüne, ya da (sizin kararınızda) herhangi sonraki bir sürüme göre.
+
+Bu program yararlı olması umuduyla yayınlanmıştır,
+ancak GARANTİSİZ; GEÇERLİ BİR SEBEP ile ne SPOR ne de SATILABİLİR bir zımni garantisi olmadan.  Daha fazla detay için GNU
+Daha Az Genel Herkese Açık Lisansını görün.
+
+Bu program ile GNU Daha Az Genel Herkese Açık Lisasnsının
+bir kopyasını almış olmanız gerekiyor; eğer almadıysanız, Özgür Yazılım Kurumuna yazın,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+```
+- Daha fazla bilgi için [LICENSE](../LICENSE) dosyasını görün.

src/main/java/io/github/axolotlclient/AxolotlClient.java

@@ -1,3 +1,25 @@
+/*
+ * Copyright © 2021-2022 moehreag <[email protected]> & Contributors
+ *
+ * This file is part of AxolotlClient.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * For more information, see the LICENSE file.
+ */
+
 package io.github.axolotlclient;
 
 import com.mojang.blaze3d.systems.RenderSystem;

src/main/java/io/github/axolotlclient/NetworkHelper.java

@@ -1,3 +1,25 @@
+/*
+ * Copyright © 2021-2022 moehreag <[email protected]> & Contributors
+ *
+ * This file is part of AxolotlClient.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * For more information, see the LICENSE file.
+ */
+
 package io.github.axolotlclient;
 
 import io.github.axolotlclient.util.Logger;

src/main/java/io/github/axolotlclient/config/AxolotlClientConfig.java

@@ -1,3 +1,25 @@
+/*
+ * Copyright © 2021-2022 moehreag <[email protected]> & Contributors
+ *
+ * This file is part of AxolotlClient.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * For more information, see the LICENSE file.
+ */
+
 package io.github.axolotlclient.config;
 
 import io.github.axolotlclient.AxolotlClient;

src/main/java/io/github/axolotlclient/config/modmenu/ModMenuCompat.java

@@ -1,3 +1,25 @@
+/*
+ * Copyright © 2021-2022 moehreag <[email protected]> & Contributors
+ *
+ * This file is part of AxolotlClient.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * For more information, see the LICENSE file.
+ */
+
 package io.github.axolotlclient.config.modmenu;
 
 import com.terraformersmc.modmenu.api.ConfigScreenFactory;

src/main/java/io/github/axolotlclient/config/screen/CreditsScreen.java

@@ -1,3 +1,25 @@
+/*
+ * Copyright © 2021-2022 moehreag <[email protected]> & Contributors
+ *
+ * This file is part of AxolotlClient.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * For more information, see the LICENSE file.
+ */
+
 package io.github.axolotlclient.config.screen;
 
 import com.mojang.blaze3d.glfw.Window;