Skip to content
The MUD Chat Network
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis
assets
config
deploy
lib
priv
rel
test
.credo.exs
.dockerignore
.formatter.exs
.gitignore
.projections.json
.tool-versions
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
Dockerfile.releaser
LICENSE
README.md
Vagrantfile
ansible.cfg
docker-compose.yml
mix.exs
mix.lock
release.sh
spec.yml
verify.sh

README.md

Grapevine

Grapevine

Grapevine is a MUD chat network.

WebSocket Protocol

View the websocket details on Grapevine.

Server

Requirements

This is only required to run Grapevine itself, the server. These are not required to connect as a game. See the above websocket docs for connecting as a client.

  • PostgreSQL 10
  • Elixir 1.8.0
  • Erlang 21.2.6
  • node.js 10.13.0

Setup

mix deps.get
mix compile
cd assets && npm install && node node_modules/brunch/bin/brunch build && cd ..
mix ecto.reset
mix phx.server

This will start a web server on port 4100. You can now load http://localhost:4100/ to view the application.

Running Tests

MIX_ENV=test mix ecto.create
MIX_ENV=test mix ecto.migrate
mix test

Docker

docker-compose build grapevine
docker-compose up -d postgres
docker-compose run --rm grapevine migrate
docker-compose up grapevine

Telnet Web Client

For deployment the telnet application needs to be on its own erlang node. You can connect with something similar to:

config :grapevine,
  topologies: [
    local: [
      strategy: Cluster.Strategy.Epmd,
      config: [
        hosts: [
          :grapevine@localhost,
          :telnet@localhost,
        ]
      ]
    ]
  ]

Setting up a new Play CNAME

  • Game sets the CNAME to grapevine.haus
  • Game must have a homepage url
  • Game must have the web client enabled
  • Update game's record for their CNAME
  • Update nginx config for new domain
  • Run certbot for the new domain
  • Refresh CNAMEs in ETS Grapevine.CNAMEs.reload()
You can’t perform that action at this time.