Skip to content

peterschwps/MentAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ruff Pyright Python Versions License

MentAI

An automated CLI tool using AI to solve Mentimeter ("Menti") quiz questions.

Table of Contents

Installation

pip3 install mentai-cli

Usage

First Steps

After installing MentAI you need to run it once to create the config file. You can just provide a random 8-digit number:

mentai 12345678
OpenAI API key is missing.
Please fix the error and restart the program.
You can find your settings file in: "/Users/<YourUser>/Library/Application Support/Mentai/config.toml". 
Opening it...

The config.toml will be opened in your default editor. Add an OpenAI API key and save it. All other values can be left as is. Here is a quick example of a config.toml:

[SOLVER]
OPEN_AI_API_KEY = "youropenapikeyhere"
OPEN_AI_MODEL = "gpt-5"

[QUIZ]
PLAYER_NAME = "MentiBot"
MINIMUM_DELAY_IN_MS = 500
MAXIMUM_DELAY_IN_MS = 3000
CONTEXT = "/Path/To/TextFile.txt"
  • SOLVER:
    • OPEN_AI_API_KEY: your OpenAI API key
    • OPEN_AI_MODEL: OpenAI model to use (you can find all models here)
  • QUIZ:
    • PLAYER_NAME: name to use if custom names are allowed (leave empty if you always want to use a random generated username)
    • MINIMUM_DELAY_IN_MS: shortest time to wait before submitting an answer
    • MAXIMUM_DELAY_IN_MS: longest time to wait before submitting an answer
    • CONTEXT: path to a plain text file with additional context to use when solving the quiz questions

DELAYS: This setup would generate a random delay from 500 to 3000 milliseconds for each answer submission.

Solving Quizzes

You can call mentai --help for an overview of all possible options:

mentai --help
                                                                   
 Usage: mentai [OPTIONS] Participation Details                     
                                                                   
 An automated CLI tool using AI to solve Menti quiz questions.     
                                                                   
╭─ Arguments ─────────────────────────────────────────────────────╮
│ *    participation_d…      Participation      Participation     │
│                            Details            code / link of    │
│                                               the Menti quiz.   │
│                                               [required]        │
╰─────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────╮
│ --name             -n      Name               Name to use for   │
│                                               the player if     │
│                                               custom names are  │
│                                               allowed.          │
│ --additional-con…  -a      Addtional Context  Path to a text    │
│                                               file containing   │
│                                               additional        │
│                                               context to add to │
│                                               the prompt for    │
│                                               solving           │
│                                               questions.        │
│ --help                                        Show this message │
│                                               and exit.         │
╰─────────────────────────────────────────────────────────────────╯

The default usage is mentai 12345678 with 12345678 being the participation code. You can also use the participation link to join a quiz: https://www.menti.com/abcdefghijkl.
All other flags can be configured using the config.toml. However, the command-line flags will take priority. This means if you have the name MentAI set in your config.toml but run mentai 12345678 -n John, you will join the Menti quiz as John.

What this tool can do

This tool can handle all slides for "Quiz competitions", which are "Select Answer" (single choice) and "Type Answer" (free text question). Please note that "Select Answer" questions can have multiple correct answers. However, the participant can only pick one.

What this tool can't do

This tool cannot handle any slides on Menti that are not of the category "Quiz competitions". This includes slides such as "Word Cloud", "Guess the Number" and "Multiple Choice", which do not give players a score either.
This tool does not guarantee you a perfect score.

Slide Types

When to use this tool

This tool can only be used for Menti presentations that use "Quiz competitions" slides.
As a student/participant, you can use it to automatically solve quizzes.
As a teacher/presenter, you can use it to prepare the quiz to be unsolvable for AI.
Please make sure to use this tool in a fair manner.

Disclaimer

MentAI is in no way affiliated with, authorized, maintained, or endorsed by Menti or any of its affiliates or subsidiaries. It is an independent and unofficial project. Use it at your own risk.

About

An automated CLI tool using AI to solve Menti quiz questions.

Resources

License

Stars

3 stars

Watchers

0 watching

Forks

Contributors

Languages