# GroceryBot

GroceryBot allows you to maintain a grocery list for your server/guild/household. You can add and remove entries as you see fit.

~~Because switching to Google Shopping List just to check your grocery list while you're communicating on Discord is a waste of time~~

# Commands

```
Friendly reminder that from August 2022, due to a Discord policy change, if you still want to use these commands through the ! prefix, don't forget to mention @GroceryBot so that the bot can see your commands!

All of these commands have their slash command counterparts except `!grobulk` - just start typing `/gro`!  
```

**!grohelp**: Get help!

**!gro \<name\>**: Adds an item to your grocery list.

**!groremove \<n\>**: Removes item #n from your grocery list.

**!groremove \<n\> \<m\> \<o\>...**: Removes item #n, #m, and #o from your grocery list. You can chain as many items as you want.

**!groremove \<item name\>**:
Removes an item which contains \<item name\> from your grocery list. The item name is case-insensitive. This will delete the first item on your list that contains \<item name\>.

**!grolist**: List all the groceries in your grocery list

**!groclear**: Clears your grocery list

**!groedit \<n\> \<new name\>**: Updates item #n to a new name/entry

**!grohere**: Attaches a self-updating grocery list to the current channel. 

**!groreset**: When you want to clear all of your data from this bot.

You can also do **!grobulk** to add your own grocery list. Format:

```
!grobulk
eggs
Soap 1pc
Liquid soap 500 ml
```

These 3 new items will be added to your existing grocery list!

# Multiple grocery lists

**!grolist new \<your-new-list-label\> \<A Pretty Name for Your Grocery List - Optional\>** or `/grolist-new`: creates a new grocery list. For example: `!grolist new amazon My Amazon Shopping List`

**!grolist:\<your-grocery-list-label\> delete** or `/grolist-delete`: Deletes your grocery list. Use `!grolist help` to see additional utility commands (like editing your grocery list).

**\<command\>:\<grocery-list-label\>**: Runs a command against a particular grocery list. For example, `!gro:amazon PS5` adds "PS5" to your "amazon" grocery list.

# Issues & Problems with GroceryBot?

You'll be able to ask questions and provide feedback for the bot - straight to the development team! [Click here to join](https://discord.gg/rBjUaZyskg)

# Privacy Policy

Have a look at our official privacy policy page at [https://grocerybot.net/privacy-policy](https://grocerybot.net/privacy-policy) for the master version, but here's a quick TL:DR;

"No entry, no data, no problem" and "We don't run analytics or any kind of dodgy stuff because that's expensive"

## Data

When you use a GroceryBot command, we store the following data required for the bot to function properly:

- Your server's ID (because each server has their own grocery list)
- Your server's channel IDs (which isn't human-readable) - this is used so that GroBot knows where to send updates (currently used by !grohere).
- The ID of the user who inputted each grocery entry into your grocery list
- The grocery entry itself (duh)
- When grocery entries are updated (deleted entries are deleted permanently and immediately)

We also keep logs of when an error occurs. This log is automatically disposed of within 14 days.

## Who has access to your data?

Only the maintainer(s) of this project (i.e. [@verzac](https://github.com/verzac) unless otherwise specified) have access to your grocery list because the bot currently lives in his server. And frankly, we don't really want to know what you're going to buy tomorrow.

## Removing your data

While we're sad to see you go, removing your data is as easy as running `!groreset` and removing the bot afterwards. This utility function ensures that all your data is removed from our database.

The only minor exception to the immediate "no entry, no data, no problem" rule is the error logs: error logs are automatically deleted within 14 days (as opposed to immediately). If you've never had an error occur, you shouldn't have this problem.

## Changes to this policy

_Wow, you're actually reading this part. Congratulations, you care about your data!_

While we don't have an official changelog yet where you can view changes to the policy other than our Discord server (which you should definitely join - or at least follow our announcement channel), rest assured we'll try to communicate any changes ASAP to you.

GroceryBot (type !grohelp)

Get a centralized grocery list going for your Discord server, so that you don't have to switch apps to have a look at your grocery list.

Voting for GroceryBot (type !grohelp)

Do you want to support us?