Skip to content

Commit

Permalink
Added more readme doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rarebreed committed Feb 27, 2023
1 parent 2870290 commit d3669a8
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,19 @@ protean-service aims to be a Virtual Table Top Role Playing Game engine powered
table top application, it also aims to help with collaboration, a way to tell a visually and audially enhanced
story.

The first iteration of the service will also contain a playable story
The first iteration of the service will also contain a playable story and helpers for solo style play. It uses
the protean engine which is a role playing game engine designed for both table top and computer role playing games.
The name protean comes from the Greek God Proteus, and means being able to taje many forms.

The service will be composed of several pieces:

- backend: for multiplayer, allows players to connect and maintains shared state of the world
- frontend: a bevy game engine which the player will interact with to control the character and get info on the world
- protean-lib: the base game engine that the frontend will use. It contains the kernel to which plugins attach
- protean-plugins: adds new rules

## protean game engine

The heart of protean-service will be protean-lib that actually defines the base system. It is designed to be modular, so
that it is very minimal but can be extended easily. All the "rules" will actually be defined in plugins, which add or
implement base traits. It will also be dynamic, and allow hot plugging via webassembly modules.

0 comments on commit d3669a8

Please sign in to comment.