turbot 3.2.2

Provides a Discord client and utilities for everything Animal Crossing: New Horizons.

Turbot

A Discord bot for everything Animal Crossing: New Horizons.

🤖 Running the bot

First install turbot using pip:

pip install turbot

Then you must configure two things:

1. Your Discord bot token.
2. The list of channels you want turbot to monitor.

To provide your Discord bot token either set an environment variable named TURBOT_TOKEN to the token or paste it into a file named token.txt.

For the list of channels you can provide channel names on the command line using any number of --channel "name" options. Alternatively you can create a file named channels.txt where each line of the file is a channel name.

More usage help can be found by running turbot --help.

📱 Using the bot

Once you've connected the bot to your server, you can interact with it over Discord via the following commands in any of the authorized channels.

• !help - Provides detailed help about all of the following commands
• !about - Get information about Turbot

🤔 User Preferences

These commands allow users to set their preferences. These preferences are used to make other commands more relevant, for example by converting times to the user's preferred timezone.

• !friend: Set your friend code
• !fruit: Set your native fruit
• !hemisphere: Set your island hemisphere
• !info: Get a user's information
• !island: Set your island name
• !nickname: Set your nickname
• !timezone: Set your island timezone

💸 Turnips

These commands help users buy low and sell high in the stalk market.

• !bestsell: Look for the best buy
• !buy: Save a buy price
• !clear: Clear your price data
• !graph: Graph price data
• !history: Get price history
• !lastweek: Get graph for last week's price data
• !oops: Undo the last price data
• !predict: Predict your price data for the rest of the week
• !reset: Reset all users' data
• !sell: Save a sell price
• !turnippattern: Determine your turnip price pattern for the week

🐟 Fish and Bugs

Provides users with information on where and when to catch critters.

• !bugs: Get information on bugs
• !fish: Get information on fish
• !new: Get information on newly available fish and bugs

🦴 Fossils & 🖼️ Art

When a community of users tracks collectables and trades them between each other, everyone finishes collecting everything in the game s much more quickly than they would on their own.

These commands can also help users tell fake art from real art.

• !allfossils: Get a list of all possible fossils
• !art: Get information on an art piece
• !collect: Collect fossils or art
• !collected: Show collected fossils and art
• !count: Count the number of collected fossils and art
• !neededfossils: Get what fossils are needed by users
• !search: Search for someone who needs a fossil or art
• !uncollect: Remove a fossil or art from your collection
• !uncollected: Get fossils and art not yet collected

---

MIT © TheAstropath, lexicalunit et al