Skip to content

Asphodel-OS/mud-classic

 
 

Repository files navigation

MUD

MUD logo

MUD Classic - Simplified Engine for Autonomous Worlds

MUD Classic, is simplified fork of MUDv1, focusing on the use case of complex onchain dapps with large (rather than realtime) latency overheads.

MUD is a framework for complex Ethereum applications. It standardizes the way data is stored on-chain. It adds some conventions for organizing data and logic and abstracts away low-level complexities so you can focus on the features of your app.

MUD Classic is MIT-licensed, open source and free to use if you can figure it out.. (it's missing parts)

Packages

MUD consists of several core libraries. They can be used independently, but are best used together.

Package Version
@mud-classic/cli
Command line interface for types, testing, deployment and more
npm version
@mud-classic/recs
TypeScript Reactive Entity Component System library
npm version
@mud-classic/solecs
Solidity Entity Component System library
npm version
@mud-classic/std-contracts
Solidity standard library
npm version
@mud-classic/utils
Arbitrary utilities you may find useful..
npm version

Local development setup

  1. Install go (required to build packages/services): https://go.dev/doc/install

  2. Install the foundry toolkit (required to build and test MUD solidity packages): https://getfoundry.sh/

  3. Clone the MUD monorepo

git clone https://github.com/Asphodel-OS/mud-classic
  1. Install MUD dependencies and setup local environment
cd mud-classic && pnpm i

Pull requests

MUD follows the conventional commit specification for commit messages and PR titles. Please keep the scope of your PR small (rather open multiple small PRs than one huge PR) and follow the conventional commit spec.

License

MUD is open-source software licensed as MIT.

About

MUD 1 fork, prioritized for fully onchain idle games

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 63.4%
  • Solidity 36.0%
  • Other 0.6%