Home

Welcome to the Pingy wiki!

Prerequisites

• Java 8

Downloads

• Releases
• Snapshots

Installation

1. Download the latest (or recommend) Pingy build.
2. Create a start script for the server, for example a batch script named pingy-start.bat:

   java -jar pingy-1.0.0-SNAPSHOT.jar
   PAUSE
   

3. Start the server with the start script you just created and let it generate the configuration file.
4. Shut the server down and modify the configuration file pingy.json (by default).
5. Start the server once again.
6. Profit!

Configuration

{
  // The ip address that server should be bound to.
  "ip": "",
  // The port that server should be bound to.
  "port": 25565,
  // Whether the server should use epoll if it's available.
  "use-epoll-when-available": true,
  // The message of the day (motd), is displayed under the server name.
  // Supports the new line character '\n' and json text format.
  "message-of-the-day": "Pingy was here...",
  // The message of the day (motd), is displayed under the server name.
  // Supports only one line, this is only used for the clients of 1.6 and older.
  "legacy-message-of-the-day": "Pingy was here... This client is old...",
  // The message that is displayed in the right top corner.
  "outdated-message": "Move along...",
  // The tooltip that will be displayed when hovering of the 'outdated-message'.
  // Supports the new line character '\n'.
  "outdated-message-tooltip": "",
  // The message that will be displayed when a player tries to join the server.
  // Supports the new line character '\n' and json text format.
  "disconnect-message": "Why are you even trying...",
  // The message that will be displayed when a player tries to join the server.
  // This is only used for the clients of 1.6 and older.
  "legacy-disconnect-message": "Why are you even trying...",
  // The path of the favicon file, leave this empty if you want to disable it.
  // The path is relative to the server root.
  "favicon": ""
}

Advanced

You can also provide some launch flags to the application.

Flag	Description
--config-path <path>	The path of the configuration file, relative to the server root.
--cp <path>	''
--debug [true|false]	Whether the debug mode should be enabled, displays more messages. Will fallback to true if no value is specified.
--d [true|false]	''

For example:

java -jar pingy-1.0.0-SNAPSHOT.jar --cp path/to/my/config.json