WHIMC-ScienceTools

ScienceTools is a Minecraft plugin to simulate values for scientific tools. This plugin uses WorldGuard to define regions in which to set scientific values. To set values, edit the config file.

Requires Java 11+

---

Building

Build the source with Maven:

$ mvn install

---

Configuration

The config file can be found under /plugins/WHIMC-ScienceTools/config.yml. Use /sciencetools reload whenever you change the config.

MySQL

In order to track the history of science tool usage, you have to connect to a SQL database.

Key	Type	Description
mysql.enabled	boolean	Whether to use a SQL database
mysql.host	string	The host of the database
mysql.port	integer	The port of the database
mysql.database	string	The name of the database to use
mysql.username	string	Username for credentials
mysql.password	string	Password for credentials

Example

mysql:
  enabled: true
  host: localhost
  port: 3306
  database: minecraft
  username: user
  password: pass

Messages

Messages can have either global or tool-specific scope. The global config messages should define all message types. Tool-specific config messages do not need to define all message types, and will default to the global messages config if an undefined message type is needed to display to the player.

Messages config will look like this:

messages:
  # The measure message to display
  measure-format: 
  # The numerical measure message to display
  numeric-measure-format: 
  # The disabled world message to display 
  disabled-in-world: 

Example for global config messages:

messages:
  measure-format: '{MEASUREMENT}'
  numeric-measure-format: 'The measured {TOOL} is {MEASUREMENT}{UNIT}'
  disabled-in-world: "We don't know how to measure that here"

Example for tool-specific config messages:

tools:
  ALTITUDE:
    display-name: "altitude"
    messages:
      disabled-in-world: "{TOOL} cannot be measured here"

Placeholders

Placeholder	Description
{MEASUREMENT}	The measurement of the tool at the player's position
{TOOL}	The display name of the tool
{UNIT}	The unit of the tool measurement

Unit Conversions

Unit conversions config will look like this:

conversions:
  # The name of the conversion 
  conversion_name:
    # The expression that will be used to convert the value
    expression: "{VAL} * 1.0"
    # The unit of the conversion
    unit: "unit"

Example:

conversions:
  fahrenheit: # Celsius -> Fahrenheit
    expression: "({VAL} * 9.0 / 5.0) + 32.0"
    unit: "°F"
  feet: # Meters -> Feet
    expression: "{VAL} * 3.28084"
    unit: "ft"

Placeholders

Placeholder	Description
{VAL}	The value that is being converted

Science Tools

A science tool can either be string-based or numeric. The default-measurement will determine this behavior. If the default-measurement is valid JavaScript syntax, the tool will be considered numeric. Numeric science tools have extra options for configuration.

String-based science tool example:

tools:
  # The tool key
  STRING_TOOL:
    # (optional: defaults to the tool key) A formatted version of the tool
    display-name: "String Tool"
    # The default fallback measurement to be used
    default-measurement: "Value"
    # (optional) World settings
    worlds:
      # Name of the world to configure
      WorldName:
        # (optional: Defaults to `default-expression`)
        #  The fallback measurement for this world
        global-measurement: "Value within worldName"
        # (optional) Region-specific measurements
        regions:
          region1: "Value within region1"
          region2: "Value within region2"
    # (optional) List of worlds where this tool cannot be measured
    disabled-worlds:
      - disabledWorld1
      - disabledWorld2

Numeric science tool example:

tools:
  NUMERIC_TOOL:
    display-name: "Numeric Tool"
    default-measurement: "1 + 1"
    
    # The following are for numeric science tools only!

    # The unit of the tool
    unit: "m"
    # The number of decimals to show in the printout
    precision: 4
    # A list of conversions that will be showed with the tool's printout
    conversions:
      - conversion_name

Region names are defined using WorldGuard.

Placeholders

Placeholder	Description
{X}	The player's current X position
{Y}	The player's current Y position
{Z}	The player's current Z position
{TIME_TICKS}	The time of the world in ticks
{NIGHT}	0 if daytime, 1 otherwise
{WEATHER}	0 if the weather is clear, 1 otherwise
rand(min, max)	A random decimal between min and max (inclusive)
randInt(min, max)	A random integer between min and max (inclusive)
min(a, b)	The minimum between a and b
max(a, b)	The maximum between a and b
{<tool key>}	The value from the given numeric tool

Validation

