====== GPHUD ======


Note : we recommend at least skim reading the below links and trying to grasp the core concepts - things such as UI configuration, commands, aliases and templates are pretty core to creating a deeper experience within GPHUD, **however** GPHUD continues to evolve over time and it's likely this documentation will be eternally incomplete...


:!: NOTE:  The Region Server used to use * as a command prefix, but now uses <nowiki>**, please let me know of any places in the documentation where this seems to be wrong, but e.g. where you would formerly type *characters.status you must now type **characters.status</nowiki>


To this end, perhaps the most useful documentation is in the built in module "[[Introspection]]", the documentation here is not created by humans, but is automatically generated by GPHUD which looks at its self (introspects) to see what features are available, as such the [[Introspection]] information is always completely accurate and up to date, and entries will appear and disappear in these sections as you create attributes, templates and so on.

[[FAQ|Frequently Asked Questions]]

[[Data Retention|Data Retention Policy]]

===== Useful resources =====
  * [[https://sl.coagulate.net/GPHUD/ChangeLog|Latest release notes]] - details all changes to the code, new features, bug fixes, etc
  * [[secondlife:///app/group/2a6790d0-c594-7467-804b-c8e398970188/about|Optional "open access" notices group]] - used to push notices when a release is made, subscribe to this group if you want to know about new releases/feature being deployed
  * [[https://github.com/CoagulateSL/GPHUD/issues|GitHub issue tracker]] - go here to report bugs, or make feature requests
  * [[https://github.com/CoagulateSL/GPHUD/projects|GitHub project roadmap]] - things I'll get around to "one of these years"

===== HOWTOs =====
[[Cookbooks]] are a new feature in GPHUD v1.5 and provide automatic configuration of the service, we recommend you read the options herein.
  * [[User Guide|Basic User Information]]
  * [[Differences between RPHUD]]
  * [[Creating a new installation]]
  * [[Extending an instance]]
  * [[Attaching a HUD]]
  * [[Create and use ability attributes]] - basically any numeric based attributes
  * [[Create races, classes]] - group based attributes
  * [[Create and use free form fields]] - text fields
  * [[Create custom rolls]] - including using attributes
  * [[Configure the user experience]] - changing the logo, quick buttons, and dialog menus
  * [[Configure multi-character support]]
  * [[Configure the character sheet commands]] - view / show / look
  * [[Configure ability points]] - the ability for the end user to increase their base ability points as they progress
  * [[Configuring Health]] - the various nuances of configuring the Health module
  * [[Configuring Item Giving]] - adding functionality to the HUD to receive items (notecards, landmarks, other)
  * [[Adding a link to your own website]] - how to create a button that links to your own sites
  * [[Adding your own type of XP]] - how to create configure and award a new category of XP
  * [[Get emergency access to your configuration]] - Broken the HUD? need to access the config to fix the thing breaking startup?
  * [[Configuring an NPC guard]] - How to create a building with a guarded entrance, as an example of what can be done.
  * [[How to set up an "on contact" teleporter]] - A phantom object, a portal, gateway, can also be used to teleport people to places through scripting!
  * [[How to log in to the GPHUD website]] - A list of the numerous ways of connecting to the GPHUD website

=====Entities in GPHUD=====
  * [[BasicEntities|Basic Entities (Instance, Region, Module, Avatar, Charater)]]
  * [[Pool|Pools]]
  * [[KV|KVs (Key Value pairs)]]
  * [[Sets|Sets]]
  * [[Inventories|Inventories]]
  * [[CharacterGroup|Character groups]]
  * [[PermissionsGroup|Avatar groups / permissions groups]]
  * [[Zone|Zones]]
  * [[Event|Events]]
  * [[Menu|Menus (as in Dialog menus for the HUD)]]
  * [[Command|Commands]]
  * [[Alias|Aliases]]
  * [[Experience|Experience, ability points, levels and so forth]]
  * [[Attributes]]
  * [[Templates]]
  * [[Cookbooks]]
  * [[Effects]]

=====Modules=====
Core
  * [[Alias]] - creation of user commands, wrappers around the more open ended commands
  * [[Audit]] - logging module
  * [[Characters]] - handles character sheets and per character attribute creation/management
  * [[Configuration]] - general purpose configuration utility
  * [[GPHUDClient]] - interface for the GPHUD client (the HUD)
  * [[GPHUDServer]] - interface for the GPHUD server (the on-sim per-region server)
  * [[Instance]] - controls "instance wide" content
  * [[Introspection]] - allows looking into the inner workings of GPHUD
  * [[Menus]] - presents dialog menus
  * [[PermissionsGroups]] - manages avatar administrative permissions
  * [[User]] - manages users
Optional
  * [[Currency]] - allows one or more transactional currencies to be implemented.
  * [[Effects]] - applies temporary status effects or modifiers to a character
  * [[Events]] - manages events that take place at scheduled times in certain zones.  xp may be awarded for attendance.
  * [[Experience]] - manages character experience, ability points, levels and so forth.
  * [[External]] - allows external API access to your instance.
  * [[Faction]] - manages character factions, allows factions to have leaders, delegated admins, award faction xp, invite, eject, etc etc.
  * [[Groups]] - supports character groupings, e.g. race, class, rank
  * [[Health]] - implements a health pool and some damage/healing
  * [[ItemGiver]] - allows items to be given to end users
  * [[Notes]] - allows admin notes, shared or private, to be stored against characters and avatars
  * [[Objects]] - allows interactive objects - on click, on collision or scripted NPCs
  * [[Publishing]] - allows publishing of various information which can be included in an external website (i.e. your sim's website)
  * [[Roller]] - manages various forms of "dice rolling"
  * [[Scripting]] - allows scripted sequences of events ([[Example Scripts|See here for example scripts]])
  * [[Teleportation]] - provides a few functional items for teleporting avatars around, e.g. portals, entry guards, leaving the OOC area to a home-zone
  * [[TemplateWrapper]] - wraps other templates with prefix/suffix characters, e.g. "MyGuild" -> "<MyGuild>" but maintaining "" -> "" (i.e. doesn't surround no-text)
  * [[Zoning]] - allows regions to be cut into zones, allowing per-zone modifications, or events in a zone

=====Developer Resources=====

  * [[https://sl.coagulate.net/GPHUD/ChangeLog|Release Notes]]
  * [[External Access API]]
  * [[The joys of rolling XP periods and why you get an XP on login]]
  * [[Upcoming features]]
  * [[Open Source]]
  * [[Network Protocol]] (out of date, though still valid)
  * [[Java Process Flow|Requests / Events - Process Flow]]