gurkult / gurkbot

Our community bot, used for running the server.
MIT License
17 stars 16 forks source link

Wolfram command for gurkbot #53

Open dhzdhd opened 3 years ago

dhzdhd commented 3 years ago

We need a wolfram command ( commonly accessed by !wa ) that accesses the Wolfram API and fetches results in the form of a image based on user queries

I believe i can do it myself as i already have it implemented in my bot

Example: image

Need suggestions regarding whether: 1) Dark mode is needed 2) labelbar style layout is needed

Refer docs - https://products.wolframalpha.com/simple-api/documentation/

gustavwilliam commented 3 years ago

Dark mode could be cool. However, I find it slightly more difficult to read than the standard light mode. If it’s possible to change the background color (to something that’s a bit lighter), I’d like to see how that would look as well.

What is labelbar style?

dhzdhd commented 3 years ago

Dark mode could be cool. However, I find it slightly more difficult to read than the standard light mode. If it’s possible to change the background color (to something that’s a bit lighter), I’d like to see how that would look as well.

What is labelbar style?

I forgot to say, it is indeed possible to change the bg colour - need some testing Also label bar style in given in the API docs image

gustavwilliam commented 3 years ago

Ah, I see. Personally, I think the entire picture should be a single image, since that looks a bit more unified.

For background color, I’d say either white or a dark, but not black, color. If you could do some testing with colors, that would be fantastic, and showing multiple (50) shades grey here.

dhzdhd commented 3 years ago

Ah, I see. Personally, I think the entire picture should be a single image, since that looks a bit more unified.

For background color, I’d say either white or a dark, but not black, color. If you could do some testing with colors, that would be fantastic, and showing multiple (50) shades grey here.

it is indeed a single pic - it just looks way neater with the labelbar layout imo the discord bg colour and the colour between the separate headings is the same - hence the illusion And yes, if this is approved , i will test the colours

plusk-dev commented 3 years ago

Ah, I see. Personally, I think the entire picture should be a single image, since that looks a bit more unified. For background color, I’d say either white or a dark, but not black, color. If you could do some testing with colors, that would be fantastic, and showing multiple (50) shades grey here.

it is indeed a single pic - it just looks way neater with the labelbar layout imo the discord bg colour and the colour between the separate headings is the same - hence the illusion And yes, if this is approved , i will test the colours

yea, if the bgcolor could get the same as discord bg color, then that shall look a lot nicer

dhzdhd commented 3 years ago

I would like to be assigned to this command please :)

gustavwilliam commented 3 years ago

I'd like for us to have a direction for the command before coding it, so the reviews won't largely consist of "could we add this field" and "why is that field there." Some details can be tried out, but we should try to understand how most of the command would work first.

How do you think that the embed should look?

dhzdhd commented 3 years ago

I sent the screenshot of the embed in my original issue and that is exactly how I would like it to look @gustavwilliam Oops, you did not mean it literally .

1) The header of the embed is the query itself so as to make it clear that that picture is the result of the query 2) Next comes the image gotten from the API which consists of the query result 3) If the image is not available (usually results in loading forever or disappearance of image in the embed, a link will be provided to the website where the query result can be seen directly) 4) The footer consists of the author profile picture, name and the timestamp

Embed structure is subject to change depending upon whether a embed helper is added or not .

Hope this made it all clear :)

gustavwilliam commented 3 years ago

Alrighty. I appreciate that you gave some thought to the edge case of where no image is returned. Regarding point 4, why would we want that? I'd prefer if we ping the user in the message (set description) and include the embed. That's what we do in the other commands — at least for now.

The title could probably be improved. We have a command on Sir Lancebot (SeasonalBot) that looks like this:

Screenshot 2021-01-02 at 18 05 06

Maybe we could just call it "Wolfram Alpha" as well and the description could be the input, or maybe we should make the title the input. What do you think? I'm not quite sure what a good title would be.

Arnav-2004 commented 3 years ago

If you are typing the command you probably know what you are searching for so I mean adding the search in the title would be unnecessary but let's see what others think

dhzdhd commented 3 years ago

Alrighty. I appreciate that you gave some thought to the edge case of where no image is returned. Regarding point 4, why would we want that? I'd prefer if we ping the user in the message (set description) and include the embed. That's what we do in the other commands — at least for now.

The title could probably be improved. We have a command on Sir Lancebot (SeasonalBot) that looks like this:

Screenshot 2021-01-02 at 18 05 06

Maybe we could just call it "Wolfram Alpha" as well and the description could be the input, or maybe we should make the title the input. What do you think? I'm not quite sure what a good title would be.

Regarding the title, it is indeed true, the query part in the author section of the embed is not needed. Also, i will not include the footer with the name, timestamp , etc - I am just used to it :)

I will heed your advice and will implement it if i do get approved for working on this

gustavwilliam commented 3 years ago

What title do you think would fit? Any ideas?

dhzdhd commented 3 years ago

The title of the embed from python discord is good enough I suppose. If anyone else has any other ideas, they can pitch in

gustavwilliam commented 3 years ago

Alright. I think we have a clear enough understanding of the command now. I'll assign you; thanks!