Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bc989580a9 | ||
|
|
477567b05d | ||
|
|
6a1d66fd36 | ||
|
|
ca865b322e | ||
|
|
615ee2029b | ||
|
|
da1f08a070 | ||
|
|
2bdc7b8583 | ||
|
|
727731695e | ||
|
|
5f8b513269 | ||
|
|
fcb0267559 | ||
|
|
6b903cff5e | ||
|
|
9320a7476e |
@@ -21,4 +21,7 @@ OLLAMA_PORT = PORT
|
|||||||
DISCORD_IP = IP_ADDRESS
|
DISCORD_IP = IP_ADDRESS
|
||||||
|
|
||||||
# subnet address, ex. 172.18.0.0 as we use /16.
|
# subnet address, ex. 172.18.0.0 as we use /16.
|
||||||
SUBNET_ADDRESS = ADDRESS
|
SUBNET_ADDRESS = ADDRESS
|
||||||
|
|
||||||
|
# list of admins to handle admin commands for the bot, use single quotes
|
||||||
|
ADMINS=['username1', 'username2', 'username3', ...]
|
||||||
5
.github/CONTRIBUTING.md
vendored
5
.github/CONTRIBUTING.md
vendored
@@ -23,10 +23,7 @@
|
|||||||
## Environment
|
## Environment
|
||||||
* You will need two environment files:
|
* You will need two environment files:
|
||||||
* `.env`: for running the bot
|
* `.env`: for running the bot
|
||||||
* `CLIENT_TOKEN`: the token for the bot to log in
|
* Please refer to `.env.sample` for all environment variables to include
|
||||||
* `CHANNEL_ID`: the id of the channel you wish for the bot to listen in
|
|
||||||
* `MODEL`: the mode you wish to use
|
|
||||||
* `BOT_UID`: the user id the bot goes by (the id of the discord user)
|
|
||||||
* `.env.dev.local`: also runs the bot, but with development variables
|
* `.env.dev.local`: also runs the bot, but with development variables
|
||||||
* Currently there are no differences between the two, but when needed, you may add environment variables as needed.
|
* Currently there are no differences between the two, but when needed, you may add environment variables as needed.
|
||||||
|
|
||||||
|
|||||||
84
.github/workflows/build-test.yml
vendored
Normal file
84
.github/workflows/build-test.yml
vendored
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
name: Builds
|
||||||
|
run-name: Validate Node and Docker Builds
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
Discord-Node-Build: # test if the node install and run
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 2
|
||||||
|
steps:
|
||||||
|
- name: Checkout Repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Node Environment v18.18.2
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 18.18.2
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install Project Dependencies
|
||||||
|
run: |
|
||||||
|
npm install
|
||||||
|
|
||||||
|
- name: Build Application
|
||||||
|
run: |
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
- name: Create Environment Variables
|
||||||
|
run: |
|
||||||
|
touch .env
|
||||||
|
echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
|
||||||
|
echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
|
||||||
|
echo CHANNEL_ID = ${{ secrets.CHANNEL_ID }} >> .env
|
||||||
|
echo MODEL = ${{ secrets.MODEL }} >> .env
|
||||||
|
echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
|
||||||
|
echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
|
||||||
|
echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
|
||||||
|
echo ADMINS = ${{ secrets.ADMINS }} >> .env
|
||||||
|
|
||||||
|
# set -e ensures if nohup fails, this section fails
|
||||||
|
- name: Startup Discord Bot Client
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
nohup npm run prod &
|
||||||
|
|
||||||
|
Discord-Ollama-Container-Build: # test docker build and run
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 2
|
||||||
|
steps:
|
||||||
|
- name: Checkout Repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Node Environment v18.18.2
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 18.18.2
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Create Environment Variables
|
||||||
|
run: |
|
||||||
|
touch .env
|
||||||
|
echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
|
||||||
|
echo GUILD_ID = ${{ secrets.GUILD_ID }} >> .env
|
||||||
|
echo CHANNEL_ID = ${{ secrets.CHANNEL_ID }} >> .env
|
||||||
|
echo MODEL = ${{ secrets.MODEL }} >> .env
|
||||||
|
echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
|
||||||
|
echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
|
||||||
|
echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
|
||||||
|
echo ADMINS = ${{ secrets.ADMINS }} >> .env
|
||||||
|
|
||||||
|
- name: Setup Docker Network and Images
|
||||||
|
run: |
|
||||||
|
npm run docker:start-cpu
|
||||||
|
|
||||||
|
- name: Check Images Exist
|
||||||
|
run: |
|
||||||
|
(docker images | grep -q 'discord/bot' && docker images | grep -qE 'ollama/ollama') || exit 1
|
||||||
|
|
||||||
|
- name: Check Containers Exist
|
||||||
|
run: |
|
||||||
|
(docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1
|
||||||
|
|
||||||
395
LICENSE
Normal file
395
LICENSE
Normal file
@@ -0,0 +1,395 @@
|
|||||||
|
Attribution 4.0 International
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are
|
||||||
|
intended for use by those authorized to give the public
|
||||||
|
permission to use material in ways otherwise restricted by
|
||||||
|
copyright and certain other rights. Our licenses are
|
||||||
|
irrevocable. Licensors should read and understand the terms
|
||||||
|
and conditions of the license they choose before applying it.
|
||||||
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public
|
||||||
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Attribution 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
|
Attribution 4.0 International Public License ("Public License"). To the
|
||||||
|
extent this Public License may be interpreted as a contract, You are
|
||||||
|
granted the Licensed Rights in consideration of Your acceptance of
|
||||||
|
these terms and conditions, and the Licensor grants You such rights in
|
||||||
|
consideration of benefits the Licensor receives from making the
|
||||||
|
Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
|
||||||
|
Section 1 -- Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
|
Rights that is derived from or based upon the Licensed Material
|
||||||
|
and in which the Licensed Material is translated, altered,
|
||||||
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
|
permission under the Copyright and Similar Rights held by the
|
||||||
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
|
Material is a musical work, performance, or sound recording,
|
||||||
|
Adapted Material is always produced where the Licensed Material is
|
||||||
|
synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
|
closely related to copyright including, without limitation,
|
||||||
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
|
Rights, without regard to how the rights are labeled or
|
||||||
|
categorized. For purposes of this Public License, the rights
|
||||||
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
|
Rights.
|
||||||
|
|
||||||
|
d. Effective Technological Measures means those measures that, in the
|
||||||
|
absence of proper authority, may not be circumvented under laws
|
||||||
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
|
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
f. Licensed Material means the artistic or literary work, database,
|
||||||
|
or other material to which the Licensor applied this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
g. Licensed Rights means the rights granted to You subject to the
|
||||||
|
terms and conditions of this Public License, which are limited to
|
||||||
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
|
Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
h. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
|
under this Public License.
|
||||||
|
|
||||||
|
i. Share means to provide material to the public by any means or
|
||||||
|
process that requires permission under the Licensed Rights, such
|
||||||
|
as reproduction, public display, public performance, distribution,
|
||||||
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
j. Sui Generis Database Rights means rights other than copyright
|
||||||
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
|
as amended and/or succeeded, as well as other essentially
|
||||||
|
equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
k. You means the individual or entity exercising the Licensed Rights
|
||||||
|
under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
|
||||||
|
Section 2 -- Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
|
in part; and
|
||||||
|
|
||||||
|
b. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The
|
||||||
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
|
all media and formats whether now known or hereafter created,
|
||||||
|
and to make technical modifications necessary to do so. The
|
||||||
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
4. If You Share Adapted Material You produce, the Adapter's
|
||||||
|
License You apply must not prevent recipients of the Adapted
|
||||||
|
Material from complying with this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material; and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public
|
||||||
|
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||||
|
its public licenses to material it publishes and in those instances
|
||||||
|
will be considered the “Licensor.” The text of the Creative Commons
|
||||||
|
public licenses is dedicated to the public domain under the CC0 Public
|
||||||
|
Domain Dedication. Except for the limited purpose of indicating that
|
||||||
|
material is shared under a Creative Commons public license or as
|
||||||
|
otherwise permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the
|
||||||
|
public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
28
README.md
28
README.md
@@ -1,5 +1,27 @@
|
|||||||
# Discord Ollama Integration [](https://creativecommons.org/licenses/by-nc/4.0/) [](https://github.com/kevinthedang/discord-ollama/releases/latest)
|
<div align="center">
|
||||||
Ollama is an AI model management tool that allows users to install and use custom large language models locally. The goal is to create a discord bot that will utilize Ollama and chat with it on a Discord!
|
<p><a href="#"><a href="https://ollama.ai/"><img alt="ollama" src="./imgs/ollama-icon.png" width="200px" /></a><img alt="+" src="./imgs/grey-plus.png" width="100px" /></a><a href="https://discord.com/"><img alt="discord" src="./imgs/discord-icon.png" width="195px" /></a></p>
|
||||||
|
<h1>Discord Ollama Integration</h1>
|
||||||
|
<h3><a href="#"></a>Ollama as your Discord AI Assistant</h3>
|
||||||
|
<p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
|
||||||
|
<a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
|
||||||
|
<a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build-test.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build-test.yml/badge.svg" /></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## About/Goals
|
||||||
|
Ollama is an AI model management tool that allows users to install and use custom large language models locally.
|
||||||
|
The project aims to:
|
||||||
|
* [x] Create a Discord bot that will utilize Ollama and chat to chat with users!
|
||||||
|
* [ ] User Preferences on Chat
|
||||||
|
* [ ] Message Persistance on Channels and Threads
|
||||||
|
* [x] Containerization with Docker
|
||||||
|
* [x] Slash Commands Compatible
|
||||||
|
* [x] Generated Token Length Handling for >2000 ~~or >6000 characters~~
|
||||||
|
* [ ] Token Length Handling of any message size
|
||||||
|
* [ ] External WebUI Integration
|
||||||
|
* [ ] Administrator Role Compatible
|
||||||
|
* [ ] Allow others to create their own models personalized for their own servers!
|
||||||
|
* [ ] Documentation on creating your own LLM
|
||||||
|
* [ ] Documentation on web scrapping and cleaning
|
||||||
|
|
||||||
## Environment Setup
|
## Environment Setup
|
||||||
* Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
|
* Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
|
||||||
@@ -28,4 +50,4 @@ Ollama is an AI model management tool that allows users to install and use custo
|
|||||||
* [Kevin Dang](https://github.com/kevinthedang)
|
* [Kevin Dang](https://github.com/kevinthedang)
|
||||||
* [Jonathan Smoley](https://github.com/JT2M0L3Y)
|
* [Jonathan Smoley](https://github.com/JT2M0L3Y)
|
||||||
|
|
||||||
[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1)
|
[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
||||||
@@ -8,7 +8,7 @@ services:
|
|||||||
build: ./ # find docker file in designated path
|
build: ./ # find docker file in designated path
|
||||||
container_name: discord
|
container_name: discord
|
||||||
restart: always # rebuild container always
|
restart: always # rebuild container always
|
||||||
image: discord/bot:0.2.0
|
image: discord/bot:0.4.0
|
||||||
environment:
|
environment:
|
||||||
CLIENT_TOKEN: ${CLIENT_TOKEN}
|
CLIENT_TOKEN: ${CLIENT_TOKEN}
|
||||||
GUILD_ID: ${GUILD_ID}
|
GUILD_ID: ${GUILD_ID}
|
||||||
@@ -17,6 +17,7 @@ services:
|
|||||||
CLIENT_UID: ${CLIENT_UID}
|
CLIENT_UID: ${CLIENT_UID}
|
||||||
OLLAMA_IP: ${OLLAMA_IP}
|
OLLAMA_IP: ${OLLAMA_IP}
|
||||||
OLLAMA_PORT: ${OLLAMA_PORT}
|
OLLAMA_PORT: ${OLLAMA_PORT}
|
||||||
|
ADMINS: ${ADMINS}
|
||||||
networks:
|
networks:
|
||||||
ollama-net:
|
ollama-net:
|
||||||
ipv4_address: ${DISCORD_IP}
|
ipv4_address: ${DISCORD_IP}
|
||||||
|
|||||||
BIN
imgs/discord-icon.png
Normal file
BIN
imgs/discord-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
BIN
imgs/grey-plus.png
Normal file
BIN
imgs/grey-plus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
BIN
imgs/ollama-icon.png
Normal file
BIN
imgs/ollama-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 93 KiB |
44
package-lock.json
generated
44
package-lock.json
generated
@@ -1,18 +1,18 @@
|
|||||||
{
|
{
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.3.0",
|
"version": "0.4.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.3.0",
|
"version": "0.4.0",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"axios": "^1.6.2",
|
"axios": "^1.6.2",
|
||||||
"discord.js": "^14.14.1",
|
"discord.js": "^14.14.1",
|
||||||
"dotenv": "^16.3.1",
|
"dotenv": "^16.3.1",
|
||||||
"ollama": "^0.4.6"
|
"ollama": "^0.5.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^20.10.5",
|
"@types/node": "^20.10.5",
|
||||||
@@ -546,15 +546,15 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@sapphire/shapeshift": {
|
"node_modules/@sapphire/shapeshift": {
|
||||||
"version": "3.9.6",
|
"version": "3.9.7",
|
||||||
"resolved": "https://registry.npmjs.org/@sapphire/shapeshift/-/shapeshift-3.9.6.tgz",
|
"resolved": "https://registry.npmjs.org/@sapphire/shapeshift/-/shapeshift-3.9.7.tgz",
|
||||||
"integrity": "sha512-4+Na/fxu2SEepZRb9z0dbsVh59QtwPuBg/UVaDib3av7ZY14b14+z09z6QVn0P6Dv6eOU2NDTsjIi0mbtgP56g==",
|
"integrity": "sha512-4It2mxPSr4OGn4HSQWGmhFMsNFGfFVhWeRPCRwbH972Ek2pzfGRZtb0pJ4Ze6oIzcyh2jw7nUDa6qGlWofgd9g==",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.3",
|
"fast-deep-equal": "^3.1.3",
|
||||||
"lodash": "^4.17.21"
|
"lodash": "^4.17.21"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=v18"
|
"node": ">=v16"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@sapphire/snowflake": {
|
"node_modules/@sapphire/snowflake": {
|
||||||
@@ -567,9 +567,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@tsconfig/node10": {
|
"node_modules/@tsconfig/node10": {
|
||||||
"version": "1.0.9",
|
"version": "1.0.11",
|
||||||
"resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz",
|
"resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz",
|
||||||
"integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==",
|
"integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/@tsconfig/node12": {
|
"node_modules/@tsconfig/node12": {
|
||||||
@@ -591,9 +591,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/@types/node": {
|
"node_modules/@types/node": {
|
||||||
"version": "20.11.28",
|
"version": "20.12.7",
|
||||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.28.tgz",
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.7.tgz",
|
||||||
"integrity": "sha512-M/GPWVS2wLkSkNHVeLkrF2fD5Lx5UC4PxA0uZcKc6QqbIQUJyW1jVjueJYi1z8n0I5PxYrtpnPnWglE+y9A0KA==",
|
"integrity": "sha512-wq0cICSkRLVaf3UGLMGItu/PtdY7oaXaI/RVU+xliKVOtRna3PRY57ZDfztpDL0n11vfymMUnXv8QwYCO7L1wg==",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"undici-types": "~5.26.4"
|
"undici-types": "~5.26.4"
|
||||||
}
|
}
|
||||||
@@ -1142,9 +1142,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/ollama": {
|
"node_modules/ollama": {
|
||||||
"version": "0.4.9",
|
"version": "0.5.0",
|
||||||
"resolved": "https://registry.npmjs.org/ollama/-/ollama-0.4.9.tgz",
|
"resolved": "https://registry.npmjs.org/ollama/-/ollama-0.5.0.tgz",
|
||||||
"integrity": "sha512-hVf5xix5zwswfMN6ydt3K2TS886aOk9RT9xksajXxdIHhi2yokEsdzJYE7IGg+1bjQSPZ6JHzHbESYjNB0pTCg==",
|
"integrity": "sha512-CRtRzsho210EGdK52GrUMohA2pU+7NbgEaBG3DcYeRmvQthDO7E2LHOkLlUUeaYUlNmEd8icbjC02ug9meSYnw==",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"whatwg-fetch": "^3.6.20"
|
"whatwg-fetch": "^3.6.20"
|
||||||
}
|
}
|
||||||
@@ -1310,9 +1310,9 @@
|
|||||||
"integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q=="
|
"integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q=="
|
||||||
},
|
},
|
||||||
"node_modules/tsx": {
|
"node_modules/tsx": {
|
||||||
"version": "4.7.1",
|
"version": "4.7.2",
|
||||||
"resolved": "https://registry.npmjs.org/tsx/-/tsx-4.7.1.tgz",
|
"resolved": "https://registry.npmjs.org/tsx/-/tsx-4.7.2.tgz",
|
||||||
"integrity": "sha512-8d6VuibXHtlN5E3zFkgY8u4DX7Y3Z27zvvPKVmLon/D4AjuKzarkUBTLDBgj9iTQ0hg5xM7c/mYiRVM+HETf0g==",
|
"integrity": "sha512-BCNd4kz6fz12fyrgCTEdZHGJ9fWTGeUzXmQysh0RVocDY3h4frk05ZNCXSy4kIenF7y/QnrdiVpTsyNRn6vlAw==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"esbuild": "~0.19.10",
|
"esbuild": "~0.19.10",
|
||||||
@@ -1329,9 +1329,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/typescript": {
|
"node_modules/typescript": {
|
||||||
"version": "5.4.2",
|
"version": "5.4.5",
|
||||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.2.tgz",
|
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
|
||||||
"integrity": "sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==",
|
"integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"bin": {
|
"bin": {
|
||||||
"tsc": "bin/tsc",
|
"tsc": "bin/tsc",
|
||||||
|
|||||||
14
package.json
14
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.3.0",
|
"version": "0.4.0",
|
||||||
"description": "Ollama Integration into discord",
|
"description": "Ollama Integration into discord",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
"exports": "./build/index.js",
|
"exports": "./build/index.js",
|
||||||
@@ -10,14 +10,16 @@
|
|||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"prod": "node .",
|
"prod": "node .",
|
||||||
"client": "npm run build && npm run prod",
|
"client": "npm run build && npm run prod",
|
||||||
"clean": "docker compose down && docker rmi $(docker images | grep 0.2.0 | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
"clean": "docker compose down && docker rmi $(docker images | grep $(node -p \"require('./package.json').version\") | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
||||||
"start": "docker compose build --no-cache && docker compose up -d",
|
"start": "docker compose build --no-cache && docker compose up -d",
|
||||||
"docker:start": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
|
"docker:start": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
|
||||||
|
"docker:start-cpu": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu",
|
||||||
"docker:clean": "docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
"docker:clean": "docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
||||||
"docker:network": "docker network create --subnet=172.18.0.0/16 ollama-net",
|
"docker:network": "docker network create --subnet=172.18.0.0/16 ollama-net",
|
||||||
"docker:build": "docker build --no-cache -t discord/bot:0.2.0 .",
|
"docker:build": "docker build --no-cache -t discord/bot:$(node -p \"require('./package.json').version\") .",
|
||||||
"docker:client": "docker run -d -v discord:/src/app --name discord --network ollama-net --ip 172.18.0.3 discord",
|
"docker:client": "docker run -d -v discord:/src/app --name discord --network ollama-net --ip 172.18.0.3 discord/bot:$(node -p \"require('./package.json').version\")",
|
||||||
"docker:ollama": "docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest"
|
"docker:ollama": "docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest",
|
||||||
|
"docker:ollama-cpu": "docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest"
|
||||||
},
|
},
|
||||||
"author": "Kevin Dang",
|
"author": "Kevin Dang",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
@@ -25,7 +27,7 @@
|
|||||||
"axios": "^1.6.2",
|
"axios": "^1.6.2",
|
||||||
"discord.js": "^14.14.1",
|
"discord.js": "^14.14.1",
|
||||||
"dotenv": "^16.3.1",
|
"dotenv": "^16.3.1",
|
||||||
"ollama": "^0.4.6"
|
"ollama": "^0.5.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^20.10.5",
|
"@types/node": "^20.10.5",
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { Client, GatewayIntentBits } from 'discord.js'
|
|||||||
import { UserMessage, registerEvents } from './utils/events.js'
|
import { UserMessage, registerEvents } from './utils/events.js'
|
||||||
import Events from './events/index.js'
|
import Events from './events/index.js'
|
||||||
import { Ollama } from 'ollama'
|
import { Ollama } from 'ollama'
|
||||||
|
import { Queue } from './queues/queue.js'
|
||||||
|
|
||||||
// Import keys/tokens
|
// Import keys/tokens
|
||||||
import Keys from './keys.js'
|
import Keys from './keys.js'
|
||||||
@@ -23,12 +24,7 @@ const ollama = new Ollama({
|
|||||||
})
|
})
|
||||||
|
|
||||||
// Create Queue managed by Events
|
// Create Queue managed by Events
|
||||||
const messageHistory: [UserMessage] = [
|
const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
|
||||||
{
|
|
||||||
role: 'system',
|
|
||||||
content: 'Your name is Ollama GU'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* register events for bot to listen to in discord
|
* register events for bot to listen to in discord
|
||||||
@@ -44,4 +40,10 @@ await client.login(Keys.clientToken)
|
|||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
console.error('[Login Error]', error)
|
console.error('[Login Error]', error)
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
// queue up bots name
|
||||||
|
messageHistory.enqueue({
|
||||||
|
role: 'assistant',
|
||||||
|
content: `My name is ${client.user?.username}`
|
||||||
})
|
})
|
||||||
33
src/commands/capacity.ts
Normal file
33
src/commands/capacity.ts
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
|
||||||
|
import { SlashCommand } from '../utils/commands.js'
|
||||||
|
import { openFile } from '../utils/jsonHandler.js'
|
||||||
|
|
||||||
|
export const Capacity: SlashCommand = {
|
||||||
|
name: 'modify-capacity',
|
||||||
|
description: 'number of messages bot will hold for context.',
|
||||||
|
|
||||||
|
// set available user options to pass to the command
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'context-capacity',
|
||||||
|
description: 'a number to set capacity',
|
||||||
|
type: ApplicationCommandOptionType.Number,
|
||||||
|
required: true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
// Query for message information and set the style
|
||||||
|
run: async (client: Client, interaction: CommandInteraction) => {
|
||||||
|
// fetch channel and message
|
||||||
|
const channel = await client.channels.fetch(interaction.channelId)
|
||||||
|
if (!channel || channel.type !== ChannelType.GuildText) return
|
||||||
|
|
||||||
|
// set state of bot chat features
|
||||||
|
openFile('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)
|
||||||
|
|
||||||
|
interaction.reply({
|
||||||
|
content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,
|
||||||
|
ephemeral: true
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
33
src/commands/disable.ts
Normal file
33
src/commands/disable.ts
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
|
||||||
|
import { SlashCommand } from '../utils/commands.js'
|
||||||
|
import { openFile } from '../utils/jsonHandler.js'
|
||||||
|
|
||||||
|
export const Disable: SlashCommand = {
|
||||||
|
name: 'toggle-chat',
|
||||||
|
description: 'toggle all chat features, slash commands will still work.',
|
||||||
|
|
||||||
|
// set available user options to pass to the command
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'enabled',
|
||||||
|
description: 'true = enabled, false = disabled',
|
||||||
|
type: ApplicationCommandOptionType.Boolean,
|
||||||
|
required: true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
// Query for message information and set the style
|
||||||
|
run: async (client: Client, interaction: CommandInteraction) => {
|
||||||
|
// fetch channel and message
|
||||||
|
const channel = await client.channels.fetch(interaction.channelId)
|
||||||
|
if (!channel || channel.type !== ChannelType.GuildText) return
|
||||||
|
|
||||||
|
// set state of bot chat features
|
||||||
|
openFile('config.json', interaction.commandName, interaction.options.get('enabled')?.value)
|
||||||
|
|
||||||
|
interaction.reply({
|
||||||
|
content: `Chat features has been \`${interaction.options.get('enabled')?.value ? "enabled" : "disabled" }\``,
|
||||||
|
ephemeral: true
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,9 +2,15 @@ import { SlashCommand } from '../utils/commands.js'
|
|||||||
import { ThreadCreate } from './threadCreate.js'
|
import { ThreadCreate } from './threadCreate.js'
|
||||||
import { MessageStyle } from './messageStyle.js'
|
import { MessageStyle } from './messageStyle.js'
|
||||||
import { MessageStream } from './messageStream.js'
|
import { MessageStream } from './messageStream.js'
|
||||||
|
import { Disable } from './disable.js'
|
||||||
|
import { Shutoff } from './shutoff.js'
|
||||||
|
import { Capacity } from './capacity.js'
|
||||||
|
|
||||||
export default [
|
export default [
|
||||||
ThreadCreate,
|
ThreadCreate,
|
||||||
MessageStyle,
|
MessageStyle,
|
||||||
MessageStream
|
MessageStream,
|
||||||
|
Disable,
|
||||||
|
Shutoff,
|
||||||
|
Capacity
|
||||||
] as SlashCommand[]
|
] as SlashCommand[]
|
||||||
54
src/commands/shutoff.ts
Normal file
54
src/commands/shutoff.ts
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
|
||||||
|
import { SlashCommand } from '../utils/commands.js'
|
||||||
|
import Keys from '../keys.js'
|
||||||
|
|
||||||
|
export const Shutoff: SlashCommand = {
|
||||||
|
name: 'shutoff',
|
||||||
|
description: 'shutdown the bot. You will need to manually bring it online again.',
|
||||||
|
|
||||||
|
// set available user options to pass to the command
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'are-you-sure',
|
||||||
|
description: 'true = yes, false = I\'m scared',
|
||||||
|
type: ApplicationCommandOptionType.Boolean,
|
||||||
|
required: true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
// Query for message information and set the style
|
||||||
|
run: async (client: Client, interaction: CommandInteraction) => {
|
||||||
|
// fetch channel and message
|
||||||
|
const channel = await client.channels.fetch(interaction.channelId)
|
||||||
|
if (!channel || channel.type !== ChannelType.GuildText) return
|
||||||
|
|
||||||
|
// log this, this will probably be improtant for logging who did this
|
||||||
|
console.log(`User -> ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)
|
||||||
|
|
||||||
|
// create list of superUsers based on string parse
|
||||||
|
const superUsers: string[] = JSON.parse(Keys.superUser.replace(/'/g, '"'))
|
||||||
|
|
||||||
|
// check if admin or false on shutdown
|
||||||
|
if (interaction.user.tag !in superUsers) {
|
||||||
|
interaction.reply({
|
||||||
|
content: `Shutdown failed:\n\n${interaction.user.tag}, You do not have permission to shutoff **${client.user?.tag}**.`,
|
||||||
|
ephemeral: true
|
||||||
|
})
|
||||||
|
return // stop from shutting down
|
||||||
|
} else if (!interaction.options.get('are-you-sure')?.value) {
|
||||||
|
interaction.reply({
|
||||||
|
content: `Shutdown failed:\n\n${interaction.user.tag}, You didn't want to shutoff **${client.user?.tag}**.`,
|
||||||
|
ephemeral: true
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
interaction.reply({
|
||||||
|
content: `${client.user?.tag} is ${interaction.options.get('are-you-sure')?.value ? "shutting down now." : "not shutting down." }`,
|
||||||
|
ephemeral: true
|
||||||
|
})
|
||||||
|
|
||||||
|
// clean up client instance and stop
|
||||||
|
client.destroy()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +1,14 @@
|
|||||||
import { ChatResponse } from 'ollama'
|
import { ChatResponse } from 'ollama'
|
||||||
import { embedMessage, event, Events, normalMessage } from '../utils/index.js'
|
import { embedMessage, event, Events, normalMessage } from '../utils/index.js'
|
||||||
import { Configuration, getConfig } from '../utils/jsonHandler.js'
|
import { Configuration, getConfig, openFile } from '../utils/jsonHandler.js'
|
||||||
|
import { clean } from '../utils/mentionClean.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Max Message length for free users is 2000 characters (bot or not).
|
* Max Message length for free users is 2000 characters (bot or not).
|
||||||
* @param message the message received from the channel
|
* @param message the message received from the channel
|
||||||
*/
|
*/
|
||||||
export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama }, message) => {
|
export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama }, message) => {
|
||||||
log(`Message \"${message.content}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
|
log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
|
||||||
|
|
||||||
// Hard-coded channel to test output there only, in our case "ollama-endpoint"
|
// Hard-coded channel to test output there only, in our case "ollama-endpoint"
|
||||||
if (message.channelId != tokens.channel) return
|
if (message.channelId != tokens.channel) return
|
||||||
@@ -18,26 +19,47 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
|
|||||||
// Only respond if message mentions the bot
|
// Only respond if message mentions the bot
|
||||||
if (!message.mentions.has(tokens.clientUid)) return
|
if (!message.mentions.has(tokens.clientUid)) return
|
||||||
|
|
||||||
// push user response
|
|
||||||
msgHist.push({
|
|
||||||
role: 'user',
|
|
||||||
content: message.content
|
|
||||||
})
|
|
||||||
|
|
||||||
// Try to query and send embed
|
// Try to query and send embed
|
||||||
try {
|
try {
|
||||||
const config: Configuration = await new Promise((resolve, reject) => {
|
const config: Configuration = await new Promise((resolve, reject) => {
|
||||||
getConfig('config.json', (config) => {
|
getConfig('config.json', (config) => {
|
||||||
|
// check if config.json exists
|
||||||
if (config === undefined) {
|
if (config === undefined) {
|
||||||
reject(new Error('No Configuration is set up.'))
|
reject(new Error('No Configuration is set up.\n\nCreating \`config.json\` with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// check if chat is disabled
|
||||||
|
if (!config.options['toggle-chat']) {
|
||||||
|
reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if there is a set capacity in config
|
||||||
|
if (typeof config.options['modify-capacity'] !== 'number')
|
||||||
|
log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
|
||||||
|
else if (config.options['modify-capacity'] === msgHist.capacity)
|
||||||
|
log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
|
||||||
|
else {
|
||||||
|
log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
|
||||||
|
msgHist.capacity = config.options['modify-capacity']
|
||||||
|
}
|
||||||
|
|
||||||
resolve(config)
|
resolve(config)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
let response: ChatResponse
|
let response: ChatResponse
|
||||||
|
|
||||||
|
// check if we can push, if not, remove oldest
|
||||||
|
while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
|
||||||
|
|
||||||
|
// push user response before ollama query
|
||||||
|
msgHist.enqueue({
|
||||||
|
role: 'user',
|
||||||
|
content: clean(message.content)
|
||||||
|
})
|
||||||
|
|
||||||
// undefined or false, use normal, otherwise use embed
|
// undefined or false, use normal, otherwise use embed
|
||||||
if (config.options['message-style'])
|
if (config.options['message-style'])
|
||||||
response = await embedMessage(message, ollama, tokens, msgHist)
|
response = await embedMessage(message, ollama, tokens, msgHist)
|
||||||
@@ -47,13 +69,17 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
|
|||||||
// If something bad happened, remove user query and stop
|
// If something bad happened, remove user query and stop
|
||||||
if (response == undefined) { msgHist.pop(); return }
|
if (response == undefined) { msgHist.pop(); return }
|
||||||
|
|
||||||
// successful query, save it as history
|
// if queue is full, remove the oldest message
|
||||||
msgHist.push({
|
while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
|
||||||
|
|
||||||
|
// successful query, save it in context history
|
||||||
|
msgHist.enqueue({
|
||||||
role: 'assistant',
|
role: 'assistant',
|
||||||
content: response.message.content
|
content: response.message.content
|
||||||
})
|
})
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
msgHist.pop() // remove message because of failure
|
msgHist.pop() // remove message because of failure
|
||||||
message.reply(`**Response generation failed.**\n\nReason: ${error.message}\n\nPlease use any config slash command.`)
|
openFile('config.json', 'message-style', false)
|
||||||
|
message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -7,7 +7,8 @@ export const Keys = {
|
|||||||
clientUid: getEnvVar('CLIENT_UID'),
|
clientUid: getEnvVar('CLIENT_UID'),
|
||||||
guildId: getEnvVar('GUILD_ID'),
|
guildId: getEnvVar('GUILD_ID'),
|
||||||
ipAddress: getEnvVar('OLLAMA_IP'),
|
ipAddress: getEnvVar('OLLAMA_IP'),
|
||||||
portAddress: getEnvVar('OLLAMA_PORT')
|
portAddress: getEnvVar('OLLAMA_PORT'),
|
||||||
|
superUser: getEnvVar('ADMINS')
|
||||||
} as const // readonly keys
|
} as const // readonly keys
|
||||||
|
|
||||||
export default Keys
|
export default Keys
|
||||||
62
src/queues/queue.ts
Normal file
62
src/queues/queue.ts
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
// Queue interfaces for any queue class to follow
|
||||||
|
interface IQueue<T> {
|
||||||
|
enqueue(item: T): void
|
||||||
|
dequeue(): T | undefined
|
||||||
|
size(): number
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Queue for UserMessages
|
||||||
|
* When the limit for messages is met, we want to clear
|
||||||
|
* out the oldest message in the queue
|
||||||
|
*/
|
||||||
|
export class Queue<T> implements IQueue<T> {
|
||||||
|
private storage: T[] = []
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set up Queue
|
||||||
|
* @param capacity max length of queue
|
||||||
|
*/
|
||||||
|
constructor(public capacity: number = 5) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Put item in front of queue
|
||||||
|
* @param item object of type T to add into queue
|
||||||
|
*/
|
||||||
|
enqueue(item: T): void {
|
||||||
|
if (this.size() === this.capacity)
|
||||||
|
throw Error('Queue has reached max capacity, you cannot add more items.')
|
||||||
|
this.storage.push(item)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove item at end of queue
|
||||||
|
* @returns object of type T in queue
|
||||||
|
*/
|
||||||
|
dequeue(): T | undefined {
|
||||||
|
return this.storage.shift()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Size of the queue
|
||||||
|
* @returns length of queue as a int/number
|
||||||
|
*/
|
||||||
|
size(): number {
|
||||||
|
return this.storage.length
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the front of the queue, typically for errors
|
||||||
|
*/
|
||||||
|
pop(): void {
|
||||||
|
this.storage.pop()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Geet the queue as an array
|
||||||
|
* @returns a array of T items
|
||||||
|
*/
|
||||||
|
getItems(): T[] {
|
||||||
|
return this.storage
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
import type { ClientEvents, Awaitable, Client } from 'discord.js'
|
import type { ClientEvents, Awaitable, Client, User } from 'discord.js'
|
||||||
import { Ollama } from 'ollama'
|
import { Ollama } from 'ollama'
|
||||||
|
import { Queue } from '../queues/queue.js'
|
||||||
|
|
||||||
// Export events through here to reduce amount of imports
|
// Export events through here to reduce amount of imports
|
||||||
export { Events } from 'discord.js'
|
export { Events } from 'discord.js'
|
||||||
@@ -33,7 +34,7 @@ export type UserMessage = {
|
|||||||
export interface EventProps {
|
export interface EventProps {
|
||||||
client: Client
|
client: Client
|
||||||
log: LogMethod
|
log: LogMethod
|
||||||
msgHist: { role: string, content: string }[]
|
msgHist: Queue<UserMessage>
|
||||||
tokens: Tokens,
|
tokens: Tokens,
|
||||||
ollama: Ollama
|
ollama: Ollama
|
||||||
}
|
}
|
||||||
@@ -63,7 +64,7 @@ export function event<T extends EventKeys>(key: T, callback: EventCallback<T>):
|
|||||||
export function registerEvents(
|
export function registerEvents(
|
||||||
client: Client,
|
client: Client,
|
||||||
events: Event[],
|
events: Event[],
|
||||||
msgHist: UserMessage[],
|
msgHist: Queue<UserMessage>,
|
||||||
tokens: Tokens,
|
tokens: Tokens,
|
||||||
ollama: Ollama
|
ollama: Ollama
|
||||||
): void {
|
): void {
|
||||||
|
|||||||
@@ -4,7 +4,9 @@ export interface Configuration {
|
|||||||
readonly name: string
|
readonly name: string
|
||||||
options: {
|
options: {
|
||||||
'message-stream'?: boolean,
|
'message-stream'?: boolean,
|
||||||
'message-style'?: boolean
|
'message-style'?: boolean,
|
||||||
|
'toggle-chat'?: boolean,
|
||||||
|
'modify-capacity'?: number
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
16
src/utils/mentionClean.ts
Normal file
16
src/utils/mentionClean.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import Keys from "../keys.js"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clean up the bot user_id so it only has the prompt
|
||||||
|
*
|
||||||
|
* Sample: <@CLIENT_ID> Hello
|
||||||
|
* - we want to remove <@CLIENT_ID>
|
||||||
|
* - replace function works well for this
|
||||||
|
*
|
||||||
|
* @param message
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export function clean(message: string): string {
|
||||||
|
const cleanedMessage: string = message.replace(`<@${Keys.clientUid}>`, '').trim()
|
||||||
|
return cleanedMessage
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import { EmbedBuilder, Message } from 'discord.js'
|
import { EmbedBuilder, Message } from 'discord.js'
|
||||||
import { ChatResponse, Ollama } from 'ollama'
|
import { ChatResponse, Ollama } from 'ollama'
|
||||||
import { UserMessage } from './events.js'
|
import { UserMessage } from './events.js'
|
||||||
|
import { Queue } from '../queues/queue.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to send replies as normal text on discord like any other user
|
* Method to send replies as normal text on discord like any other user
|
||||||
@@ -15,7 +16,7 @@ export async function embedMessage(
|
|||||||
channel: string,
|
channel: string,
|
||||||
model: string
|
model: string
|
||||||
},
|
},
|
||||||
msgHist: UserMessage[]
|
msgHist: Queue<UserMessage>
|
||||||
) {
|
) {
|
||||||
// bot response
|
// bot response
|
||||||
let response: ChatResponse
|
let response: ChatResponse
|
||||||
@@ -33,7 +34,7 @@ export async function embedMessage(
|
|||||||
// Attempt to query model for message
|
// Attempt to query model for message
|
||||||
response = await ollama.chat({
|
response = await ollama.chat({
|
||||||
model: tokens.model,
|
model: tokens.model,
|
||||||
messages: msgHist,
|
messages: msgHist.getItems(),
|
||||||
options: {
|
options: {
|
||||||
num_thread: 8, // remove if optimization needed further
|
num_thread: 8, // remove if optimization needed further
|
||||||
mirostat: 1,
|
mirostat: 1,
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import { Message } from 'discord.js'
|
import { Message } from 'discord.js'
|
||||||
import { ChatResponse, Ollama } from 'ollama'
|
import { ChatResponse, Ollama } from 'ollama'
|
||||||
import { UserMessage } from './events.js'
|
import { UserMessage } from './events.js'
|
||||||
|
import { Queue } from '../queues/queue.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to send replies as normal text on discord like any other user
|
* Method to send replies as normal text on discord like any other user
|
||||||
@@ -15,17 +16,17 @@ export async function normalMessage(
|
|||||||
channel: string,
|
channel: string,
|
||||||
model: string
|
model: string
|
||||||
},
|
},
|
||||||
msgHist: UserMessage[]
|
msgHist: Queue<UserMessage>
|
||||||
) {
|
) {
|
||||||
// bot's respnse
|
// bot's respnse
|
||||||
let response: ChatResponse
|
let response: ChatResponse
|
||||||
|
|
||||||
await message.reply('Generating Response . . .').then(async sentMessage => {
|
await message.channel.send('Generating Response . . .').then(async sentMessage => {
|
||||||
try {
|
try {
|
||||||
// Attempt to query model for message
|
// Attempt to query model for message
|
||||||
response = await ollama.chat({
|
response = await ollama.chat({
|
||||||
model: tokens.model,
|
model: tokens.model,
|
||||||
messages: msgHist,
|
messages: msgHist.getItems(),
|
||||||
options: {
|
options: {
|
||||||
num_thread: 8, // remove if optimization needed further
|
num_thread: 8, // remove if optimization needed further
|
||||||
mirostat: 1,
|
mirostat: 1,
|
||||||
@@ -34,9 +35,13 @@ export async function normalMessage(
|
|||||||
},
|
},
|
||||||
stream: false
|
stream: false
|
||||||
})
|
})
|
||||||
|
|
||||||
// edit the 'generic' response to new message
|
// check if message length > discord max for normal messages
|
||||||
sentMessage.edit(response.message.content)
|
if (response.message.content.length > 2000) {
|
||||||
|
sentMessage.edit(response.message.content.slice(0, 2000))
|
||||||
|
message.channel.send(response.message.content.slice(2000))
|
||||||
|
} else // edit the 'generic' response to new message
|
||||||
|
sentMessage.edit(response.message.content)
|
||||||
} catch(error: any) {
|
} catch(error: any) {
|
||||||
console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
|
console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
|
||||||
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
|
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
|
||||||
|
|||||||
Reference in New Issue
Block a user