From fef6e49124f6c7c03caea90a10fda384c04fb597 Mon Sep 17 00:00:00 2001 From: Xuyuan <72079021+txuyuan@users.noreply.github.com> Date: Wed, 11 May 2022 07:46:15 +0800 Subject: [PATCH] Update readme --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 32c637e..78d571d 100644 --- a/README.md +++ b/README.md @@ -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 ") from https://create.stephan-brumme.com/hash-library/ (and I would like to thank them) -under the zlib License. +
+ +## 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++