This is the official repo for the Oracles Bakery Mammet, beloved son of Villicent and famously despised son of Villicent.
(It's a discord bot made to be always-free, with open and transparent code for the gang to all read through so they know they're safe, if you're looking for actual info)
Looking to get the bot running for yourself?
Clone the repo, make your virtual environment and install dependencies, then it's ready to push to your (totally made via V's referral link) railway.com environment!
Just don't forget to remove the commenting # at the start of your terminal's venv script!
git clone https://github.com/Oracles-Bakery/ORBMammetBot.git
cd ORBMammetBot
# source .venv/bin/activate # For people using bash (also WSL and linux/mac users)
# .\.venv\Scripts\activate.bat # For people using cmd.exe on Windows
# .\.venv\Scripts\Activate.ps1 # For people using powershell
pip install -r requirements.txtFor help with your .env file for local machines or the variables of your project on railway, you can check out settings.py to see what environment pulls there are where you see os.getenv().
Version numbers you see here are estimates, and are listed as X.Y.Z for MAJOR.MINOR.FIX
They'll be populated with numbers instead of letter when the order they'll be worked on is decided.
You can think of it like this:
MAJOR updates are things that REALLY expand the functionality, and I expect to be in version 1 for a long time, so I can make sure it all works. Version 2 will be when we break out of discord and have a website so people can use the bot with a prettier UI (So, you see, not any time soon.)
MINOR updates are new features, or, (hopefully never) the retirement of some features. A new channel for alerting you to free games is a nice feature, so it's a MINOR version update (because it's still all in the discord-bot only stage)
FIX updates are repairs and tweaks to things that already exist, and will more often than not be a group of updates all at once to make sure you're not getting updates spamming the merges. Current plan is to send a pull request with all the fixes I have at 00:00 (that's midnight for you word-enjoyers) UTC (server time for EU) every Friday for the higher ups to check on and allow unless it's an emergency then it'll be ASAP!
| Status | Meaning | Details |
|---|---|---|
| 🔴 | Blocked | Something is missing to make this work |
| 🟠 | Backlog | Priority shifted, expected later but soon! |
| 🟡 | Bughunt | Likely made at 4am, recalled for bugfixing |
| 🟢 | Completed | All done yippee woohoo yeehaw! |
| 🔵 | Planned | Not the current workload, but coming eventually |
| 🟣 | In Progress | Current workload, only inside the fork V is working on |
| ⚪ | Idea | Posited idea, awaiting feedback from GMs and FC members |
| ⚫ | Archived | Rejected idea, will be worked on privately and pushed to sponsor repo |
| Feature | Target | Status | Notes |
|---|---|---|---|
| Dynamic Role Selection | v1.0.0 | 🟢 | Embed that dynamically loads roles and populates categories and lists for user role management |
| FFXIV Lodestone Character Verification | v1.0.0 | 🟢 | Scraping implemented, basic embed currently |
| Basic Greeting Questions | v1.0.0 | 🟢 | Preferred name and favourite colour |
| Free Game Alerts | v1.1.0 | 🟣 | Free and discounted game alerts, and free weekend events |
| Support Tickets | v1.Y.0 | 🔵 | Support requests and GM messaging system with transcript generation and isolated text channel creation |
| XIVAPI Implementation | v1.Y.0 | 🔵 | Find info about the items, quests, and anything else XIVAPI can provide! |
| Raid Helper | v1.Y.0 | 🔵 | Setup for in-game events handling, with per-player class tracking and role assignment |
| FFXIV Server Updates | v1.Y.0 | 🔵 | Alerts about the FF servers for patch day and emergency maintenance |
| FFXIV Game Announcements | v1.Y.0 | 🔵 | Alerts about mogtome events, patch notes, etc... |
| Gear Calculator | v1.Y.Z | ⚪ | Feed an etro link of your current gear and the name of the content you want to do, and if you need any changes this will throw them back at you |
| Ocean Fishing Planner | v1.Y.Z | ⚪ | If there's an algorithm to study, this will provide you with the route and bait requirements of an ocean fishing trip |
| FFXIV Server Alerts | v1.Y.Z | ⚪ | Alerts to servers going back online on patch day, and emergency maintenance message from the devs |
| Teamcraft Integration | v1.Y.Z | ⚪ | Characters you've claimed from the lodestone will be shown what parts of a project they can help |
| Retainer Reward Possibilities | v1.Y.Z | ⚪ | List retainer venture rewards by job and level |
| Limited Job Helper | v1.Y.Z | ⚪ | Help finding and grabbing all the different spells and quests for limited jobs |
| Gold Saucer Guides | v1.Y.Z | ⚪ | Helpful guides on Triad rules, jumping puzzles, mini cactpot suggestions |
| XIV Timer Resets | v1.Y.Z | ⚪ | Opt-in service for resets on Custom Delivery, Grand Company, Housing, Roulettes etc. |
| Discord web dashboard | v2.0.0 | 🔵 | All the features of version 1, now with a GUI! |
| Map Generator | v2.Y.Z | ⚪ | Get a map of a duty's loot chests, mob spawns, or an area's loot, gathering, or fate locations |
| Content Positioning Guides | v2.Y.Z | ⚪ | Not sure where to stand for content? Enjoy a tasty guide for your role! |
