Differences

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

--- project:mt:start [2023/04/05 11:38] – created snarfbur
+++ project:mt:start [2025/01/03 11:28] (current) – old revision restored (2023/04/05 13:17) publisher
@@ Line 1: / Line 1: @@
 ====== MapTool Projects ======
-===== States (Under Construction) =====
+===== MapTool - more then a map =====
-==== Idea ====
+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.
-Currently the project is just an idea. Many thinks have to be defined, before the project can start.
+MapTool is a free, open source and extremely flexible VTT with all the bells and whistles. You can utilize the integrated server function to connect to players wherever there’s an Internet connection.
-==== Initialization ====
+Miss your buddy in Singapore? Not a problem. Roll up that character and then your sleeves.
-To start working on the project, may things have to be initialize.
+(From the original home page 2023-04-05)
-==== Under Construction ====
+===== MapTool - for me important =====
-We are working on a concrete set of issues (features).
+  * Open source
+  * Maintained
+  * Still being expanded
+  * Developed in Java
+  * Client - Server solution, where both are under user control incl. hosting)
+  * Depends on nothing else
+  * Has already a long lifetime
+  * Covers most things I would implement
-==== Maintenance ====
+===== Development =====
-No new features will be implemented, but we will try to fix bugs and adapt it to new versions of supported or used systems.
+I found only very rudimentary rules and guidelines to contribute issues for MapTool, focusing about the steps to
-==== Closed - Aborted ====
+  * [[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]]
-The project is closed and will not be finished.
+Beside standard branching pull & push rules, the only main rule for coding I found was about formatting the sources (before commit).
-==== Closed - Finished ====
+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.
-The last release is published and maintenance is closed. Maybe it will be supported somewhere else.
+==== 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 =====
+==== Users ====
+  * [[https://www.rptools.net/|RpTools ]]home page
+  * [[https://www.rptools.net/toolbox/maptool/|MapTool]] home page
+  * [[https://www.rptools.net/toolbox/download-rptools-products/|Download ]]page
+  * [[https://forums.rptools.net/|RpTools Forums]]
+  * [[https://discord.com/invite/crpk7FM|RpTools Discord]]
+  * [[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 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]]