User:Taz/Project:Client Technical References
Game Client Technical References Project
One thing missing from this wiki is details on various files created and used by the LotRO game client. Most things are (and should be) done within the client itself, which (should) properly handle these files, but sometimes you have to get your hands dirty. This project aims to provide some documentation to facilitate your digging.
lotro.keymap
My own personal obsession: input mechanisms. I've written up a basic technical reference which covers syntax, provides example tables, maps in-game options to functions found within the file, lists functions unavailable in the game options, and lists functions that appear in the file but just plain don't work for regular players. I also forsee a use for a up-to-date copy of the default keymap, which should be updated as the game client is updated.
Eventually these should lead to an updated Game Controls (or Keymap, or Keybindings) article, providing an up-to-date keyboard layout diagram and quick overview of default keybinds, and also removing the need to include details of such game controls from the Commands article. They would also be useful reference articles for a new-player guide -- Keybinding 101 Guide.
Proposed articles (name suggestions welcome):
- lotro.keymap ?? brief overview, safe handling instructions, backup strategies?
- lotro.keymap Technical Reference -- basically User:Taz/Scratchpad-lotro.keymap Reference
- lotro.keymap/Current Default -- basically User:Taz/Scratchpad-Default lotro.keymap, add creation instructions, keep up-to-date as game client updates are released
- Game Controls -- high-level overview of defaults, links to other articles
- Keybinding 101 Guide -- something to tell new players hey you should change that X keybind like right now!!
UserPreferences.ini
If there's a tech reference for lotro.keymap there might as well be one for UserPreferences.ini. Same basic idea: cover syntax (basic .INI) and what the various sections are for, show which settings are changed by which in-game options, list and explain (when possible) which settings are not changed by in-game options.
Proposed articles (mirroring the lotro.keymap articles):
- UserPreferences.ini ?? brief overview, safe handling instructions, backup strategies?
- UserPreferences.ini Technical Reference -- reference document
- UserPreferences.ini/Current Default -- up-to-date default sample? (this file contains user-specific information and will need to include instructions on scrubbing to avoid leaking account information for those providing the sample)
- other links TBD
- player guides?
ui/layout/foo.layout
The in-game command '/ui layout save foo' creates an XML file containing UI element positions, aliases, and (some but not all) Options settings. The mirror command '/ui layout load foo' will apply these positions, aliases and options to the currently logged-in character. While alterations to this file are probably best made within the game client, a reference to the file format might be handy for someone.
Proposed articles (again, mirroring the lotro.keymap articles):
- UI layout XML -- brief overview, safe handling, backup strategies
- UI layout XML Technical Reference -- reference document
- UI layout XML/Current Default -- up-to-date default sample (should be obtainable by reverting UI and options to default and issuing '/ui layout save default')
- other links TBD
- player guides?
Other game files
- More articles directed to plugin writers?
- basic client file backup and hygiene?
- %gameinstalldir%/TurbineLauncher.exe.config -- editing required(?) to convert from main game client to "legacy client" (launcher option)
- game client dat-file documentation, as near as can be determined?
- ???
Other technical articles
- slash-command references (maybe named Command/commandname, consisting of the in-game /help text for that command, and examples as needed)
- detailed chat window reference (ie creating links and custom text colors manually, assuming possible, or details of how plugins accomplish it)