theaether

README

The Aether

The Aether is a roleplaying game and open source MUD framework developed for Discord.

Will you become a traveled adventurer or a rich king? Perhaps a ship merchantman or a shopkeeper? Whatever you choose to become, The Aether welcomes you on your journey!

Table of Contents

• About
• Features
• Commands
  • Role Management
  • Room Management
  • Cluster Management
  • Notify Command
  • Events Command
• Development
• Discord

About

The Aether is, at its core, a MUD that runs on top of Discord. However, what separates The Aether from other discord roleplaying games (such as Discord RPG, which is arguably a great game on its own) is that while playing it you are a true participant in the world.

While other discord bots control traveling in a 2-dimensional way (you can play without ever leaving a channel, and other participants can be in the same chanel as you), The Aether controls traveling in a 3-dimensional way through the world by managing the roles and permissions that define Discord. That is to say, when you travel "north" from a room, for example, roles are assigned and revoked from your account with varying permissions that emulate the feeling of actually moving to a different location.

Features

Completed

• Multiple discord linking (creating a web of discords for nearly unlimited world size)
• Room Creation and linking
• Traveling between rooms

Planned

• Character Creation
• Item creation with different item types
• Traveling Creatures
• NPC Management
• Currency System

Commands

Role Management Commands

Command	Description	Example Usage
perms addrole
perms removerole
perms createrole
perms deleterole
perms viewrole
perms syncserverroles
perms syncrolesdb
perms translaterole

Room Management Commands

Command	Description	Example Usage
room add
room remove
room roles
room view
room linkrole
room unlinkrole
room setupserver
room description
room guildinvite
room linkdirection
room transferrole
room transferroleclear
room travelrole
room travelroleclear
room travelscript
room travelscriptclear
room describedirection

Cluster Management Commands

Command	Description	Example Usage
guilds sync cluster	sync and repair all guilds in the cluster
guilds sync guild	sync and repair specific guild
guilds info	display information about a guild
guilds cluster	display cluster stats

Notify Command

Command	Description	Example Usage
enable
enable for
disable
disable for
add
remove
list
view
channel
messages
flush
linked

Events Command

Command	Description	Example Usage
add
remove
list
info
enable
disable
listenabled

Development

Development Branch Status

All development should be performed on your own fork and a PR submitted against the "develop" branch of the project. Your builds must pass travis checks before a PR will be accepted, except under special circumstances it is expected that the develop branch should be in a passing state.

At the moment development is happening at a quick pace, so many merges from develop will be made to master, however the long term goal is to keep merges at once per week so long as travis builds are passing.

Discord

Join us on Discord