RandyPen / web3_mud_ex

Web3MudEx is a MUD Framework based on Web3 & AIGC, written in Elixir, forked from Kalevala.

Web3MUDEx

NOTE This branch is the complete rewrite of Web3MUDEx using Kalevala under the hood. Everything from the previous codebase is tossed out to start over again. If you're interested in something that's working now, please check out the main branch.

A web3 MUD Framework based on Sui Netowork, gen MUD Space by Github Organiazation automatically, forked from ex_venture.

Requirements

• PostgreSQL 12+
• Elixir 1.10+
• Erlang 22+
• node.js 12+

Setup

mix deps.get
npm install -g yarn
(cd assets && yarn install)
mix ecto.reset
mix phx.server

Kalevala

Kalevala is a new underlying framework that Web3MUDEx is using under the hood. Kalevala sets up a common framework for dealing with commands, characters, views, and is all around a lot better to deal with than the previous version of Web3MUDEx.

Running Tests

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

Docker locally

Docker is set up as a replication of production. This generates an erlang release and is not intended for development purposes.

docker-compose pull
docker-compose build
docker-compose up -d postgres
docker-compose run --rm app eval "Web3MUDEx.ReleaseTasks.Migrate.run()"
docker-compose up app

You now can view http://localhost:4000 and access the application.