Sleep District

A realtime, multi-player GPS location based MMORPG for Telegram.


Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact
• Acknowledgements

About The Project

There are a few Telegram MMORPG's and some of them are really nice, however, I didn't find one that can use your real-time location for PvP actions. I decided to build my own text-based MMORPG which obliges you to move in order to find loot in your city and stalk your enemies. You can engage into clan wars, attack and kill players to get their loot. Trade weapons, complete missions and create a strong community around you to survive.

Built With

• Node.js
• MongoDB
• Telegram bot API

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• yarn

brew install yarn

Installation

1. Get a bot API Key at https://core.telegram.org/bots#botfather
2. Clone the repo

git clone https://github.com/maxevilmind/sleepdistrict.git

3. Install yarn packages

yarn

4. Rename .env.example to .env and set your token from the above step

BOT_TOKEN=110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Max Larionov - @maxevilmind - maxevilmind@gmail.com

Project Link: https://github.com/maxevilmind/sleepdistrict