mirror of
https://github.com/monkeytypegame/monkeytype.git
synced 2024-11-14 11:37:06 +08:00
57 lines
3.1 KiB
Markdown
57 lines
3.1 KiB
Markdown
I know this is a little late:
|
|
|
|
# IMPORTANT: I will be taking a break from Monkeytype for the duration of December (and potentially a bit of January too). I will address all PRs and issues when I start working on the project again. For critical issues, email jack@monkeytype.com. Thanks.
|
|
|
|
|
|
[](https://monkeytype.com/)
|
|
<br />
|
|
|
|
|
|
|
|
|
|
|
|
# About
|
|
|
|
Monkeytype is a minimalistic and customizable typing test. It features many test modes, an account system to save your typing speed history, and user-configurable features such as themes, sounds, a smooth caret, and more. Monkeytype attempts to emulate the experience of natural typing during a typing test, by unobtrusively presenting the text prompts and displaying typed characters in-place, providing straightforward, real-time feedback on typos, speed, and accuracy.
|
|
|
|
# Features
|
|
|
|
- minimalistic design, with optional advertisements and focus mode while typing
|
|
- type what you see, see what you type
|
|
- live errors, wpm, and accuracy displays
|
|
- variety of test lengths and languages
|
|
- punctuation and numbers modes
|
|
- quotes
|
|
- themes
|
|
- smooth caret
|
|
- account system
|
|
- challenges and just-for-fun test modifiers
|
|
- and much more
|
|
|
|
# Discord bot
|
|
|
|
On the [Monkeytype Discord server](https://www.discord.gg/monkeytype), we added a Discord bot to auto-assign optional roles based on typing performance and challenge completion. You can find its code over at https://github.com/monkeytypegame/monkeytype-bot.
|
|
|
|
# Bug report or Feature request
|
|
|
|
If you encounter a bug or have a feature request, [send us an email](mailto:jack@monkeytype.com), [create an issue](https://github.com/monkeytypegame/monkeytype/issues), [create a discussion thread](https://github.com/monkeytypegame/monkeytype/discussions), or [join the Discord server](https://www.discord.gg/monkeytype).
|
|
|
|
# Want to Contribute?
|
|
|
|
Refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
|
|
# Code of Conduct
|
|
|
|
Before contributing to this repository, please read the [code of conduct](./CODE_OF_CONDUCT.md).
|
|
|
|
# Credits
|
|
|
|
[Montydrei](https://www.reddit.com/user/montydrei) for the name suggestion.
|
|
|
|
Everyone who provided valuable feedback on the [original Reddit post](https://www.reddit.com/r/MechanicalKeyboards/comments/gc6wx3/experimenting_with_a_completely_new_type_of/) for the prototype of this website.
|
|
|
|
All of the [contributors](https://github.com/monkeytypegame/monkeytype/graphs/contributors) that have helped with implementing various features, adding themes, fixing bugs, and more.
|
|
|
|
# Support
|
|
|
|
If you wish to support further development and feel extra awesome, you can [donate](https://ko-fi.com/monkeytype), [become a Patron](https://www.patreon.com/monkeytype) or [buy a t-shirt](https://www.monkeytype.store/).
|