Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
txuyuan authored May 10, 2022
1 parent 7d07b66 commit fef6e49
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# Monster_Melancholy_v2.0.0
A big portion of the Source Code for Monster Melancholy v2.0.0
A few parts of the code (like decryption, encryption, server security, etc) has been obfuscated due to security reasons
Examples:
- The int encrypt and int decrypt functions;
- In File "MHGdataHandle.h", line 87, please key in your own mongodb uri connection string for the code to work.
# Monster Melancholy Game: A simple adventure-style game

[![Docs](https://img.shields.io/badge/docs-monster--melancholy.me-brightgreen?style=flat-square&color=%2373DC8C&label=docs)](https://monster-melancholy.me)
[![Latest Release](https://img.shields.io/github/v/release/HCI-Pro-ductions/Monster_Melancholy?color=lightgreen&include_prereleases&label=latest%20version&style=flat-square)](https://github.com/HCI-Pro-ductions/Monster_Melancholy/releases)

### [Downloads and Instructions](https://monster-melancholy.me/downloads)

Monster Melancholy Game (MMG) is a simplistic but still fun adventure game! It was created simply as side project and as a way for us (specially [@AKeevee](https://github.com/AKeevee)) to express our creativity. Do have a try, it's quite easy (instructions linked above :D).

Pleasebear with the weird indents hehe
This was created as a side project so please excuse the roughness around the edges :)

I am using sha256 header files (that I modified slightly by excluding "#include <endian.h>") from https://create.stephan-brumme.com/hash-library/ (and I would like to thank them)
under the zlib License.
<br/>

## For Developers:

A few parts of the code (like decryption, encryption, server security, etc) are obfuscated due to security reasons, such as:
- The int encrypt and int decrypt functions;
- In File "MHGdataHandle.h", line 87, the MongoDB connection URI is omitted

Text Art Generator used: https://patorjk.com/software/taag/#p=display&f=Big&t=TEST
Please also note that mongo-c-driver was used for the C++ code for mongodb connections (see [mongo-c-driver-download-link](http://mongoc.org/))
Thanks to:
- [Stephan-Brumme](https://create.stephan-brumme.com/hash-library) (zLib License) - Modified version of header files used for hashing
- [Mongo-C](http://mongoc.org) - MongoDB driver for c++

0 comments on commit fef6e49

Please sign in to comment.