Giter Club home page Giter Club logo

faux-legacy's Introduction

Faux

Faux is a chatbot bridge between urbit and discord. Whenever a member posts in your discord group, a bot will echo their message in your urbit group, and vice versa.

Setup

Installation

git clone https://github.com/midsum-salrux/faux

cd faux

pip3 install .

Configuration

Environment Variables

If you get TypeError: unsupported operand type(s) for +: 'NoneType' and 'str', it means that you haven't set these correctly. You can read about how to set environment variables here

URBIT_URL

Wherever your urbit bot is hosted. This will often be http://localhost:8080

URBIT_SHIP

Your urbit bot ship name, with no ~. For example, botdys-dozzod-tomdys

URBIT_CODE

The +code of your urbit bot

DISCORD_TOKEN

You need to create a discord bot to self-host Faux. Here are some instructions

This environment variable is the API token of your discord bot. You can find it here:

When you create your OAuth2 URL, be sure to check these boxes

groups.json

This file specifies where posts will be echoed between. Here's a sample:

[{"urbit_ship": "zod",
  "discord_group_id": 214365879012435876,
  "channels": [
      { "discord_channel_id": 123456789012345678,
        "urbit_channel": "general-1234" }]}]

urbit_ship

The name of the ship hosting your chat (ordinarily the same as the ship hosting your group, but if they're separate, you want the chat ship).

No ~

discord_group_id

The internal id of your discord group. You can find it from the URL

channels

A list of channels you want to sync

urbit_channel

The name and number of your urbit channel. You can find it from the URL

discord_channel_id

The internal id of your discord channel. You can find it from the URL

Running

Invite your urbit bot to your urbit group, and your discord bot to your discord group, then run:

python3 faux/faux.py

Support

Join ~tomdys/the-faux-shore on urbit

Caveats

The bot will not trigger on its own messages, and the bot will not work in chats that it hosts itself. It's best to use a separate moon for your bot.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.