Differences

This shows you the differences between two versions of the page.

--- project:mt:start [2023/04/05 12:03] – snarfbur
+++ project:mt:start [2026/10/23 21:53] (current) – publisher
@@ Line 1: / Line 1: @@
 ====== MapTool Projects ======
-===== MapTool - more then a map =====
+MapTool - more then a map
 Do not be fooled by the name. While it does include powerful tools for the creation of detailed maps, its primary role is a Virtual Table Top, replacing pen, paper, battle mats, and dice.
@@ Line 11: / Line 11: @@
 (From the original home page 2023-04-05)
-===== MapTool - For me imported =====
+===== MapTool - for me important =====
   * Open source
@@ Line 20: / Line 20: @@
   * Depends on nothing else
   * Has already a long lifetime
+  * Covers most things I would implement
+===== Development =====
+I found only very rudimentary rules and guidelines to contribute issues for MapTool, focusing about the steps to
+  * [[https://github.com/RPTools/maptool/wiki/Contributor-Setup-Instructions-For-MapTool|Setup Development Envirerment for MapToo]]l
+  * [[https://github.com/RPTools/maptool/wiki/Submitting-Pull-Requests|Submitting a Pull Request]]
+Beside standard branching pull & push rules, the only main rule for coding I found was about formatting the sources (before commit).
+No summary for rules or guidelines, only 3 main some hints here and there (see [[:project:mt:start#developers|Sources - Development]]). MapTool specific rules & guidelines have priority over our house rules & guidelines. Whenever I found some, I will try to summaries them here.
+==== Contributing ====
+Nothing special.
+==== Rules ====
+=== Formatting Sources ===
+The source should be following formatting rules of Google and 'gradlew spotlessApply' has to be run before any code is pushed to the original Git repository of RpTools.
+==== Guidelines ====
+Try to follow examples of the original code for coding and use there libraries and methods wherever possible. Then try to follow our house rules & guidelines.
+==== Open Source License ====
+Whenever we chance code (or other things) of the original project, we will do this under the same license agreement:
+<code>
+/*
+ * This software Copyright by the RPTools.net development team, and
+ * licensed under the Affero GPL Version 3 or, at your option, any later
+ * version.
+ *
+ * MapTool Source Code 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.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License * along with this source Code.  If not, please visit
+ * <http://www.gnu.org/licenses/> and specifically the Affero license
+ * text at <http://www.gnu.org/licenses/agpl.html>.
+ */
+</code>
 ===== Sources =====
-==== For Users ====
+==== Users ====
   * [[https://www.rptools.net/|RpTools ]]home page
@@ Line 32: / Line 80: @@
   * [[https://wiki.rptools.info/index.php/Main_Page|MapTool Wiki]]
   * [[https://www.youtube.com/playlist?list=PLpW0hwSzLqwy_dTD44WRwCHqhs-xL7xOg|German MapTool Video Tuturials]]
+==== Developers ====
+  * [[https://github.com/RPTools/maptool|GitHup Development Branch for MapTool]]
+  * [[https://github.com/RPTools/maptool/wiki/Contributor-Setup-Instructions-For-MapTool|Contributor Setup Instructions for ]][[https://github.com/RPTools/maptool/wiki/Contributor-Setup-Instructions-For-MapTool|MapToo]]l
+  * [[https://github.com/RPTools/maptool/wiki/Submitting-Pull-Requests|Submitting Pull Requests]]
+  * [[https://www.rptools.net/contributor-covenant-code-of-conduct/|Contributor Covenant Code of Conduct]]
+==== Open Source License ====
+  * [[http://www.gnu.org/licenses/|GNU Licenses]]
+  * [[http://www.gnu.org/licenses/agpl.html|Used Affero License]]