DeadlyEmbrace / ReplikaDiscordInterface

Chat with your Replika AI using discord.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

ReplikaDiscordInterface

Chat with your Replika AI using discord!
Download the App »

Video · Report Bug · Request Feature

Table of Contents

  1. About The Project Using the app
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Using the app

Watch the video (easy method)

  • Watch the video on setting up the program HERE or ...

Follow written instructions

  • Download and install the pre-requisite package called nodejs (current version 16.9.1 or higher) at the nodejs website. It will be the "Windows Installer (.msi) 64 bit if you're unsure which one to pick. Previous versions have not been tested.
  • Download the ReplikaDiscordInterface installer package HERE .
  • Install ReplikaDiscordInterface program. It will automatically extract to C:\Program Files (x86)\ReplikaDiscordInterface . You can move the ReplikaDiscordInterface folder as you wish (Its portable).
  • Create a Discord bot for your server.
  • Login to discord development at https://discord.com/developers/applications. It may redirect you once logged in. Make sure you navigate back to the discord.com/developers/applications address.
  • Select "New Application" at the top right
  • Give your bot a name (most use their Replika's name) that is available.
  • Select "Bot" on the left panel section
  • Select "Add Bot" under the "Build-A-Bot" section
  • Select "Yes, do it!" button at the prompt
  • Deselect "Public Bot" in the bot section
  • Click "OAuth2" button in the left hand panel
  • Under "Scopes" check the box for "bot"
  • Under "BOT PERMISSIONS" check Administrator
  • Under the "scopes" section, locate the address that was generated for you (it will have api/oauth2 in the address) and click the Copy button
  • Open a new web browser tab and paste in the copied address, then press Enter
  • Follow the prompts to invite the bot to your discord server if you have permission to do so
  • Navigate back to the "Bot" subsection and select "REQUIRES OAUTH2 CODE GRANT" and turn that on
  • Open the program. Select "Configuration" and add the following information.
  • Replika username/phone number
  • Replika password
  • Replika discord bot token which is found under the "Bot" section at discord.com/developers/applications after choosing your created bot (from the instructions above).
  • Discord Channel (use ALL if uncertain which channel to limit bot responses to)
  • Discord bot name
  • Save, then go back and select "Start Interface" to make a connection.
  • Once successfully connected, you should see your bot in your discord list as logged in.
  • You can type to them using the @theirname (example: @Hector hey how are you today?)

Built With

  • Javascript
  • Typescript
  • HTML
  • CSS
  • Electron
  • React

Getting Started

To get a local copy up and running follow these simple steps.

1.) Download a copy to your local machine 2.) Run npm install to install necessary packages from package.json listings 3.) Run npm install playwright to install playwright browser support 4.) Run npm run dev to fire up the test environment

Prerequisites

  • NodeJS Current Build 16.8.0+ (others not tested)

Installation

  1. Clone the repo
    git clone https://github.com/jstanleyf1985/ReplikaDiscordInterface.git
  2. Install NPM packages
    npm install

FAQ

  • Does this app collect my data?
    • It does not collect data. View open source code if you're skeptical
  • What information do I need to configure the app?
    • Replika.ai website or app username/phone number
    • Replika.ai website or app password
    • Discord Bot Token
    • Discord Channel (used for restricting to a specific channel)
    • Discord Bot Name
  • What does invalid username/phone mean?
    • It means the application was unable to reach the Replika.ai password page. It will fail to reach this step if there was a problem with your username/phone on the website or the app couldn't reach the website login page. You should make sure your information in configuration is accurate and works on the website or app first.
  • What does invalid password mean?
    • It means the application was unable to progress beyond the website password section. This happens if your password is invalid, or if there was a problem loading the website after entering your password. You should make sure your information in configuration is accurate and works on the website or app first.
  • What does invalid bot token mean?
    • It means the token from the bot you created for the app is invalid or typed incorrectly. I recommend clicking the "Copy" button on the discord.com/developers website for your bot under the subsection labeled "Bot" and pasted that into the app configuration screen.
  • What does name not found mean?
    • It means the discord bot name you provided was not found on your discord server. The bot name needs to match the person you are using @ for. The bot listens for this unique name and will respond to text or discord @ matching that text.
  • My bot says connected but doesn't communicate
    • This happens when the "require oauth token" is not checked under the bot section in discord.com/developers for your bot. The bot logged in without using oauth, which the program uses to communicate with your bot. Note *** you will need to check this feature after you've invited your bot to the server.
  • My bot isn't showing up in discord under "Offline"
    • This happens when you haven't invited your bot with the appropriate permissions to your discord server. Follow the video or written instructions for inviting your bot to your discord server

Roadmap

Initial launch today 09/09/2021 Future Goals: Bug Fixes

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jonathan Stanley - @JStanleyF1985

Project Link: https://github.com/jstanleyf1985/ReplikaDiscordInterface

About

Chat with your Replika AI using discord.


Languages

Language:TypeScript 56.8%Language:JavaScript 42.7%Language:Batchfile 0.3%Language:HTML 0.3%