Create holographic observations in worlds - now based on templates!
Compile a jar from the command line by doing a "Build" via Maven:
$ mvn clean package
It should show up in the target directory. Make sure to update your version number.
Manage the observations that have been created on the server.
| Command | Permission | Description |
|---|---|---|
/adminobservations |
n/a |
List all /adminobservations subcommands |
| ======= | ||
/adminobservations info |
whimc-observations.observations.info |
Show information about an observation |
/adminobservations list |
whimc-observations.observations.list |
List all observations (or filer by player and/or world) |
/adminobservations near |
whimc-observations.observations.near |
List all observations in a radius |
/adminobservations purge |
whimc-observations.observations.purge |
Purge all temporary observations |
/adminobservations reactivate |
whimc-observations.observations.reactivate |
Reactivate observations within a given time frame |
/adminobservations remove |
whimc-observations.observations.remove |
Remove an observation |
/adminobservations removeall |
whimc-observations.observations.removeall |
Remove all observations from a certain player and/or in a certain world |
/adminobservations setexpiration |
whimc-observations.observations.setexpiration |
Change the expiration date of an observation |
/adminobservations teleport |
whimc-observations.observations.teleport |
Teleport to an observation |
| ======= |
Root command for making observations.
| Command | Permission | Description |
|---|---|---|
/observe |
whimc-observations.observe |
Open a GUI to form a templated observation |
/observe <observation> |
whimc-observations.observe.freehand |
Write your own observation without a template |
If the player has the permission whimc-observations.observe.customresponse, they will be given the option to submit a custom response for their prompt fill-ins.
| Key | Type | Description |
|---|---|---|
debug |
boolean |
Enable/disable debug messages (shows queries and other information in console) |
expiration-days |
integer |
The amount of time (in days) it will take for an observation to expire |
enable-click-to-view |
boolean |
Whether clicking an observation teleports you to the view point of where it was created. Setting this to false also fixes a bug where players collide with and bounce off observations |
debug: false
expiration-days: 7
enable-click-to-view: false| Key | Type | Description |
|---|---|---|
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 |
mysql:
host: localhost
port: 3306
database: minecraft
username: user
password: pass| Key | Type | Description |
|---|---|---|
template-gui.text.write-your-own-response |
string |
The fill-in option for writing your own response. Unless overridden, the highlight color of the category is automatically applied |
template-gui.text.custom-response-sign-header |
string |
The sign header when entering a custom response |
template-gui.text.uncategorized-sign-header |
string |
The sign header when making an uncategorized observation |
|template-gui.filler-item|Minecraft material|The item to use for filler spaces in the GUI|
|template-gui.inventory-name|string|The name of the inventory used for the GUI|
|template-gui.rows|integer|The number of rows that will be in the GUI (Range [1-6])|
|template-gui.cancel.enabled|boolean (Optional, default true)|Whether to show this item in the GUI (default true)|
|template-gui.cancel.item|Minecraft material|The item to use for the cancel button|
|template-gui.cancel.position|integer|The position of the cancel button|
|template-gui.cancel.name|string|The text to display for the cancel button|
|template-gui.cancel.lore|string list|The lore of the cancel button|
|template-gui.uncategorized.enabled|boolean (Optional, default true)|Whether to show this item in the GUI (default true)|
|template-gui.uncategorized.item|Minecraft material|The item to use for the uncategorized observation button|
|template-gui.uncategorized.position|integer|The position of the uncategorized button|
|template-gui.uncategorized.name|string|The text to display for the uncategorized button|
|template-gui.uncategorized.lore|string list|The lore of the uncategorized button|
template-gui:
text:
write-your-own-response: "Write your own response"
custom-response-sign-header: "&f&nYour Response"
uncategorized-sign-header: "&f&nYour Observation"
filler-item: white_stained_glass_pane
inventory-name: "&lChoose an observation type!"
rows: 4
cancel:
enabled: true
item: barrier
position: 27
name: "&cCancel"
lore:
- "&7Cancel your observation"
uncategorized:
enabled: true
item: oak_sign
position: 35
name: '&7Uncategorized Observation'
lore:
- '&fMake a custom observation without a template.'
- ''
- '&8&oThis can also be done with &7&o/observe <observation>'There are 5 observation categories supported by the plugin: ANALOGY, COMPARATIVE, DESCRIPTIVE, INFERENCE, and QUESTION
| Key | Type | Description |
|---|---|---|
templates.<category>.gui.enabled |
boolean (Optional, default true) |
Whether or not to show this item in the GUI |
templates.<category>.gui.item |
Minecraft material |
The item to use for this category in the GUI |
templates.<category>.gui.position |
integer |
The position of the category's item |
templates.<category>.gui.name |
string |
The name of the category's item |
templates.<category>.gui.lore |
string list |
The lore of the category's item |
templates.<category>.prompts |
prompt list |
A list of prompts |
Each prompt has the prompt itself and a list of world-specific fill-ins for the prompt.
Within the prompt, a fill-in is notated via {}. A prompt can have as many fill-ins as you'd like.
You'll use the index of each {} to configure the fill-ins for that prompt in a given world.
- prompt: The {} is {}.
worlds:
world1: # These options will only be shown for players in world1
0: # These will be the fill-ins for the first {}
- moon
- water level
1: # These will be the fill-ins for the second {}
- large
- missing
- low
- high
world2: # These options will only be shown for players in world2
# ...templates:
DESCRIPTIVE:
gui:
enabled: true
item: orange_concrete
position: 13
name: '&6Descriptive Observation'
lore:
- '&fRelated to color, temperature, quantity, and other physical attributes.'
- ''
- '&7Example:'
- ' &f&o There are lots of trees.'
prompts:
- prompt: There are lots of &7{}&r.
worlds:
world:
0:
- coral
- trees
- prompt: There are no &7{}&r.
worlds:
world:
0:
- animals
- plants
- prompt: It is really &7{}&r.
worlds:
world:
0:
- hot
- cold
- prompt: The &7{}&r is &7{}&r.
worlds:
world:
0:
- moon
- water level
1:
- large
- missing
- low
- high