Compare commits

...

11 Commits

Author SHA1 Message Date
5d21571561 Added mount command 2025-10-22 20:27:37 +01:00
821d301de3 Added sorting for cards 2025-08-21 03:30:04 +01:00
6b5034c544 Fixed when you a disambiguated name in first
Still should probably clean up the return values.

Also should look into how to exit early from the script
2025-08-21 03:09:17 +01:00
43a75c0b92 Added some dbg
Also found a bug
2025-08-21 02:46:20 +01:00
130287caa7 Added a wrapper script...
... to the wrapp script around the ... binary

For the purposes of allow me to add a nice shortcut for my window manager
2025-08-21 02:30:31 +01:00
3df07d7622 Added some more explanation around the script 2025-08-21 02:11:55 +01:00
fd358f5d3f Misspelled script stuff seems to be working 2025-08-21 01:56:54 +01:00
f1beae9198 Updated README and starting on more complex rofi script 2025-08-21 01:45:50 +01:00
4dde40b72e updated README 2025-08-21 00:46:44 +01:00
a21520b5e5 Added README 2025-08-21 00:44:34 +01:00
af1ac9b5fa Updated update and added an update script
The --update flag accepts the file no rather than goes to download.

Simpler. Better.

Don't need the entire download.rs file now
2025-08-21 00:18:26 +01:00
8 changed files with 244 additions and 27 deletions

View File

@@ -0,0 +1 @@
sudo mount -t cifs -o uid=arthurr,username=arthurr //truenas.local/Music /home/arthurr/TruenasMusic/

113
scryfall_deser/README.md Normal file
View File

