Changes between Version 11 and Version 12 of BuildingWorldPainter

Timestamp:

06/06/20 17:13:33 (4 years ago)

Author:

admin

Comment:

--

BuildingWorldPainter

@@ -10 +10 @@
 
 !WorldPainter is a large and complex program. You'll need a good understanding of Java (up to version 8) to be able to understand the code and work on it. If you want to work on the GUI you'll need at least a good working knowledge of Swing as well. Since the build system is Maven, you'll need some experience with that as well, including how to install artifacts in your local Maven repository, which you will need to do below.
+
+== Using !WorldPainter in your own code
+
+If you only want to write your own code _making use of_ !WorldPainter, rather than make changes to !WorldPainter itself, then you don't need to build !WorldPainter! The !WorldPainter binaries, along with Javadoc and source code jars, are in Maven Central. Just declare the following dependency if you just need the core (and not any GUI components):
+
+{{{#!xml
+<dependency>
+    <groupId>org.pepsoft.worldpainter</groupId>
+    <artifactId>WPCore</artifactId>
+    <version>2.7.12</version>
+</dependency>
+}}}
+
+(Of course replace the version number with the most recent version of !WorldPainter.)
+
+This will allow you to load and save !WorldPainter worlds, read their contents and make changes, Export them to Minecraft, or Import Minecraft maps as !WorldPainter worlds. This should be enough for most uses. But if you need GUI components in addition, use the following dependency.
+
+{{{#!xml
+<dependency>
+    <groupId>org.pepsoft.worldpainter</groupId>
+    <artifactId>WPGUI</artifactId>
+    <version>2.7.12</version>
+</dependency>
+}}}
+
+For more details about these packages and other ways to declare the dependencies, see: https://mvnrepository.com/artifact/org.pepsoft.worldpainter
 
 = Check out the source code