README

Build a distributed multi-user dungeon text adventure game

Repository overview

Explore the captivating world of 'Beware of Dragons,' a high-fantasy Multi-User Dungeon (MUD) text adventure game powered by Typescript, NodeJS & ReactJS. From crafting rich lore to mastering distributed systems, this open-source book guides aspiring game developers through the art of game design, storytelling, and technical implementation. Discover the secrets of character classes, allegiances, and dynamic combat while fostering player engagement through leaderboards and fair play. Immerse yourself in a realm of creativity where imagination knows no bounds. Join our community of contributors and embark on an epic journey through Beware of Dragons.

Table of Contents

About the Book

Beware of Dragons is a comprehensive guide that takes you through the journey of creating an immersive multiplayer text adventure game. Whether you're a seasoned developer or just starting, this book provides valuable insights into game development, distributed systems, and best practices. In time, I hope it becomes a community-driven effort to provide a new learning resource to pick up Phoenix/LiveView and good practices in distributed systems.

Contents

The book is organized into chapters, each focusing on different aspects of game development, from lore creation to designing distributed systems. The book's contents are in the Table of Contents. As the book is currently very early in its development phase, don't be alarmed if the table of contents were to change (new additions, removing chapters/sections, modifying the structure, and such).

Contributing

We welcome contributions from the community to make this resource even more valuable. If you'd like to contribute to the book by adding new content, fixing errors, or suggesting improvements, please follow these steps:

  1. Fork this repository to your GitHub account.

  2. Create a new branch for your contribution (git checkout -b your-feature).

  3. Make your changes and commit them (git commit -m "Added new chapter on XYZ").

  4. Push your changes to your forked repository (git push origin your-feature).

  5. Open a Pull Request (PR) from your forked repository to this main repository.

  6. Our team will review your PR, provide feedback, and merge it if everything looks good.

For more details on contributing, please see our Contributing Guidelines.

Feedback and Issues

We value your feedback and encourage you to report any issues or suggest improvements. If you encounter a problem with the book content code examples or have a general suggestion, please open an issue.

License

This book is released under the MIT License, a permissive open-source license that encourages collaboration and innovation. Under this license, you are free to:

  • Use this book for personal or commercial purposes.

  • Modify and adapt the content to suit your needs.

  • Share and distribute the book in any format.

  • Incorporate portions of the book into your projects.

and acknowledgeThe only requirement is that you provide proper attribution to the original work, acknowledging the contributions of the authors and contributors.

I believe in fostering a community of creativity and collaboration. Feel free to embark on adventures inspired by "Beware of Dragons" and share your knowledge with the world.

Happy reading, and may your journey through the "Beware of Dragons" world be filled with creativity, adventure, and boundless imagination!

Last updated