Skip to content

Commit

Permalink
Remove Abeille guide and unused XML
Browse files Browse the repository at this point in the history
Abeille reads the forms in
src/main/resources/net/rptools/maptool/client/ui/forms/
but the UI is managed by `*View.form` files in
src/main/java/net/rptools/maptool/client/ui/
and Abeille is no longer used in favour of the IntelliJ forms designer.

To reduce confusion about which tools to use,
this commit replaces the documentation about Abeille
and removes its config files.
  • Loading branch information
fishface60 committed Jan 19, 2025
1 parent 109544c commit 3626d66
Show file tree
Hide file tree
Showing 28 changed files with 2 additions and 66,866 deletions.
13 changes: 2 additions & 11 deletions doc/How_To_Setup_UI_Tools.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
How To Setup User Interface (UI) Tools for MapTool
==================================================

You thought you were done? Sorry, there are two extra things you may wish to consider and both are related to managing UI elements within Maptool. The current edition of the tool uses **Abeille** to manage **Swing** elements within the design. Abeille is a WYSIWYG form designer for Swing objects and if you plan on modifying any of the UI elements you should definitely install the Abeille Designer.
You thought you were done? Sorry, there are two extra things you may wish to consider and both are related to managing UI elements within Maptool. The current edition of the tool uses **IntelliJ** to manage **Swing** elements within the design. Just open the `.form` files and install the plugin when prompted.

As Swing is now deprecated within Java the plan is to move those elements over to **JavaFX**, although this work is further down the line at the moment. If you want to get to grips with JavaFX, you should probably install the Eclipse Plugin **e(fx)clipse** and the **JavaFX Scene Builder**. Scene Builder is also a WYSIWYG form designer, but this time for JavaFX Objects.

Install Abeille
----------------

1. Go to the [Abeille Downloads page](https://java.net/projects/abeille/downloads/directory/Abeille%20Form%20Designer%202.1.0%20M3) and download the latest binaries. This is a closed project so they are quite old. The binaries are jar files so you can simply unzip the folder to anywhere on your PC, such as `C:\Program Files (x86)\abeille-2.1.0_M3`
* As the Abeille downloads are now offline the last version has been attached here: [abeille-2.1.0_M3.zip](https://github.com/RPTools/maptool/files/6554805/abeille-2.1.0_M3.zip)
2. Launch the Designer by running the `designer.jar` file in the `abeille-2.1.0_M3` directory. If you have installed Java as described elsewhere, you can just right click the file and select **Open**
3. Once the Designer is running, you need to create a new project for the MapTool forms. Call this file `maptool.jfpr` and save it anywhere you like, BUT NOT in the Eclipse MapTool project directory, as you do not want this file to become part of the MapTool project and is only used by you locally.
4. Add the MapTool resource directory as a Source path for your Abeille Project. On the Abeille Project Settings screen you should see a button in the Source Tab to **Add Path**. Click this and navigate to the resource directory. For example, if your Eclipse workspace directory was `C:\Workspace` and your top level MapTool project was called `C:\Workspace\maptool` you should add the path `C:\Workspace\maptool\maptool\src\main\resources`. This is very important, otherwise the Albeille Designer will save the local path names into the designer files rather than the relative paths that are needed for proper distribution.

Install e(fx)clipse Plugin
--------------------------

Expand All @@ -29,4 +20,4 @@ Install JavaFX Scene Builder

The JavaFX Scene Builder application has been handed over to the open source community and as a consequence it can be hard to find the Scene Builder install. The latest version as of this writing is SceneBuilder 10.0.0 and is available from [GluonHQ.com](https://gluonhq.com/products/scene-builder/)

Download and install SceneBuilder. It can now be used to open **.fxml** files which are the JavaFX equivalent to Abeille files (above).
Download and install SceneBuilder. It can now be used to open **.fxml** files which are the JavaFX equivalent to `.form` files (above).
1,760 changes: 0 additions & 1,760 deletions src/main/resources/net/rptools/maptool/client/ui/forms/addResourcesDialog.xml

This file was deleted.

This file was deleted.

This file was deleted.

1,084 changes: 0 additions & 1,084 deletions src/main/resources/net/rptools/maptool/client/ui/forms/adjustGridDialog.xml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

1,497 changes: 0 additions & 1,497 deletions src/main/resources/net/rptools/maptool/client/ui/forms/colorPanel.xml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

1,080 changes: 0 additions & 1,080 deletions src/main/resources/net/rptools/maptool/client/ui/forms/editLookupTablePanel.xml

This file was deleted.

3,149 changes: 0 additions & 3,149 deletions src/main/resources/net/rptools/maptool/client/ui/forms/exportDialog.xml

This file was deleted.

This file was deleted.

Loading

0 comments on commit 3626d66

Please sign in to comment.