Inn at the Edge of Copyright

Version 2.0

Table of Contents

• Overview
• Getting Started
  • Game Commands
• Contributers
• Credits
• Questions
  • Contributing
• Issues & Updates
  • Issues
  • Version Updates
  • Future Development
• License

Overview

The Inn at the Edge of Copyright is a text-based program for anyone with a crave for an adventure. Our project is a MUD or Multi-User-Dungeon RPG loosely based on The Hitchhiker's Guide to the Galaxy series by Douglas Adams and inspired by text-based MUDs of the early days of the internet. The Inn At The Edge is where all who are lost can find a home.

Getting Started

For the time being, we are useing Auth0 for user login. After you login, you will be instructed to give yourself a character name. Using the commands below, you should get the hang of the Inn in no time!

Game Commands

get          --Pick up an item
look         --You look around you
drop         --You drop an item
inventory    --You check your inventory
move         --You move through an exit
speak        --You speak
remove       --You take off an item you are wearing
stats        --You call up your character stats
juggle       --You juggle something
emote        --You describe an action
sleep        --You go to sleep
wake         --You wake up
position     --You change position
help         --check command usage
examine      --Look closely at an item

Join us in the Inn here!

Contributers

• Nancy "Cosmo The Magnificent" Lambert-Brown
• Talia "Quill" Vazquez
• Plover "Chordori" Brown
• Nicholas "Shambles" Konzen
• Kira "Bismuth the KILer" Lowrey
• Mando "Mandolorian" Estrada

Past Contributers (NPCs)

• Jeneth "6one9" Diesta

Credits

Built and Running With:

• React and JavaScript
• Express and Node.js
• Bootstrap
• Socket.io
• MongoDB
• Heroku

NPM Packages:

* axios                - Promise based HTTP client
* cors                 - Express middleware to enabel CORS
* dotenv               - .env to process.env module
* express              - Web server for Node.js
* if-env               - Simplify npm scripts
* mongoose             - MongoDB object modeling tool
* @auth0/auth0-react   - Auth0 SDK for React SPA's

Questions

If you have any questions that this README doesn't cover, you can reach out to us at [email protected] or contact a contributor.

Contributing

If you are interested in contributing to our project, we have a Slack! You can join us here

Issues and Updates

Issues

If you have found an issue with the game, you can open a GitHub Issue here

Known Issues:

1. We're in the clear boys... for now -_-

We are working at fixing these bugs as soon as possible! Thank you for your patience.

Version Updates

Version 2.0

• Refactored the app from the ground up to use React.js, MongoDB, and Socket.io.
• Added Social Sign-in with Auth0

View Version 1 here

Future Development

The Inn at the Edge of Copyright team is here for the long haul. We have lots of cool features in store! You can check out our plans for the future on our project boards

View Version 2.1 project board here

View Version 3.0 project board here

License

GNU General Public License V3