EmoTracker/Getting Started: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
* Get {{Github|owner=emosaru|repo=alttpr_emotracker_emosaru|action=tree||EmoSaru's ALttP Pack}}. | * Get {{Github|owner=emosaru|repo=alttpr_emotracker_emosaru|action=tree||EmoSaru's ALttP Pack}}. | ||
* Extract it to <code>%APPDATA%/EmoTracker/packs/[custom_uid]</code> where <code>[custom_uid]</code> is a unique identifier that you want to use. | |||
* Edit {{Github|owner=emosaru|repo=alttpr_emotracker_emosaru|action=raw|manifest.json}} to have a custom <code>"name"</code> & <code>"package_uid"</code>. | |||
* Peruse [https://emotracker.net/documentation/ incomplete documentation]. | |||
= Pack Loading = | = Pack Loading = | ||
| Line 5: | Line 8: | ||
== Init Script == | == Init Script == | ||
The entrypoint is a Lua script at {{Github|owner=emosaru|repo=alttpr_emotracker_emosaru|scripts/init.lua}}. | |||
All variants will attempt to load: | All variants will attempt to load: | ||
* <code>[variant_uid]/items/common.json</code> | * <code>[variant_uid]/items/common.json</code> | ||
Revision as of 22:50, 27 May 2022
- Get
EmoSaru's ALttP Pack. - Extract it to
%APPDATA%/EmoTracker/packs/[custom_uid]where[custom_uid]is a unique identifier that you want to use. - Edit
manifest.jsonto have a custom"name"&"package_uid". - Peruse incomplete documentation.
Pack Loading
Variants work like override directories. Basically the tracker will attempt to load a path from/variant_uid/pathbefore/path
Init Script
The entrypoint is a Lua script at scripts/init.lua.
All variants will attempt to load:
[variant_uid]/items/common.json[variant_uid]/items/dugeon_items.json[variant_uid]/items/keys.json[variant_uid]/items/labels.json[variant_uid]/items/chest_proxies.json[variant_uid]/layouts/items.json[variant_uid]/layouts/tracker.json[variant_uid]/scripts/autotracking.lua
Non-items-only variants will attempt to load:
[variant_uid]/scripts/logic_common.lua[variant_uid]/scripts/logic_custom.lua[variant_uid]/maps/maps.json[variant_uid]/locations/dungeons.json
Non-inverted variants will attempt to load:
[variant_uid]/locations/overworld.json
Inverted variants will attempt to load:
[variant_uid]/inverted_locations/overworld.json
Non-keysanity variants will attempt to load:
[variant_uid]/layouts/standard_broadcast.json
Keysanity variants will attempt to load:
[variant_uid]/layouts/keysanity_broadcast.json
File Structure
| Path | Purpose |
|---|---|
| Base | |
.vscode
|
JSON Schema patterns |
images
|
Graphics: Inventory, Maps |
items
|
Item Definitions
|
layouts
|
Layout Definitions
|
locations
|
Location Definitions |
maps
|
Map Definitions |
scripts
|
Lua Scripts |
| Inverted | |
inverted
|
Inverted Variant |
inverted/images
|
Graphics: Maps |
inverted/locations
|
Overrides from base locations files |
inverted_locations
|
Overrides from base locations files |
| Inverted Keysanity | |
inverted_keysanity
|
Inverted Keysanity Variant |
inverted_keysanity/items
|
Item Definitions
|
inverted_keysanity/layouts
|
Overrides from base layouts files |
inverted_keysanity/locations
|
Overrides from base locations files |
| Items Only | |
items_only
|
Items-Only Variant |
items_only/layouts
|
Overrides from base layout files |
| Items Only: Keysanity | |
items_only_keys
|
Items-Only: Keysanity Variant |
items_only_keys/items
|
Item Definitions
|
items_only_keys/layouts
|
Overrides from base layout files |
| Keysanity | |
keysanity
|
Keysanity Variant |
keysanity/items
|
Item Definitions
|
keysanity/layouts
|
Overrides from base layouts files |
keysanity/locations
|
Overrides from base locations files |