@@ -0,0 +1,113 @@
# Quick Magic Finder
A quick way to search up Magic the Gathering (TM) cards for Linux (maybe MacOS? Don't have one, so haven't tried).
Currently, no images are displayed - so don't go into this expecting that.
## The Components
This repo has 2 main parts to it:
* The `magic_finder` rust code, which does the "heavy lifting" of updating a database, searching through it for cards, and finding close names (kind of)
* The supporting scripts which use [`rofi`](https://github.com/davatorium/rofi)
`magic_finder` can be used without the rofi parts if you wanted a command for loading showing basic mtg card info from the CLI.
The `rofi` part is so that I can quickly and easily get the card info I want. Basically just adds a very simple and easy GUI to the `magic_finder` part. I've written 2 wrapper scripts to enable this.
## Requirements
### Magic Finder
`magic_finder` is written in rust. Check the Cargo.toml file for more specific requirements. I was compiling with rustc version 1.88, but I would not at all be surprised if it worked on rust from year(s) ago.
### `rofi`
The rofi scripts require a version over (I think) 1.7.6. The scripts require the ability to set the `command` setting on the `filebrowser` option in rofi. From what I can tell, this was introduced in 1.7.6.
Very annoyingly, the Ubuntu repos do *not* have this version. They have an earlier version. So, to use this, you'll need to get a more recent version yourself. I compiled and installed myself. See the end of this README for how I did that.
## Usage
**TODO**
## Installation, First Usage, and Updating
### Installation
I am sorry in advance, this is a bit of a pain becuase of my lack of knowledge on how to properly "package" scripts alongside a rust binary.
**TODO - don't forget that I need to install sqlite3-lib/dev/something - or maybe I add the feature flag "bundled"**
*TODO - don't forget about adding the shortcut to the overall wrapper script*
## Before you use this
## Update
Basically the same as the "Before you use this" secion. Go to the [Scryfall Bulk Download](https://scryfall.com/docs/api/bulk-data) page and get the Oracle Cards download.
Then run the `update_with_rofi.sh` script, locate the downloaded file, and it should Just Work (TM). If not, try updating this repo. If it still doesn't work, log a ticket. It's probably going to something with Scryfall updating their schema that I haven't accounted for. Alternatively, run `COMMAND --update <path to file>` where `<path to file>` is the full path to where you downloaded the file.
NOTE: Updating *will* delete the previous db - that shouldn't be a problem though, because you shouldn't use that unless you really know what you're doing.
## Why this exists
I like watch Magic the Gathering (TM) videos, expecially while coding, working, writing, whatever. Often, I don't know what card they're talking about. They'll often say the card name (sometimes a nickname - this tool doesn't help with that), and show it on the screen briefly (or in a tiny/obscured view), and I'll miss what it actually does. When this happens, I need to open a tab on my browser, go to [Scryfall](scryfall.com), type in the name, (sometimes) click the specific card, and the view it. This takes 2-3 page loads, changing my active window and just a bit of a pain.
This tool, especially using `rofi` enables me to hit `Ctrl+M`, type in the card name, navigate to the card (if needed) with my keyboard, and display the card. No browser, no HTTP, lower context switch, displayed right there, and goes away when I press anything else.
The idea is it's just easier and quicker than my normal process.
## How I Installed `rofi`
If you're smarter than me, just follow the official docs: https://github.com/davatorium/rofi/blob/next/INSTALL.md and don't bother reading this.
I am entirely unfamiliar with `meson` and `ninja` (I'm more a `Makefile` kinda guy - haven't done any `C` properly in >10 years), so here's what I did. This is for Ubutntu - you will need to do something different for download the dependencies (you can see them in the INSTALL.md file referenced above).
Of note below, I'm installing this into my `$HOME/bin` directory. Change that part if you want to install somewhere else. Make sure to install it somewhere in your `$PATH` though!
Clone the repo and move into it
```
git clone --recursive https://github.com/davatorium/rofi
cd rofi
```
Install the deps
```
sudo apt build-dep rofi
sudo apt install meson
sudo apt install libxcb-keysyms1-dev libxcb-keysyms1 # I suspect only one of these is needed - not sure which
```
Setup and build (not sure why I put the prefix in here... you'll see below I still copy+pasted the bin)
```
meson setup build --prefix $HOME/bin -Dwayland=disabled -Dxcb=enabled
ninja -C build -v
```
Fingers crossed that all compiled and stuff... then copy the bin
```
cp build/rofi ~/bin
```
## FIXME, TODO & Features That Could be Good
* Remove the non-card cards. Examples I've come across are:
** Planes: Black Lotus Lounge
** Art Cards: https://scryfall.com/card/altr/15/%C3%A9owyn-fearless-knight-%C3%A9owyn-fearless-knight?utm_source=api
* Allow exiting the script early (i.e. I hit CTRL+g just exits everything)
* Misspelled cards, if only 1 hit that makes sense, could just work
* Display the actual card image (probably won't do this)
* Some kind of auto-magic direct link between the return codes set out in `main.r`s and the `rofi` scripts. Currently I need to manually make sure they're the same between the `rust` code and the `sh` code.
I'm guessing would involve cargo build scripts (or just a find+replace?)
* Add some classic nicknames (might be difficult to find them all). examples include:
** Bob - Dark Confidant
** AK - Accumulated Knowledge
** find more here: https://mtg.wiki/page/List_of_Magic_slang/Card_nicknames
## Thanks
This project really is just 95% based on Scryfall. They're amazing. I don't know how or why they exist, but I think they're basically the best Magic the Gathering (TM) resource online.
Of course `rofi` for providing the quick, simple, low-weight, and well documented tool. Particularly the quickness and low-weight which made it really possible. The alternative was opening terminal windows, or using TKinter or something... surely not worth it.
Thanks to all the amazing `rust` packages I use.

View File

@@ -1,17 +1,4 @@
#!/bin/sh #!/bin/sh
CARDS=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser $@) SEARCH_STRING=$(rofi -l 0 -dmenu)
/home/arthurr/code/mini_projects/scryfall_deser/scripts/search_with_rofi_with_args.sh $SEARCH_STRING
SELECTION=$(rofi -dmenu -i << EOF
$CARDS
EOF
)
CARD_OUTPUT=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser --exact $SELECTION)
# If you double check the first rofi selection it seems to prevent the error window from popping up
# I think this is because it registers the second click as a click outside the window which exits
# the rofi -e message
sleep 0.05
rofi -e "$CARD_OUTPUT"

View File

@@ -0,0 +1,74 @@
#!/bin/sh
# Note to self in this... The whitespace seemed to fuck the ifs up. Not sure why.
# This is why it's all flat and ugly
CARDS=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser $@)
RETURN=$?
echo $RETURN
#######################
## Exact card found - just print the card
#######################
if [ $RETURN -eq 200 ]; then
rofi -e "$CARDS"
fi
#######################
## Cards to select from
#######################
if [ $RETURN -eq 0 ]; then
SELECTION=$(rofi -dmenu -i << EOF
$CARDS
EOF
)
CARD_OUTPUT=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser --exact $SELECTION)
# If you double check the first rofi selection it seems to prevent the error window from popping up
# I think this is because it registers the second click as a click outside the window which exits
# the rofi -e message
sleep 0.05
rofi -e "$CARD_OUTPUT"
fi
##########################
## Not even one card that matched - try a close string
##########################
if [ $RETURN -eq 105 ]; then
# TODO do something different with no matching string at all - perhaps even a different ExitCode?
SELECTION=$(rofi -dmenu -p "Did you mean?" -i << EOF
$CARDS
EOF
)
CARDS=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser $SELECTION)
SELECTION=$(rofi -dmenu -i << EOF
$CARDS
EOF
)
CARD_OUTPUT=$(/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser --exact $SELECTION)
sleep 0.05
rofi -e "$CARD_OUTPUT"
fi
###############################
## No seach string input at all
###############################
if [ $RETURN -eq 101 ]; then
rofi -e "No search string found"
fi

