Search Bar: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
No edit summary
m (v12 cleanup)
 
(12 intermediate revisions by 2 users not shown)
Line 3: Line 3:
==Overview==
==Overview==
* Flashpoint uses [http://docopt.org/ docopt] parsing: <code><nowiki>([-][[(no|not|missing|is|has|<field>):]|[@|#|!]](<phrase>|"<phrase>"))...</nowiki></code>
* Flashpoint uses [http://docopt.org/ docopt] parsing: <code><nowiki>([-][[(no|not|missing|is|has|<field>):]|[@|#|!]](<phrase>|"<phrase>"))...</nowiki></code>
* A search query can contain any number of phrases (<code>tag:arcade tag:platformer platform:flash jump run</code>)
* A search query can contain any number of phrases (<code>tag:Arcade platform:Flash jump run</code>)
* Phrases containing spaces must be wrapped in quotes or will count as separate parameters (<code>developer:"Firstname Lastname"</code>)
* Phrases containing spaces must be wrapped in quotes or will count as separate parameters (<code>developer:"Tom Fulp"</code>)
* Searches are not case sensitive, can have incomplete names (except tags) and a name backwards (both <code>nana cr</code> and <code>CRASH NANACA</code> will find NANACA†CRASH!!)
* Searches are not case sensitive, can have incomplete names (except tags) and a name backwards (both <code>nana cr</code> and <code>CRASH NANACA</code> will find NANACA†CRASH!!)
* Phrases without metadata prefixes are matched against a curation's Title, Alternate Titles, Developer and Publisher. The phrase only has to match one of these fields for the game to be included.
* Phrases without metadata prefixes are matched against a curation's Title, Alternate Titles, Developer and Publisher. The phrase only has to match one of these fields for the game to be included.
* Searches inside [[playlists]] do not currently work.


==Metadata Prefixes==
==Metadata Prefixes==
Line 52: Line 53:
|-
|-
| applicationPath:
| applicationPath:
| <code>applicationPath:Basilisk</code>
| <code>applicationPath:FPNavigator</code>
|-
|-
| launchCommand:
| launchCommand:
Line 62: Line 63:
| originalDescription:
| originalDescription:
| <code>originalDescription:ninja</code>
| <code>originalDescription:ninja</code>
|-
| id:
| <code>id:cdeb30c5</code>
|-
|-
|}
|}


<code>broken:</code> and <code>extreme:</code> are special cases since their values are boolean; for example, <code>broken:</code> without a phrase will display games that are not broken in Infinity while <code>broken:1</code> (or any other phrase) will search the opposite. You still must enable [[Extended FAQ#GameDisappeared|broken in Infinity]] (for Infinity users) and [[Extended FAQ#GameNotFound|extreme]] games in the Launcher to see these.
*<code>broken:</code> and <code>activeDataOnDisk:</code> are special cases since their values are boolean; for example, <code>broken:</code> without a phrase will display games that are not broken in Infinity while <code>broken:1</code> (or any other phrase) will search the opposite. You still must enable [[Extended FAQ#GameDisappeared|broken in Infinity]] (for Infinity users) games in the Launcher to see these. <code>activeDataOnDisk:</code> can be used to filter by [[GameZIP Server|GameZIPs]].
*In 9.0 and prior, <code>extreme:</code> was a boolean value for extreme games; You still must enable [[Extended FAQ#ShowExtreme|extreme]] games in the Launcher to see these. There is no current replacement.


==Other Prefixes==
==Other Prefixes==
Line 72: Line 77:
|-
|-
| -
| -
| Excludes a parameter from the search. Can be used as part of other prefixes.
| Excludes a parameter from the search when used before other prefixes.
| <code>-tag:Soccer</code>
| <code>-tag:Soccer</code>
|-
|-
Line 96: Line 101:
|-
|-
|}
|}
<noinclude>[[Category:Launcher]]</noinclude>

Latest revision as of 04:09, 16 July 2023

This article describes how the search system in the Flashpoint Launcher works.

Overview

  • Flashpoint uses docopt parsing: ([-][[(no|not|missing|is|has|<field>):]|[@|#|!]](<phrase>|"<phrase>"))...
  • A search query can contain any number of phrases (tag:Arcade platform:Flash jump run)
  • Phrases containing spaces must be wrapped in quotes or will count as separate parameters (developer:"Tom Fulp")
  • Searches are not case sensitive, can have incomplete names (except tags) and a name backwards (both nana cr and CRASH NANACA will find NANACA†CRASH!!)
  • Phrases without metadata prefixes are matched against a curation's Title, Alternate Titles, Developer and Publisher. The phrase only has to match one of these fields for the game to be included.
  • Searches inside playlists do not currently work.

Metadata Prefixes

Prefix Example
title: title:Bowman
alternateTitles: alternateTitles:II
series: series:Sonny
developer: developer:Devname
publisher: publisher:Newgrounds
playMode: playMode:"Single Player"
status: status:Partial
releaseDate: releaseDate:2010-01
version: version:2.0
language: language:pt
tag: tag:Toy
source: source:deviantart.com
platform: platform:Flash
applicationPath: applicationPath:FPNavigator
launchCommand: launchCommand:localflash
notes: notes:Extras
originalDescription: originalDescription:ninja
id: id:cdeb30c5
  • broken: and activeDataOnDisk: are special cases since their values are boolean; for example, broken: without a phrase will display games that are not broken in Infinity while broken:1 (or any other phrase) will search the opposite. You still must enable broken in Infinity (for Infinity users) games in the Launcher to see these. activeDataOnDisk: can be used to filter by GameZIPs.
  • In 9.0 and prior, extreme: was a boolean value for extreme games; You still must enable extreme games in the Launcher to see these. There is no current replacement.

Other Prefixes

Prefix Explanation Example
- Excludes a parameter from the search when used before other prefixes. -tag:Soccer
no: The field that matches the phrase must be false or empty. not: and missing: have the same purpose. no:releaseDate
has: The field that matches the phrase must be true or not empty. is: has the same purpose. is:extreme
@ Short-hand for developer:. @Devname
# Short-hand for tag:. #Shooter
! Short-hand for platform:. !Unity