mirror of
https://github.com/arthur-pbty/xiao.git
synced 2026-06-10 10:57:08 +02:00
Dragon Fire
72 lines
4.0 KiB
Markdown
72 lines
4.0 KiB
Markdown
## Agreement
|
|
|
|
You are not to publish this code to the public under any circumstance. It is
|
|
private, and if found on the web you may be held liable in court. Xiao is
|
|
not licensed, meaning her code is completely under copyright. No one is
|
|
allowed to use any part of her code under any circumstance unless given
|
|
explicit permission from the copyright holder.
|
|
|
|
I, as the copyright holder, grant you the ability to use it as a reference
|
|
point for your projects and allow you to use the code as a learning tool.
|
|
You may take ideas and reformat code into another library, but you may not
|
|
simply copy and self-host the code, unless the bot using it is COMPLETELY
|
|
PRIVATE. This means it cannot be added to any servers but those of the bot
|
|
owner.
|
|
|
|
If a public bot is found using Xiao's code it will be reported to Discord and
|
|
removed.
|
|
|
|
**Please don't push to the repository.** It will simply be reverted and your
|
|
rights to view it will be removed. Git is a powerful tool, so don't try your
|
|
luck on this one.
|
|
|
|
## Installing
|
|
|
|
### Before You Begin
|
|
|
|
1. Make sure you have installed [Node.js](https://nodejs.org/en/) (you will need **at least v15.0.0**) and [Git](https://git-scm.com/).
|
|
- If on Windows, [make sure to check the box in the section of the installer for "Tools for Native Modules"](https://i.imgur.com/RMrlz2S.png).
|
|
2. Clone this repository with `git clone https://github.com/dragonfire535/xiao.git`.
|
|
3. Run `cd xiao` to move into the folder that you just created.
|
|
4. Create a file named `.env` and fill it out as shown in `.env.example`.
|
|
|
|
### Windows
|
|
|
|
1. [Follow these instructions to install the dependencies for `node-canvas`](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows).
|
|
2. [Follow these instructions to install ffmpeg](https://www.wikihow.com/Install-FFmpeg-on-Windows).
|
|
3. [Install ImageMagick](https://imagemagick.org/script/download.php).
|
|
4. [Follow these instructions to install Redis](https://riptutorial.com/redis/example/29962/installing-and-running-redis-server-on-windows). Remember to set up a password!
|
|
5. Download [the NSFW model](https://github.com/gantman/nsfw_model) and extract the contents to `<xiao folder>/tf_models/nsfw`.
|
|
6. Download DECTalk and extract it to `<xiao folder>/dectalk`. You will have to find this yourself. You need the files `say.exe`, `dectalk.dll`, and `dtalk_us.dic`.
|
|
7. Run `npm i --production` in the folder you cloned the bot.
|
|
8. Run `npm i -g pm2` to install PM2.
|
|
9. Run `pm2 start Xiao.js --name xiao` to run the bot.
|
|
|
|
### Mac
|
|
|
|
1. Use a real (cheaper!) OS to host your bot.
|
|
2. ???
|
|
3. Profit.
|
|
|
|
### Ubuntu and other Debian-based systems
|
|
|
|
1. Run `apt update`.
|
|
2. Run `apt upgrade` to install the latest dependencies of your distro.
|
|
3. Run `apt install python` to install python.
|
|
4. Run `apt install ffmpeg` to install ffmpeg.
|
|
5. [Follow these instructions to install the dependencies for `node-canvas`](https://github.com/Automattic/node-canvas/wiki/Installation%3A-Ubuntu-and-other-Debian-based-systems).
|
|
6. Run `apt install liblqr-1-0-dev liblqr-1-0` to install liblqr (needed for ImageMagick).
|
|
7. [Follow these instructions to install ImageMagick](https://www.tecmint.com/install-imagemagick-on-debian-ubuntu/).
|
|
8. [Follow these instructions to set up Redis](https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04). Remember to set up a password!
|
|
9. Run `apt install libtool` so sodium can compile if necessary. **(Optional)**
|
|
10. Download [the NSFW model](https://github.com/gantman/nsfw_model) and extract the contents to `<xiao folder>/tf_models/nsfw`.
|
|
11. Download DECTalk and extract it to `<xiao folder>/dectalk`. You will have to find this yourself. You need the files `say.exe`, `dectalk.dll`, and `dtalk_us.dic`.
|
|
12. Run `apt install wine` to install wine.
|
|
13. Run `dpkg --add-architecture i386` to allow installation of `wine32`.
|
|
14. Run `apt update` again.
|
|
15. Run `apt install wine32` to install wine32.
|
|
16. Run `apt install xvfb` to install xvfb.
|
|
17. Run `npm i --production` in the folder you cloned the bot.
|
|
18. Run `npm i -g pm2` to install PM2.
|
|
19. Run `pm2 start Xiao.js --name xiao` to run the bot.
|