Skip to content

Core: Add a search_item client command #5128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

JKLeckr
Copy link
Contributor

@JKLeckr JKLeckr commented Jun 21, 2025

Please note that this is something that I whipped up and tested. If there is a different name or behavior or method of implementation of this command that is desired, please let me know, so then I can revise it.

What is this?

This code adds a new command for clients which can query items. The allows users to search item names that exist in the current slot's world.

Why is this needed?

The Pitch

This is needed because there are too many instances where I am trying to hint for items that I do not know the exact name for. Plus, I get questions for my own apworld occasionally about what is the name of [item]. This would just make it easier to find items to hint.
This allows a user to find what items exist in the current world without second guessing themselves.

How was this tested?

Tested various queries. Tested querying items from current world and other worlds in the multiworld. Made sure that only current world items are queried.

What if I do not like this implementation?

This can be adjusted to behave in different ways depending on preference. I just implemented it in a way that at least I think is reasonable behavior, but I am not everyone.

Visual Example

image

Improved search queries

Made comments more clear
@github-actions github-actions bot added the affects: core Issues/PRs that touch core and may need additional validation. label Jun 21, 2025
@qwint
Copy link
Collaborator

qwint commented Jun 21, 2025

This is needed because there are too many instances where I am trying to hint for items that I do not know the exact name for. Plus, I get questions for my own apworld occasionally about what is the name of [item]. This would just make it easier to find items to hint.

if this is your main usecase I suggest using /items instead, which lists the exact name of every item in the datapackage
the specific ask of "which items have been created in this multiworld" from what I've seen is usually viewed as giving away information and would likely receive some pushback for that

@Exempt-Medic
Copy link
Member

You can also use the "New Hint" section of the hints tab, which has an auto-fill suggestion box as you type into it

@JKLeckr
Copy link
Contributor Author

JKLeckr commented Jun 21, 2025

I still believe there is value in being able to search for items, especially if there are a lot of items in a particular world.

Now, I realize that putting this server-side is a bit unwise.

Using just /items is fine, but with a world with lots of items, this list would become very large.
The second feature with the hint completion is probably the best alternative to this if we are purely using this for hints. I would say this would solve my issue.

So, for now, this server version of this command should not be implemented because it is unnecessary.
A client command for something like this might still make sense for certain cases, but it might be deemed unnecessary.

@JKLeckr JKLeckr closed this Jun 21, 2025
@qwint
Copy link
Collaborator

qwint commented Jun 21, 2025

adding a fuzzy matching optional arg to /items sounds reasonable fyi, but I would wait till #3045 is merged to avoid the merge conflict hassle (that stopped the last attempt to add something like that)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: core Issues/PRs that touch core and may need additional validation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants