Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.39 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.39 KB
Raw


Logo

PlebAI Chatbox

Integrate a PlebAI agent chatbox into your own web project.

Report Bug · Request Feature

About The Project

Product Name Screen Shot

With PlebAI Chatbox it is incredibly simple to include a chat with one of the many PlebAI agents into any web page.

(back to top)

Getting Started

Integrating the chatbox in your website is really easy. Simply add the lines below into the <head> section of any page that you want the chatbox to show up on.

<script>
  var plebAiConf = {
    agentKey: "<agent key in hex>",
    chatTitle: "<your title>",
    primaryColor: "<colorcode in hex",
    secondaryColor: "<colorcode in hex",
  };
</script>
<script src="https://i.current.fyi/static/plebai.js"></script>
<link
  rel="stylesheet"
  href="https://i.current.fyi/static/styles.css"
/>

Adjusting the config object

The first <script> tag in the snippet above is used to pass a configuration object to chatbox. It holds the following four properties:

  1. agentKey: The public key of the agent that chatbox will connect to (can be found on plebai.com/agents).
  2. chatTitle: The title that will be displayed at the top of chatbox.
  3. primaryColor: The primary color of the chatbox component (topbar and submit button background).
  4. secondaryColor: The secondary color of the chatbox component (response background)

(back to top)

License

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

(back to top)

Contact

Lightning Digital Entertainment - @lde_lightning

(back to top)