JavaFX based TweetWall

Prerequisites

• JDK 17+ to run the Gradle wrapper (Gradle 9.8.1 requirement). The wrapper will not start on older JDKs.

• Java toolchain: Compilation, testing, and Javadoc use Gradle’s Java toolchain (configurable; defaults to 27 locally via JAVA_PLATFORM_VERSION, CI uses JDK 25–27).

• Git

• Internet access for downloading Gradle dependencies

• OS-specific notes: JavaFX platform classifier is auto-detected (macOS, Windows, Linux; aarch64 handled)

Quickstart

Build

Clone the repository and build with the Gradle wrapper:

./gradlew build

This runs assemble, test, and check (including Spotless formatting checks and Javadoc generation).

Run (generic2d)

The generic2d module provides a runnable 2D TweetWallFX application. To run it:

./gradlew :tweetwallfx-generic2d:run

Other variants include :tweetwallfx-2d (if configured as runnable). Note: the 3d module is currently disabled in settings.gradle.

Configuration

TweetWallFX loads configuration from tweetwallConfig.json files:

1. From classpath (standard config files included in modules)

2. From filesystem (working directory)

You can override the filename with the system property:

-Dorg.tweetwall.config.fileName=my-tweetwall-config.json

Configuration fragments from modules are merged. Additional configuration URLs can be specified via the configuration settings. The main runtime settings are defined in TweetwallSettings (query, title, stylesheetResource, stylesheetFile, etc.).

A minimal example:

{
  "tweetwall": {
    "query": "#myevent OR #someothertag",
    "title": "My TweetWall",
    "stylesheetResource": "tweetwall.css"
  }
}

Getting OAuth keys

Create a new Application for TweetWall within Twitter Apps site signing in with the twitter account that will be used to run the TweetWallFX. You have to enter at least the website of your company. After doing so generate a new access token under Keys and Access Tokens.

Update the tweetwallConfig.json file with your OAuth values as follows:

{
    "twitter" : {
        "extendedMode" : true,
        "oauth" : {
            "consumerKey" : "v8SvGzboGrvU148cKs8PghI1v", (1)
            "consumerSecret" : "12w6vg612hgvoGk0iysMlLvKfh0ouMcVg00RWG8rV6jccZ8RUg", (2)
            "accessToken" : "12cF34j9-cF3cGz819x4j2iQ6Vgh4wqmLqksxHzRFt78D3WKiB", (3)
            "accessTokenSecret" : "2DghUiSB5hdg7jFbNKHqx5xRkXNZhnzZtICUPG7Bz92x4" (4)
        }
    },
    "tweetwall" : {
        "query" : "#myevent OR #someothertag",
        "title" : "The JavaFX Tweetwall for my Event",
        "stylesheetResource" : "tweetwall.css"
    }
}

1. The Consumer Key (API Key)

2. The Consumer Secret (API Secret)

3. The Access Token

4. The Access Token Secret

Run

Run the generic 2D application using Gradle:

./gradlew :tweetwallfx-generic2d:run

Key shortcuts (when running generic2d): - D - Toggle status line - F - Toggle fullscreen - R - Restart - X or Q - Exit

Troubleshooting

JDK Version

Ensure you’re using JDK 17+. The build enforces this in settings.gradle. Check with java -version.

JavaFX Platform Issues

JavaFX dependencies are resolved by platform classifier (mac/win/linux, aarch64). If you encounter platform-specific issues, verify your OS/arch matches what Gradle detects.

OAuth/Twitter API

For Twitter/X, ensure your API keys are correctly set in your config file. Note that API access requirements may have changed - also check tweet-impl-mastodon4j or tweet-impl-mock modules for alternative data sources.

Build Issues

If the build fails due to formatting, run: ./gradlew spotlessApply. For dependency refresh issues, try: ./gradlew --refresh-dependencies build.