Code Monkey home page Code Monkey logo

waifim-client's Introduction

Logo

Waifim

A Discord bot for random waifus using waifu.im.

⚙️ Setup

To install the bot, follow these steps:

  1. Clone the repository
  2. Install the required dependencies: yarn
  3. Rename .env.example to .env and paste your Discord bot token
  4. Update ownerId in /src/config/config.js
  5. Start the bot by running yarn start or start the dev server with yarn dev for nodemon

Warning

If you set GUILD_ID in the .env, the application commands will be registered in the provided guild only.

In order to have global commands, just leave it empty.

💡 Usage

The bot responds to the following commands:

  • /ping: Responds with the ping.
  • /tags: Responds with a list of the tags - Option to get information about a tag
  • /random: Responds with a random waifu - Options for tag & nsfw
  • /autopost start: Start autoposting a random waifu every 10 minutes in the channel
  • /autopost stop: Stop autoposting in the channel
  • /autopost list: [Owner Only] List all channels in the autopost list

Note

There is no help command.. May or may not have forgotten it. I'll add it later..

I'm planning on adding more stuff to the bot, this was just a first 'draft'

💖 Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue/PR!

Some things I'm planning on

  • Help command (;-;)
  • Change permissions for autopost (only admins can set channels)
  • And some other stuff I can't remember anymore...

📃 License

This project is licensed under the MIT License. See the LICENSE file for more information.

waifim-client's People

Contributors

fyxren avatar

Watchers

avatar

waifim-client's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.