mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
Added installation guide
This commit is contained in:
@@ -16,6 +16,7 @@ Feel free to make any contributions you want, whether it be through creating an
|
||||
:maxdepth: 1
|
||||
:caption: General
|
||||
|
||||
installing
|
||||
migrating
|
||||
|
||||
.. toctree::
|
||||
|
||||
51
docs/installing.rst
Normal file
51
docs/installing.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. include:: ./vars.rst
|
||||
|
||||
Installing discord.js
|
||||
=====================
|
||||
|
||||
To install discord.js, you need a few dependencies.
|
||||
|
||||
.. warning:: **When installing with any of these methods, you'll encounter some errors.** This is because an optional dependency isn't working properly, but discord.js should still work fine.
|
||||
|
||||
-----------
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
------------
|
||||
|
||||
- You need `Visual Studio`_ and `Python 2.7`_.
|
||||
|
||||
Your Visual Studio installation ideally has to be recent, but you can try installing without it first. You can use **Express, Community, Enteprise** or any others apart from ``VS Code``.
|
||||
|
||||
After you have installed these things, to install just run: ``npm install --save --msvs_version=2015 discord.js`` to install the latest version of discord.js for your project.
|
||||
|
||||
Additional Audio Support
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- Install `ffmpeg`_ and add it to your PATH.
|
||||
|
||||
-----------
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
-----------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ apt-get install make build-essentials
|
||||
$ npm install --save discord.js
|
||||
|
||||
|
||||
|
||||
Additional Audio Support
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ apt-get install libav-tools
|
||||
|
||||
.. _Visual Studio : https://www.visualstudio.com/downloads/download-visual-studio-vs
|
||||
.. _Python 2.7 : https://www.python.org/download/releases/2.7.8/
|
||||
.. _ffmpeg : https://www.ffmpeg.org/download.html
|
||||
Reference in New Issue
Block a user