ludevnet/lu-explorer

An angular.io webapp that displays LEGO Universe game data

LuExplorer

General

This project was generated with Angular CLI.

Prerequisites

• git
• npm to build the app
• cargo to build the API server
• A copy of a LEGO Universe client.

Development setup

Generally, LU-Explorer needs a datasource, which is provided by the Paradox Server. That server provides the data from the game database to the web interface, which makes it a core component of this app.

This needs a paradox.toml config file in the working directory – a minimal example is provided here. The most important part is to point the explorer_spa key to the docs folder in this repo and the cdclient and locale key to a copy of CDClient.fdb and locale.xml respectively.

1. install npm and cargo (via https://rustup.rs)

2. install the API server binary with

   $ cargo install --git https://github.com/Xiphoseer/lu-res-api-server.git --branch main

3. Then, clone this repo and create lu-res and client folders next to it

   $ git clone https://github.com/Xiphoseer/lu-explorer.git
   $ mkdir lu-res client

4. Put at least locale/locale.xml and res/cdclient.fdb from an LU client into this client folder

5. You can now build the lu-explorer web-app continuously with

   $ cd lu-explorer
   $ npm install
   $ ng build --watch

6. Finally, run the API server, which will also serve the web-app

   $ RUST_LOG=info paradox-server

For now, you need to restart that server whenever you change the lu-explorer source. (Issue #1)

Minimal setup

The alternative is to:

1. point data.apiUrl in src/environments/environment.ts to an existing API server.
2. point /lu-res in src/proxy.conf.json to a matching version of lu-res.

Then run

$ npm install
$ ng serve

Docker Setup

1. Build: docker build -t paradox-server
2. Deploy:

Replace the paths on the left of the mappings to reflect your system:

  docker run -it --rm \
    --name paradox-server \
    -e DOMAIN=your.domain.tld \
    -e USERNAME=<username> \
    -e PASSWORD=<password> \
    -v /path/to/client:/luclient \
    -v /path/to/cache:/cache/lu-res \
    -p 3030:3030 \
    paradox-server

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the docs/ directory. Use the --configuration production flag for a production build. For building to github pages also use --base-href=/lu-explorer/.

Usually, the ng build --configuration production command is used.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

lu-explorer's Issues

missionsToUpdate empty

Check: https://lu-explorer.web.app/scripts/zone/ag/l_zone_ag_survival.lua

Pod Captain images

Check image for https://lu-explorer.web.app/objects/10174

Scripts may not be accurate

This can be observed here

The script that this is supposed to show is much longer.

Drop Chances of Loot @ Destructible Component always displays 100%

https://xiphoseer.github.io/lu-explorer/objects/16206/7

ENH: Comparison interface between versions of of the client

Having a convenient way to easily compare different version of the client would be very useful to se how the game evolved over time. whether it be via paradox supporting reading from multiple clients, or lu-explorer being able to connect to multiple paradoxServer backends.

Fix mission sorting in older clients

specifically 179.12
https://179-12.lux.aronwk.com/missions/type/Location/subtype/Nimbus%20Station
the missions are not in a sane order for any of the tabs

Add UI for `gate_version` rev

ObjectSkills not shown in the SkillComponent

Example for stromlings: https://lu-explorer.web.app/objects/4712/9

Show all items that do X

Find a way to display/generate a list like "all items that add a speed boost"

Inventory items not shown

E.g. https://explorer.lu/objects/8659/17 doesn't list any items but in the network debugger you can see it does get a response with items from the API.

Mission offer missions not shown

E.g. https://explorer.lu/objects/8659/73 doesn't list any missions but in the network debugger you can see it does get a response with a mission from the API.

Armor / Health Buff Behavior

Fix armor buff behavior display

E.g.: https://lu-explorer.web.app/skills/361

Lua scripts

• https://explorer.lu-dev.net/scripts/ai/test_script_ian.lua

Interactive LootMatrix examples

Create a component that consumes a LootMatrix and can generate a realistic random instance of executing that loot matrix.

Improve object search

It's extremely difficult to find items right now, likely because it's searching against the locale table (which seems to not even have entries for a bunch of things?)

Also, case insensitivity would probably be smart. I'll also throw out the idea of using AND as a special keyword to specify two substrings that may not be next to each other

Fix Mission Dialogs locale

See: https://explorer.lu/missions/1258#mission-dialogs

MIssion Prereq String Problem

See https://lu.lcdruniverse.org/explorer/missions/500

c.f. select id,prereqMissionID from Missions where prereqMissionID like '%:%';

Remove LuJsonService

Complete removing https://github.com/LUDevNet/lu-explorer/blob/main/src/app/util/services/lu-json.service.ts

ZoneSummary

Add the data from the ZoneSummary table to the zones view.

Example data: https://explorer.lu-dev.net/api/v0/tables/ZoneSummary/1200

Improve Item Slot Lookup

Icons: https://explorer.lu/objects/item-sets/48

Investigate Nexus HQ DB

See lucache.csv

Content-Based titles

MissionTasks by Type

e.g. All discovery (12) missions on a single page

RewardCodes / Level Rewards

• Load Rewards Table
• Load RewardCodes Table

Uncaught Exception when in Objects View

When the object JSON doesn't have a components field, the entire view crashes and doesn't display anything.

Integrate Minimaps

TODO:

• add the minimap images to lu-res, which would help a lot with upcoming changes to the zone view

BrickColors validTypes

From reverse engineering, it appears validTypes is not a bit field, but an enum which is then manually mapped to character creation hair, shirt, or pants.

Filing this so I can remember to get back to it when I've got time.

Feature request: mission / achievement distinction in mission list view

Right now the mission list view only displays mission ID and name, it would be helpful if it also showed whether the mission is a true mission or an achievement, or if there were separate groups for each.

Even cooler but optional would be to replicate the client's passport UI entirely.

Add `%(AltCombo)` to `descriptionUI`

Only show a single currency for activities based on ChallengeRating

Add TOC to Item Spotlight

https://explorer.lu/objects/item-spotlight

c.f. https://explorer.lu/misc/news-and-tips

Behavior 19

Doesn't seem to be implemented https://explorer.lu/objects/7997/5

Re-add rebuild components to activities

This is already implemented in the backend and waiting for UI

Life Powerup spawner

https://lu-explorer.web.app/skills/behaviors/39660
https://lu-explorer.web.app/objects/1625/9

Fix empty requirement string

https://lu-explorer.web.app/objects/16644/11

ENH: Show buff info for ApplyBuff Behavior

ApplyBuff applies a buff ID that corresponds to data in BuffParameters and BuffDefinitions
I would be super nice if the behavior viewer to show what these values are, and potentially use the buff icon(which is in BuffDefinitions)

Use mapShader for RenderComponent::shader_id

DeleteRestrictions

Add data from the DeletionRestrictions table to the item view.

Example Data: https://explorer.lu-dev.net/api/v0/tables/DeletionRestrictions/1

Over time behavior action interpreted incorrectly

We've been interpreting the OverTime behavior's action key as referring to a behavior so far, but new findings indicate that it actually refers to a skill. Gotta update LU-X's behavior view to reflect this.

No Monkey

https://lu-explorer.web.app/skills/behaviors/4266
This is the behavior to spawn the monkey from item 7416
https://lu-explorer.web.app/objects/7416/9

WhatsCoolNew

• What's cool: Item Spotlight
• What's cool: News & Tips

Investigate Sushi Delivery System behavior

See LOT:15892 (Behavior)

Move /skills behavior tree to lu-core-data

https://xiphoseer.github.io/lu-explorer/skills/1412

Misc TODO

• Figure out why some MissionTasks are null?
• What does 'taskParam1' for an ObtainItem task?
• Add locStatus, localized to mission tasks
• Add links to racing mission tasks
• Figure out what the ids in quickbuild tasks are
• Investigate QuickBuild vs Minigame in mission 1434
• Investigate emote rewards in Mission 1750 - fixed by #75
• Mission Texts offerNPCIcon
• display MissionTasks localization (e.g. Mission 282)

mission text for repeatables

Repeatable missions have an extra block of text in locale for when you're doing it the 2nd time onwards

Prismatic Colors

https://lu-explorer.web.app/objects/12101/11
color1 value is empty but its value is 32766 (this is prismatic)

Don't null-error on zone page if luz failed to load

Skill component not shown

Object 10482 has an entry in ObjectSkills that is also correctly returned by the API, but it doesn't show up on the page at all.

Split skillID url

https://discordapp.com/channels/227127903249367041/299808228076683265/775446243840884737

@Xiphoseer https://xiphoseer.github.io/lu-explorer/missions/755
There is a bug in lu-explorers. Those skillIDs are combined to one URL instead of splitted,
so the URL doesn't work: https://xiphoseer.github.io/lu-explorer/skills/148,149,150,151,152,153,813,175,211,811,177,184,185,186,176,146,144,521,522,523,524,525,526,527,528,529,530,531,532,809

Some behavior types don't have their names displayed

E.g. https://explorer.lu-dev.net/skills/behaviors/37846, https://explorer.lu-dev.net/skills/behaviors/37868, https://explorer.lu-dev.net/skills/behaviors/38481
All behavior template types are listed in BehaviorTemplateName in cdclient, we could add them easily
I assume this should ideally be moved from behavior-detail-alt to /defs/ ?