KaikyuLotus / moe-moe-secretary

Moe Moe Secretary - Your waifu always with you!
GNU General Public License v3.0
24 stars 4 forks source link
arknights azurlane desktop-application java-8 sinoalice vtuber waifu

CI Status Codacy Badge

Moe Moe Secretary - Your waifu (almost) always with you!

Index

Installing

In order to install Moe Moe Secretary, please download the latest jar from the Github Releases\ You'll need a JRE (1.8+) installed, you can get it here.\ Place the JAR file in a secure place, better if it's in a folder

Usage

All the key commands must be used after clicking the waifu in order to obtains window focus.

Configuration

In the JAR file's folder, after starting MMS at least once, there will be a folder named "config",\ inside it you'll find a file named config.properties.

config.properties file contains all the settings for your secretary.

TIP: Saving this file will apply the changes to the secretary on the fly.

Check the next table to see all the possible Adapters and adapter-configurations.\ All the other settings are self-explanatory.

Adapters

Adapters are used to access different waifus on the internet.\ Moe Moe Secretary uses public wikis data to download images and dialogs, where available.\ If you think that a wiki does not like this behaviour, please open an issue.

The following table shows the adapter names to be used in the .properties file and their relative detailed chapter.

Adapter Name Chapter
AzurLane Azur Lane Chapter
GenshinImpact Genshin Impact Chapter
Arknights Arknights Chapter
SinoAlice SinoAlice Chapter
SIFIdol SIFIdol Chapter
GirlsFrontline Girls Frontline Chapter
MirageMemorial Mirage Memorial Chapter
Github Github Chapter
MMS Official Github MMS Github Chapter
File File Chapter
Features table
Feature Azur Lane Arknights SINoALICE SIFIdol GirlsFrontline MirageMemorial
Dialogs
Voices
Skins

Azur Lane Adapter

This adapter takes the data from https://azurlane.koumakan.jp \ Ship names are the same as in-game names, if you can't really find one take a look here.

Genshin Impact Adapter

This adapter takes the data from https://genshin-impact.fandom.com \ Character names are the same as in-game names, if you can't really find one take a look here.

Arknights Adapter

This adapter takes the data from https://github.com/Aceship/AN-EN-Tags \ Operator names are the same as in-game names, if you can't really find one, search for it here

SinoAlice Adapter

This adapter takes the data from https://sinoalice.game-db.tw \ Characters names are the same as in-game names, if you can't really find one take a look here.

School Idol Festival Adapter

This adapter takes card images from https://schoolido.lu and quotes from https://decaf.kouhi.me/lovelive/index.php \ This adapter requires the card ID as waifu.name in the config.properties, be sure to match the card ID from here.

Girls Frontline Adapter

This adapter takes the data from https://en.gfwiki.com \ Weapon names are the same as in-game names, if you can't really find one take a look here

Mirage Memorial Adapter

This adapter takes the data from https://miragememorialglobal.fandom.com/wiki \ Servant names are the same as in-game names, if you can't really find one take a look here:\ find your servant, click on the image and look at the URL, it'll end with "?file=Aristotle.png"\ use the string after = (without .png) (in this case Aristotle)

Github Adapter

Github adapter is the best one, but it has a cost: waifus must be implemented manually first.\ Moe Moe Secretary has an official repository for custom waifus (mostly VTubers), check the next chapter.

Github adapter requires some additional parameters in the config.properties:

adapter=Github
waifu.name=path/Name
adapter.file.format=format
github.repo=Username/repo
github.branch=branch

Those are the required parameters in order to use the github adapter,\ check the next chapter to see some example values.

Extra features

This adapter supports all MMS features!

MMS Github Adapter

Moe Moe Secretary has its own Github waifu repository.

In order to use it set the following values in your config.properties:

adapter=Github
waifu.name=VTuber/Hololive/Calliope
adapter.file.format=YAML
github.repo=KaikyuLotus/moe-moe-secretary-waifus
github.branch=master

With those settings Calliope-sama should pop-up on your desktop!

Want to add more waifus?\ Create an issue to add them or fork that repo and add them yourself, I'll accept PRs.

File Adapter

Please take a look at this link:\ https://telegra.ph/Moe-Moe-Secretary-File-Adapter-Configuration-01-12 \ It may be out of date, if so please open an issue or contact me on Telegram.

Help

If MMS crashes with a certain adapter or character you can open an issue or join the official Telegram group!\ We also have a CI bot, so you can update your MMS version directly from Telegram!\ Also check the FAQs

FAQ

Contributing

Details on contributions will be added later.

Screenshots


Ptilopsis from Arknights helping me with docs

Fubuki and her conifguration