View File

@@ -0,0 +1,9 @@
#!/bin/sh
SCRYFALL_BULK=$(rofi -modi filebrowser -show filebrowser -filebrowser-command printf)
echo "$SCRYFALL_BULK"
/home/arthurr/code/mini_projects/scryfall_deser/target/debug/scryfall_deser --update "$SCRYFALL_BULK"
# TODO - check return value
rofi -e "Should be updated"

View File

@@ -1,5 +1,6 @@
use deunicode::deunicode; use deunicode::deunicode;
use rusqlite; use rusqlite;
use std::cmp::Ordering;
use std::fmt; use std::fmt;
use std::fs; use std::fs;
use std::path::PathBuf; use std::path::PathBuf;
@@ -75,6 +76,26 @@ impl fmt::Display for DbCard {
} }
} }
impl Ord for DbCard {
fn cmp(&self, other: &Self) -> Ordering {
self.name.cmp(&other.name)
}
}
impl PartialOrd for DbCard {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl PartialEq for DbCard {
fn eq(&self, other: &Self) -> bool {
self.name == other.name
}
}
impl Eq for DbCard {}
#[derive(Debug)] #[derive(Debug)]
pub struct DbCard { pub struct DbCard {
pub name: String, pub name: String,
@@ -105,6 +126,8 @@ pub fn get_card_by_name(name: &str, name_type: GetNameType) -> Option<DbCard> {
FROM cards WHERE lowercase_name = (?1)" FROM cards WHERE lowercase_name = (?1)"
} }
}; };
dbg!(name);
dbg!(&sql);
let mut stmt = conn.prepare(sql).unwrap(); let mut stmt = conn.prepare(sql).unwrap();
let mut rows = stmt.query([name]).unwrap(); let mut rows = stmt.query([name]).unwrap();
match rows.next().unwrap() { match rows.next().unwrap() {

View File

@@ -47,7 +47,6 @@ pub fn download_latest(
stype: ScryfallBulkType, stype: ScryfallBulkType,
mut dest_file: &NamedTempFile, mut dest_file: &NamedTempFile,
) -> Result<(), Box<dyn std::error::Error>> { ) -> Result<(), Box<dyn std::error::Error>> {
panic!();
let bulk_body: ScryfallBulk = ureq::get(SCRYFALL_BULK_API) let bulk_body: ScryfallBulk = ureq::get(SCRYFALL_BULK_API)
.header("User-Agent", "Arthur's Card Finger Testing v0.1") .header("User-Agent", "Arthur's Card Finger Testing v0.1")
.header("Accept", "application/json") .header("Accept", "application/json")

View File

@@ -17,12 +17,16 @@ impl Termination for MtgCardExit {
MtgCardExit::EmptySearchString => ExitCode::from(101), MtgCardExit::EmptySearchString => ExitCode::from(101),
MtgCardExit::NoExactMatchCard => ExitCode::from(102), MtgCardExit::NoExactMatchCard => ExitCode::from(102),
MtgCardExit::DidYouMean => ExitCode::from(105), MtgCardExit::DidYouMean => ExitCode::from(105),
MtgCardExit::ExactCardFound => ExitCode::from(200),
MtgCardExit::UpdateSuccess => ExitCode::from(201),
} }
} }
} }
enum MtgCardExit { enum MtgCardExit {
Success, Success,
UpdateSuccess,
ExactCardFound,
EmptySearchString, EmptySearchString,
NoExactMatchCard, NoExactMatchCard,
DidYouMean, DidYouMean,
@@ -31,9 +35,9 @@ enum MtgCardExit {
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
#[command(version, about, long_about = None)] #[command(version, about, long_about = None)]
struct Args { struct Args {
/// Download the latest bulk from Scryfall and update local db /// Update the local db from given Scryfall bulk download
#[arg(short, long)] #[arg(short, long)]
update: bool, update: Option<String>,
/// Search for the exact string /// Search for the exact string
#[arg(short, long)] #[arg(short, long)]
exact: bool, exact: bool,
@@ -51,7 +55,7 @@ fn exact_search(search_strings: Vec<String>) -> MtgCardExit {
} }
Some(c) => { Some(c) => {
println!("{}", c); println!("{}", c);
MtgCardExit::Success MtgCardExit::ExactCardFound
} }
} }
} }
@@ -69,16 +73,17 @@ fn _combine_search_strings(search_strings: Vec<String>) -> String {
fn main() -> MtgCardExit { fn main() -> MtgCardExit {
let args = Args::parse(); let args = Args::parse();
if args.update { if let Some(update) = args.update {
dbg!(&update);
init_db(); init_db();
let mut path = get_local_cache_folder(); let mut path = get_local_cache_folder();
// TODO - actually download the file - probably do away with TempFile stuff path.push(update);
path.push("oracle-cards-20250814210711.json"); // FIXME - if you pass a bad file or something, it just deletes the db
update_db_with_file(path); update_db_with_file(path);
return MtgCardExit::Success; return MtgCardExit::UpdateSuccess;
} }
if args.search_text.is_empty() { if args.search_text.is_empty() {
println!("You need to put some card text to search"); dbg!("You need to put some card text to search");
return MtgCardExit::EmptySearchString; return MtgCardExit::EmptySearchString;
} }
@@ -87,7 +92,9 @@ fn main() -> MtgCardExit {
return res; return res;
} }
let matching_cards = find_matching_cards_scryfall_style(&args.search_text); let mut matching_cards = find_matching_cards_scryfall_style(&args.search_text);
dbg!(&args.search_text);
dbg!(&matching_cards);
if matching_cards.is_empty() { if matching_cards.is_empty() {
let mtg_words = get_all_mtg_words(); let mtg_words = get_all_mtg_words();
@@ -106,10 +113,13 @@ fn main() -> MtgCardExit {
} }
return MtgCardExit::DidYouMean; return MtgCardExit::DidYouMean;
} else if matching_cards.len() == 1 { } else if matching_cards.len() == 1 {
let card = get_card_by_name(&matching_cards[0].name, GetNameType::LowercaseName).unwrap(); // FIXME - theres a bug in here - try searching Nalf
let card = get_card_by_name(&matching_cards[0].name, GetNameType::Name).unwrap();
println!("{}", card); println!("{}", card);
return MtgCardExit::Success; // TODO update this to be more meaningful
return MtgCardExit::ExactCardFound;
} else { } else {
matching_cards.sort();
for card in matching_cards { for card in matching_cards {
println!( println!(
"{}", "{}",
@@ -118,6 +128,7 @@ fn main() -> MtgCardExit {
.name .name
); );
} }
// TODO update this to be more meaningful
return MtgCardExit::Success; return MtgCardExit::Success;
} }
} }