Home

Welcome to the Goldfish wiki!

Functional Specification

#Goldfish Specification

• Goldfish should create a temporary instance of a given map
• Needs to be able to remove the map, either via timing or lack of players (which starts a timer)*
• ^ Needs to be able to track players within it for the purposes of that timer
• Admin commands to send or pull players to/from an instance, rather than just using a location (mostly for NPC use)

Portals? Should they be in our system or should we externalize (voxelport)? If internalizing:

• Can be configured for geometric spaces, stores x & y locations for cubes
• ^ Should have internal portals that can move players back and forth into and out of instances (for example, returning a player to their previous location or moving them on to the next ‘phase’ of a map)

#Accessing and Using Goldfish

• Can link a given folder via in-game commands, linking it with an internal reference name so that commands can be executed using that reference name (keep map name separate from name/description)
• Instances have a name and description (likely held inside a txt file within the specified folder) - this does not necessarily need to be the same as the internal name
• Map Instances should be configured through a text file
• Map availability times* (When does it happen, how often does it recur?)
• Block/Chest/Button protections called out within the config file, both granular and across the board
• ^ Whitelist/Blacklists for data values/blocks

#Players and Goldfish

• Needs an adjustable cooldown applied to a player*
• May require specific loadouts or items from players, or possibly no items at all
• ^ Should return if the prior conditions are not met
• Able to set spawn from death to another world or location?*

[* = Configurable]

Not Necessary Yet: ((Need to consider how worldguard works with this, and how we can remove it))