· 6 years ago · Nov 11, 2019, 08:22 PM
1<table>
2<thead><tr><th style="text-align:center"><a href="https://yamamura.xyz"><img title="Yamamura" alt="Logo" src="https://yamamura.xyz/logo.png"></a></th></tr></thead>
3<tbody><tr><td style="text-align:center"><img title="Bot Status" alt="Status" src="https://discordbots.org/api/widget/status/421158339129638933.svg"> <img title="The amount of servers the bot is in" alt="Server Count" src="https://discordbots.org/api/widget/servers/421158339129638933.svg"> <img title="The language the bot is coded in" alt="Library" src="https://img.shields.io/badge/lib-discord.js-yellow"> <a href="https://discord.gg/vbYZCRZ"><img title="Chat" alt="Discord" src="https://img.shields.io/discord/484464227067887645.svg"></a></td></tr></tbody>
4</table>
5
6Yamamura is an all-in-one Discord bot for assisting modding communities and more
7It can fulfill your server's moderation needs and create fun events for your community to enjoy, as well as provide necessary information on modding your nintendo consoles and applications.
8
9**Things our bot has**
10
11- Website to see what we have to offer
12- Experience Points, made to reward users
13- Server Event Logging
14- Over 100 commands
15
16To check out the commands, either check out our website or use the commands command.
17
18__**Image Manipulation**__
19Yamamura can modify your images in many ways, whether it be distorting, glitching, adding a fire effect or even putting a cover onto the image.
20They can be supplied with either attachments, user mentions, user IDs, user names, or links as an image.
21
22- If the channel in question has an image attachment before, you don't need to supply the image link all the time: It'll automatically collect it for you based on the previous message.
23- Multiple attachments and links will end up layering the image. Go nuts combining multiple images together, with proper resizing for each
24- Supported image types are PNG, JP(E)G, GIF (will loose animation) and BMPs (DS Homebrew BMPs supported)
25- Due to BMPs not being rendered in discord, they are instead exported as PNGs, hence why the pngify command exists.
26- If all you want to do is combine images, use the pngify command
27
28**Cover Commands**
29
30Yamamura features cover commands which allow you to create your very own game for that media. We have many customizable arguments too.
31
32- Remember Tropical Freeze's Funky Mode? Well, its back in full Funky swing for other platforms too (except Wii and Wii U)! Just add the `--funky` flag to the command
33- Wanna rate a newly created game as for "noob gamers"? What if it promotes "violence"? Well, Yamamura can have those things in the generated cover commands too. Just add `rating:`, define your rating type (`ESRB` or `PEGI`) and then add your rate (`eC`, `e`, `e10`, `T`, `M` & `AO` for ESRB with `3`, `7`, `12`, `16` & `18` for PEGI)
34
35**__Customization__**
36Yamamura allows users to customize the bot in many ways possible. From having custom randomized user join, leave & level up messages to enabling server logging (to be used instead of the audit log), the experience can be tweaked to an administrator's liking. Use the `config` command to change a server's configuration (if you're an admin of that server).
37
38- There are a few types of configuration values: channels, strings, integers, commands & True/False. All of these can be placed in an array.
39- We are working on documenting the configuration system.
40- To set an empty value, set the value to `null`
41
42Once we get a dashboard up and running, you can use the website as a replacement, making inputting new configurations much easier. You'd also be able to export/import the server configuration to/from a JSON file, allowing you to have a backup of things and easily switch between different configurations
43
44**__Homebrew__**
45Yamamura has access to a large database of Nintendo DS homebrew titles, so you can get information about your favorite homebrew whenever you want.
46
47- Get compatibility reports of your DS games with nds-bootstrap
48- Access a large list of DS homebrews, from Pokémon Bank all the way to the DSi Menu replacement
49- Read guides on how to install HiyaCFW, the only custom firmware for the DSi
50- Find kernels for your favorite flashcards
51
52Obviously, since Yamamura is focused on modding communities, you can be sure this info stays up-to-date.
53
54__**Server Experience Points**__
55Want to have a way to reward your members for being active? That's the purpose of Server Experience Points
56Every time you send a message, Yamamura will generate a random number between (and including) 0-3. It will then add that to your points for that server. Every 350 messages grants you a level up.
57
58- Wanna use this in a competitive way of sorts? Leaderboard does just that.
59- Its a users birthday? Gift them some server points with the gift command
60- Hate how distracting level up messages are? Server Admins can turn them off!
61- Level Up Messages just aint pretty enough? Server Admins can customize them
62
63Every message delete and message edit runs the randomizer again but then removes the point instead of adding them. Of course, in the case of message edits, the randomizer that adds points will also run.
64
65**__Server Management Tools__**
66
67Yamamura has some power tools to help out with server management, ranging from taking action on users to logging what they do.
68
69- There's no longer a need to manually count down how many warnings a user has; Yamamura will do it for you (provided the server admin uses the warn command)
70- Wanna give the member a reason for a mute/kick/ban without having to show yourself? Just use the respective moderation command
71 - Keep in mind that the mute command is only a role assigner, not a permission modifier. You'll need to setup the perms yourself
72- A user keep on deleting their messages to make ghost pings? Yamamura can log those types of messages.
73- Spam in a channel that you don't want to click on every message individually to remove it? Until Discord implements the ability, you can use the purge command. It has many customization options, such as only deleting messages by bots, one that starts with a certain word and other things too
74 - Keep in mind that Yamamura does not log these messages. Please be sure to backup anything important in case a user error happens.
75- A user self advertising in their play status? How about a non alphabetical nickname? Yamamura can check for those too and tell you the users when you run the command.
76
77The amount of things Yamamura can do depends on the permissions you give it. This is why we don't include permissions in the invite link itself, defaulting it to no perms.
78
79**__Multiple Languages__**
80Thanks to training from Nina and Mary O, Yamamura has learned the ability to speak English....alongside Italian, Japanese, Polish & Russian.
81Just type `lang [language code]` to tell the bird your favorite language, and it will immediately start speaking it.
82
83- It's bound to your user ID, meaning that it'll follow you in every channel
84- Want a list of languages alongside their language code? Just have no language code as a parameter in the language command.
85- Yamamura doesn't speak your language? Don't worry, Mario was frustrated too. Just go ahead and follow the steps found in the pins of #translation on the discord server.
86
87Be sure to check frequently! If your language isn't yet supported, it's possible that the next time you check it'll be there.
88*Please note that since the bot is constantly growing in functionality, it's possible that not everything is translated. We're working hard on doing so, though!*
89
90**__Helping Out__**
91Do you want to help make Yamamura the best bot possible?!
92If so, here's how you can help us out:
93
94- Find a bug? Report it! Our developers will take care of it as soon as possible.
95- Spread the word! The more servers the bot is in, there will be more people to experience the bot.
96- Join our Discord Server! You can express your opinion about the bot there as well as partake in development. <https://invite.gg/Yamamura>
97- Let us know what you think of the bot, and what we should add or change! We take your opinion seriously.
98- Upvote the bot on the bot list of your preference. The more upvotes we get, the higher we are on their list.
99- If you're a programmer, you can help out with Yamamura development by sending pull requests on our GitLab repository: <https://gitlab.com/Samplasion/yamamura-discord-bot>
100
101We're currently looking for help in regards to rewritting the website in Fastify alongside adding highly requested/complex features.
102We use Node.JS as the language backend alongside Discord.JS with Discord-Akairo.
103- Help @JeDaYoshi#7942 pay for a server by donating to his PayPal: https://paypal.me/Naydire.
104Currently, Yamamura is running on a VPS he's borrowing, but by donating, you can help maintain the server and buy a better one.
105- Documentation is quite sparse at the moment. We need you to help fill it out by documenting what each command does and give descriptions to the command parameters. You can do so by Sending a Pull Request on our GitLab repository.
106- Do you know another language? Help translate Yamamura.
107
108__**Credits**__
109
110@NightYoshi370#5597 - Lead Developer
111@Samplasion#0325 - Co-Developer, Italian Translation, made initial translation system, initial setting system and initial website code
112@Javier107#6900 - Providing covers for us to use
113@JeDaYoshi#7942 - Managing Server Stuff
114TheBITLink - Owning the server we currently use
115@Pk11#1288 - Owning the testing server and the Pi we use for reverse proxy, Japanese Translation
116
117Those who submitted bug reports and suggestions: Improving the bot experience daily
118Those who translated Yamamura/document the bot: Helping users understand the bot
119Those who put Yamamura on their server: Helping us spread the word
120Those of you who use Yamamura: Enjoying our bot
121
122...and you, for being here!