| Revision | 413fd747c0e581acf614fe182d28b5d14dc22282 (tree) |
|---|---|
| Time | 2023-04-20 16:51:28 |
| Author | |
| Commiter | Remilia Scarlet |
update README
| @@ -1,8 +1,15 @@ | ||
| 1 | 1 | # MonikaBot |
| 2 | -MonikaBot is a simple bot for Discord, written in [Crystal](https://crystal-lang.org/). It is the spiritual | |
| 3 | -successor to [Sumomo-Go](https://gitlab.com/RemiliaScarlet/sumomo-go). | |
| 2 | + | |
| 3 | +MonikaBot is a simple bot for Discord, written in [Crystal](https://crystal-lang.org/). | |
| 4 | + | |
| 5 | +Wanna support Remilia? [Buy me a coffee on Ko-Fi](https://ko-fi.com/L4L614QNC), | |
| 6 | +or support me through Liberapay. | |
| 7 | + | |
| 8 | +<a href='https://ko-fi.com/L4L614QNC' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> | |
| 9 | +<a href="https://liberapay.com/RemiliaScarlet/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a> | |
| 4 | 10 | |
| 5 | 11 | ## How do I get set up? |
| 12 | + | |
| 6 | 13 | Clone this repository, then run `make release=1` (or just `make`). The binary will be in the `bin/` folder. |
| 7 | 14 | |
| 8 | 15 | Certain commands need external programs to operate. On startup, if the required program(s) is not found, the |
| @@ -18,33 +25,13 @@ | ||
| 18 | 25 | * !ascii: figlet |
| 19 | 26 | * !spell: aspell |
| 20 | 27 | |
| 21 | -## FAQ | |
| 22 | - | |
| 23 | -### What's still missing in v1.x? ### | |
| 24 | -The whole permission system is not yet implemented.... but since I don't think it was ever really used, this | |
| 25 | -shouldn't matter. However, non-admin users still cannot run admin commands! That has not changed. | |
| 26 | - | |
| 27 | -The `!forecast` command is currently disabled. There's a little bit of information why in | |
| 28 | -[this checkin](https://nanako.mooo.com/monikabot/info/05ea98671dc26e83) | |
| 29 | - | |
| 30 | -## Development Info | |
| 31 | - | |
| 32 | -Coming (back) soon. | |
| 28 | +## Contributors | |
| 33 | 29 | |
| 34 | -### Style info | |
| 35 | -I use a slightly different style for my code. | |
| 30 | +* Remilia Scarlet - creator and maintainer | |
| 31 | + * Homepage: [https://remilia.sdf.org/](https://remilia.sdf.org/) | |
| 32 | + * Mastodon: [@MistressRemilia@social.sdf.org](https://social.sdf.org/@MistressRemilia) | |
| 33 | + * Email: zremiliaz@postzeoz.jpz My real address does not contain Z's | |
| 36 | 34 | |
| 37 | -- Keep lines 118 characters or shorter. Obviously sometimes you can't, but please try. Use 115 characters for | |
| 38 | - Markdown files, though. | |
| 39 | -- Please use pascalCase for variable and method names. Use CamelCase for type names. Use UPPER_SNAKE_CASE for | |
| 40 | - constants. | |
| 41 | -- The type name for exceptions end with Error. For example, `ExternalProgramError`. | |
| 35 | +## Links and Licenses | |
| 42 | 36 | |
| 43 | -## How do I contribute? | |
| 44 | - | |
| 45 | -I do not use Git - **if you're reading this on Gitlab, you're looking at a mirror**. Let the Crystal folks know | |
| 46 | -you'd like them to support other VCSs. | |
| 47 | - | |
| 48 | -1. Clone the repository. | |
| 49 | -2. Add your feature and test it. | |
| 50 | -3. Create a pull request on OSDN. | |
| 37 | +MonikaBot is under the [GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html). |
| @@ -57,6 +57,7 @@ | ||
| 57 | 57 | # |
| 58 | 58 | |
| 59 | 59 | def self.randomArchChoice(mixed) |
| 60 | + | |
| 60 | 61 | if Utils.rand(100) < mixed |
| 61 | 62 | "mixed" |
| 62 | 63 | else |