Welcome to Sally (◕‿◕✿)

Sally is a friendly multipurpose discordbot. She provides many game integrations and interesting APIs. It is possible to customize Sally with self made plugins. The plugins need to be written in C#.

Quick Links

Homepage:
https://its-sally.net

Sally Invite Link:
https://invite.its-sally.net

Join the Discord server, if you are looking for support or just wanna hang out!
https://discord.gg/hjPRKyY

Overview

• Welcome to Sally (◕‿◕✿)

  • Quick Links

  • Overview

  • Commands

  • Features

    • Integrations - Games
    • Integrations - APIs
    • Build-In

  • Self-hosting

    • Windows
    • Linux
    • Mac
    • Docker

  • Support

  • Credits

  • Self-hosting

    • Windows
    • Linux
    • Mac
    • Docker

  • Support

  • Credits

Commands

All Commands can be found on the webpage: https://its-sally.net/commands. It will be updated regularly.

Features

Integrations - Games

• Oldschool Runescape
• Osu! (planned)
• League of Legends (planned)

Integrations - APIs

• Wikipedia
• OpenWeather
• Konachan
• Cleverbot
• more planned

Build-In

• Command suggestion
• YouTube music player
• Mood system
• Level and rankup system
• Livechat replies
• Service subscription

Self-hosting

• Prerequisite:
  • MySQL or (planned sqlite)
  • .NET 5

Windows

coming soon!

Linux

1. Install MySql Server
   Guide: How to install a mysql server on Ubuntu 20.04

2. Install .NET Core
   Guide: How to install .NET 5 on Ubuntu 20.04

3. Clone this repository

    git clone https://github.com/Chilllli/Sally.NET.git
   

4. Move into repo directory

    cd Sally.NET
   

5. Compile release build

    dotnet build Sally.NET.sln -c Release
   

6. Start the bot for the first time
   Note: The bot will crash because the config file is missing!

    dotnet Sally/bin/Release/net5.0/Sally.dll
   

7. Create a file named "configuration.json" under <git repo root>/Sally/bin/Release/net5.0/config
   Paste in following structure:

    {
    "Token":"",
    "DbUser":"",
    "Db":"",
    "DbPassword":"",
    "DbHost":"",
    "RadioControlChannel":"",
    "MeId":"",
    "GainedXp":"",
    "XpTimerInMin":"",
    "WeatherPlace":"",
    "WeatherApiKey":"",
    "CleverApi":"",
    "StarterChannel":"",
    "ClientId":""
    }
   

   Note: You need to provide your own values for these properties!

8. Run the bot again

    dotnet Sally/bin/Release/net5.0/Sally.dll
   

   Now the bot should run just fine. If something not working, you may check your credentials.

   Note: I recommend tmux or systemd to run the bot in the background.
   Guides:

   • Getting started with tmux
   • Getting started with systemd service

Mac

coming soon!

Docker

coming soon!

Support

You can support Sally directly with ko-fi or patreon.

• Ko-Fi
• Patreon

Credits

• avatar/character design: SakuraAlice33

Thanks for tuning in and have a awesome day! (づ｡◕‿‿◕｡)づ