blooym/marketxiv

CLI frontend for FFXIV Universalis' API market data 💰

Blooym _^(she/they)

I create software, cast incantations on infrastructure and like to build random things. You can find out more about me here.

marketxiv's Issues

Documentation: Add ReadMe

Describe Changes

Add a ReadMe to the project that describes what it does, how to install, and how to use it.

Feature: In-App Autoupdates

Summary

Add in-app autoupdates so users don't have to download binaries manually every time there is an update, this could either be handled with a --update flag or just done automatically.

Further Information

Blocked by #1

Motivation

Better UX with the tool

Bug: Fix weird line endings

Describe the Bug

Currently the program sometimes uses Println and other times just prints to the same lines and uses a \n instead, this should be tidied across the entire project as it creates unusual output behaviours

Steps to Reproduce

1. Install MarketXIV under v0.3.1
2. Run a command line marketxiv item Light 12346348398232398238797289 (invalid ID)
3. Weird newline operator

Screenshots

Other: Increase project security

Summary

This project could do with a few security practices to ensure that no malicious code is distributed, some ways this could be done are:

• Sign all builds with a key
• User confirmation on update command
• Showing the user the source for the update before installing
• An improved security policy
• (Possible) Periodic checksum validation in-app

Why should this be added or changed?

Allows the project to be more trustworthy and decrease the likeness of malicious versions being distributed.

Feature: Add filters & limits to Item info

Preflight Checklist

• I have searched for existing issues and cannot find mine, or existing issues do not fit.

New or Existing?

Improvement to existing feature

Summary of the feature

Create flags on the marketboard lookup command to expand its functionality

• -nq, --normalquality: only show low quality items
• -hq, --highquality: only show high quality items
• -l, --limit: limit the amount of results shown

Why should this be added or changed?

Allows for users to get information they're more specifically looking for.

CI: Better release CI

Summary

Improve the release CI cycle

Further Information

Right now the automatic releases CI is pretty limited and does not compile for Windows, this can be improved by using a 3rd party release tool for GoLang or by building an internal method for exporting & detecting version files.

Feature: Check vendor price of MB items and show on listing

Preflight Checklist

• I have searched for existing issues and cannot find mine, or existing issues do not fit.

New or Existing?

New feature

Summary of the feature

When searching for an item with the "item" command, if it is available from a vendor then the vendor price should be shown on the listing. This could even change the colour of listings that are above the vendor price.

Why should this be added or changed?

Help prevent people buying overpriced items on the Marketboard (kind of like simpletweaks does)

Feature: Use Cobra

Summary

The current implementation of command handling is bad practice and can be improved.

Feature: Configuration Skeleton

Preflight Checklist

• I have searched for existing issues and cannot find mine, or existing issues do not fit.

New or Existing?

New feature

Summary of the feature

Add a configuration skeleton setup to MarketXIV to allow for future development on app settings

Why should this be added or changed?

Opens to the door to making behaviour customizable within the app, and allows for some local data caching too.