Validation config will look like this:

validation:
  # Amount of 'wiggle room' given when accepting answers
  tolerance: 10
  # time (in seconds) until timeout
  timeout: 30
  messages:
    prompt:
      all:
        - '&8> The message to send'
        - '&8> The next line of the message to send'
      TOOLNAME:
        - '&8> The message to send'
    timeout:
      all:
        - '&8> The message to send'
      TOOLNAME:
        - '&8> The message to send'
    no-number:
      all:
        - '&8> The message to send'
      TOOLNAME:
        - '&8> The message to send'
    found-number:
      all: []
    success:
      all:
        - '&8> The message to send'
      TOOLNAME:
        - '&8> The message to send'
    failure:
      all:
        - '&8> The message to send'
      TOOLNAME:
        - '&8> The message to send'
  commands:
    prompt:
      all: []
    timeout:
      all: []
    no-number:
      all: []
    found-number:
      all: []
    success:
      all: []
      TOOLNAME:
        - "The action"

Example Using Quests:

validation:
  tolerance: 1.0
  timeout: 30
  messages:
    prompt:
      all:
        - '&8>'
        - '&8> &7&lData Entry Computer &7&o(v2.0)'
        - '&8>'
        - '&8>   &7Current {TOOL}: &8Unknown'
        - '&8>'
        - '&8>   &7Please type the {TOOL} value you just measured:'
        - '&8>'
    timeout:
      all:
        - '&8>'
        - '&8> &7Computer left idle.'
        - '&8> &7Logging off... Goodbye!'
        - '&8>'
    no-number:
      all:
        - '&8> &cNo numbers detected!'
        - '&8> &7Click the computer to try again!'
    found-number:
      all: []
    success:
      all:
        - '&8> &7Value updated!'
        - '&8> &7Current {TOOL}: &a{VAL}{UNIT}'
    failure:
      all:
        - '&8> &e{VAL}{UNIT}&7 does not match the range of possible data.'
        - '&8> &7Click the computer to try again!'
      TEMPERATURE:
        - "&8>   &7If you're stuck, talk to &fMisavo&7 again!"
      PRESSURE:
        - "&8>   &7If you're stuck, talk to &fHarlem&7 again!"
      WIND:
        - "&8>   &7If you're stuck, talk to &fHuxley&7 again!"
      OXYGEN:
        - "&8>   &7If you're stuck, talk to &fOlivia&7 again!"
  commands:
    prompt:
      all: []
    timeout:
      all: []
    no-number:
      all: []
    found-number:
      all: []
    success:
      all: []
      ALTITUDE:
      - "questadmin nextstage {PLAYER} Ice on Fire!"
      TEMPERATURE:
      - "questadmin nextstage {PLAYER} What's Cooler Than Being Cool?"
      PRESSURE:
      - 'questadmin nextstage {PLAYER} Feeling the Pressure'
      WIND:
      - 'questadmin nextstage {PLAYER} Not-So-Solar-Wind'
      OXYGEN:
      - 'questadmin nextstage {PLAYER} A Breath of Fresh Air'
      RADIATION:
      - 'questadmin nextstage {PLAYER} Seas of Lava?'

Placeholders

Placeholder	Description
{TOOL}	The current science tool
{VAL}	The provided value
{UNIT}	The current science tool's units
{PLAYER}	The target player

---

Commands

Command	Description
/sciencetools	Display command help
/sciencetools validate <tool> <player>	Take the value of the tool at the target player's current location
/sciencetools validate <tool> <player> <world> <x> <y> <z>	Take the value of the tool at the provided location
/sciencetools reload	Reload the plugin's config
/sciencetools js	Run interpreted JavaScript
/sciencetools measure <tool>	Measure the given science tool
/sciencetools history <player>	View the science tool usage history of a player

 

Using /sciencetools validate OXYGEN MyName when standing on LunarCrater (outdoors) on our server will open a data entry computer prompt in the chat that accepts a value (input by typing a number in the chat). It will want a value of 0.0% since the oxygen levels on the moon are at 0.0%.

Using /sciencetools validate PRESSURE MyName LunarCrater 40 22 37 on our server will open a data entry computer prompt in the chat that accepts a value (input by typing a number in the chat). It will want a value 101.30kPa since the specified coordinates are in a specific building with a different pressure than the outside (0kPa).

---

Dependencies

• WorldGuard