wukong! is now discontinued and won't receive any more updates because of discord's new slash commands being enforced. you can still clone this repository and self-host it by making changes to the command handler, but i won't offer you any support at all.
wukong!
wukong! is a free and open source discord bot built from scratch mainly for learning purposes but also focusing on user experience. uppercase makes wukong uncomfortable.
table of contents
to-do
- user blacklisting
- music commands
- welcome message config
- new guild message
- user profiles
- profile customization
commands
you can find a list of wukong!'s commands at our docs
contributing
ideas
you got an idea? feel free to open an issue describing your idea, i'll take a look at it and consider adding it to the bot, make sure to take a look at the issues to make sure no one suggested it before.
coding
you can fork wukong! and make your changes to it, then open a pull request, if i find it appropriate and good enough i'll accept it.
keep in mind that your code might not be accepted, this depends on a lot of stuff, contact me on discord if you have any questions regarding this.
reporting bugs
you can report a bug by writing a bug report, please give me as much information as you can!
translation
you can contribute to the bot by translating it to another language or improving already existing sentences, check out the locale.json file, the structure is really simple, so it is really easy for wukong! to get any sentence in any language. if you are going to create the translation for a new language, copy the english object "en" and paste it at the bottom of the document, there you can edit "en" to another language code, and perform the translation for all the sentences.
make sure to leave all punctuation as is, if there are ` around a word, keep them in the translation, if there is a : at the end of the sentence, keep it in the translation.
self-hosting
keep in mind that wukong! is hosted 24/7 and if you don't pretend to make any changes to its code you can invite it to your server using this url.
please be aware that if you do self-host wukong! i won't be able to provide support, also, take a look at the license.
if you really wish to self-host wukong!, clone this repository by using
git clone https://github.com/Caslus/wukong.git
after you're done, you have to install wukong!'s dependencies, which may take a while depending on your connection. navigate to the repository folder and install the dependencies using
npm install
you can now edit edit the config.template.json file, setting your tokens and a few other configuration values, remember to edit the file name to config.json once you're done.
finally, run wukong! using
npm start
after that you should be good to go! 😼