From 31b3c7eb049ce50edf045571608fc9f9a43e86e1 Mon Sep 17 00:00:00 2001 From: Shengyu JIANG <shengyu.jiang@student.unimelb.edu.au> Date: Wed, 7 Oct 2020 22:50:41 +1100 Subject: [PATCH] Update README.md --- README.md | 182 +++++++++++++++++------------------------------------- 1 file changed, 58 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index dcb1c34..bf4c651 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # ShadowLife -# Introduction +## Introduction + Welcome to Shengyu's Shadow Life Extension Pack. This is a game modified from Shadow Life. @@ -14,169 +15,102 @@ What we have? The above features will be waiting for you. - - - -You can also: - - Import and save files from GitHub, Dropbox, Google Drive and One Drive - - Drag and drop markdown and HTML files into Dillinger - - Export documents as Markdown, HTML and PDF +## UI +New look for start page -Markdown is a lightweight markup language based on the formatting conventions that people naturally use in email. As [John Gruber] writes on the [Markdown site][df1] +<img src = "README_IMAGE/StartPage.PNG" width = "500"> -> The overriding design goal for Markdown's -> formatting syntax is to make it as readable -> as possible. The idea is that a -> Markdown-formatted document should be -> publishable as-is, as plain text, without -> looking like it's been marked up with tags -> or formatting instructions. +New look for level page -This text you see here is *actually* written in Markdown! To get a feel for Markdown's syntax, type some text into the left window and watch the results in the right. +<img src = "README_IMAGE/LevelPage.PNG" width = "500"> -### Tech +## Policy -Dillinger uses a number of open source projects to work properly: +The new game rules require you to lead the knight to the chest, during which there will be monsters to block, use signs to plan your route. -* [AngularJS] - HTML enhanced for web apps! -* [Ace Editor] - awesome web-based text editor -* [markdown-it] - Markdown parser done right. Fast and easy to extend. -* [Twitter Bootstrap] - great UI boilerplate for modern web apps -* [node.js] - evented I/O for the backend -* [Express] - fast node.js network app framework [@tjholowaychuk] -* [Gulp] - the streaming build system -* [Breakdance](https://breakdance.github.io/breakdance/) - HTML to Markdown converter -* [jQuery] - duh +<img src = "README_IMAGE/Playing.PNG" width = "500"> -And of course Dillinger itself is open source with a [public repository][dill] - on GitHub. +Don't worry, sometimes help guide will give you some hints. -### Installation +<img src = "README_IMAGE/guide.PNG" width = "500"> -Dillinger requires [Node.js](https://nodejs.org/) v4+ to run. +## Monster Book +### Skeleton -Install the dependencies and devDependencies and start the server. +<img src = "README_IMAGE/Skeleton.PNG" width = "100"> -```sh -$ cd dillinger -$ npm install -d -$ node app -``` +The lowest level creature, but still deadly to you. + - The red-eyed Skeleton moves left and right. + - The blue-eyed Skeleton moves up and down. -For production environments... +### Spider -```sh -$ npm install --production -$ NODE_ENV=production node app -``` +<img src = "README_IMAGE/Spider.PNG" width = "100"> -### Plugins +The most common creature in the dungeon will move diagonally and hit you by surprise. -Dillinger is currently extended with the following plugins. Instructions on how to use them in your own application are linked below. +### Magic tower -| Plugin | README | -| ------ | ------ | -| Dropbox | [plugins/dropbox/README.md][PlDb] | -| GitHub | [plugins/github/README.md][PlGh] | -| Google Drive | [plugins/googledrive/README.md][PlGd] | -| OneDrive | [plugins/onedrive/README.md][PlOd] | -| Medium | [plugins/medium/README.md][PlMe] | -| Google Analytics | [plugins/googleanalytics/README.md][PlGa] | +<img src = "README_IMAGE/Magic%20Tower.PNG" height = "100"> +Ancient and lost magic items. A barrier will be constructed between the two magic towers to destroy all creatures that approach. -### Development +### Portal -Want to contribute? Great! +<img src = "README_IMAGE/Portal.PNG" width = "100"> -Dillinger uses Gulp + Webpack for fast developing. -Make a change in your file and instantaneously see your updates! +No one has cracked the principle of this wonderful magic item so far, the only thing we know is that it will teleport humans. +I +### trap -Open your favorite Terminal and run these commands. +<img src = "README_IMAGE/Trap.PNG" width = "100"> -First Tab: -```sh -$ node app -``` +Spiked traps are very dangerous. It will destroy the enemy above. -Second Tab: -```sh -$ gulp watch -``` +### Skull -(optional) Third: -```sh -$ karma test -``` -#### Building for source -For production release: -```sh -$ gulp build --prod -``` -Generating pre-built zip archives for distribution: -```sh -$ gulp build dist --prod -``` -### Docker -Dillinger is very easy to install and deploy in a Docker container. +<img src = "README_IMAGE/Skull.PNG" width = "100"> -By default, the Docker will expose port 8080, so change this within the Dockerfile if necessary. When ready, simply use the Dockerfile to build the image. +A variant of Skeleton possesses magical power, and spit out a fireball during even-numbered steps. -```sh -cd dillinger -docker build -t joemccann/dillinger:${package.json.version} . -``` -This will create the dillinger image and pull in the necessary dependencies. Be sure to swap out `${package.json.version}` with the actual version of Dillinger. +### Witch -Once done, run the Docker image and map the port to whatever you wish on your host. In this example, we simply map port 8000 of the host to port 8080 of the Docker (or whatever port was exposed in the Dockerfile): +<img src = "README_IMAGE/Witch.PNG" width = "100"> -```sh -docker run -d -p 8000:8080 --restart="always" <youruser>/dillinger:${package.json.version} -``` +Long-lived and aggressive races will shoot two magic balls at odd steps. -Verify the deployment by navigating to your server address in your preferred browser. +## Level +We provide some challenges for you to overcome -```sh -127.0.0.1:8000 -``` +<img src = "README_IMAGE/levelExample1.PNG" width = "300"> +<img src = "README_IMAGE/LevelExample2.PNG" width = "300"> -#### Kubernetes + Google Cloud +## Map Editor +Feel tired about the challenges? +We provide make the map function. -See [KUBERNETES.md](https://github.com/joemccann/dillinger/blob/master/KUBERNETES.md) +<img src = "README_IMAGE/makeLevel1.PNG" width = "300"> +By clicking the make button on the start page, you can enter the map editor. +You can use any actor to create your own level. -### Todos +To remove the actor, use the trash can button and click the unwanted actor. +don't forget to close it. - - Write MORE Tests - - Add Night Mode +<img src = "README_IMAGE/makelevel2.PNG" width = "300"> -License ----- +See more actor by clicking the white triangle. -MIT +<img src = "README_IMAGE/makeLevel3.PNG" width = "300"> +click run to test your level. -**Free Software, Hell Yeah!** +<img src = "README_IMAGE/StartButton.PNG" width = "300"> -[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax) +Only the passable level will be generated. +<img src = "README_IMAGE/Pass.PNG" width = "300"> - [dill]: <https://github.com/joemccann/dillinger> - [git-repo-url]: <https://github.com/joemccann/dillinger.git> - [john gruber]: <http://daringfireball.net> - [df1]: <http://daringfireball.net/projects/markdown/> - [markdown-it]: <https://github.com/markdown-it/markdown-it> - [Ace Editor]: <http://ace.ajax.org> - [node.js]: <http://nodejs.org> - [Twitter Bootstrap]: <http://twitter.github.com/bootstrap/> - [jQuery]: <http://jquery.com> - [@tjholowaychuk]: <http://twitter.com/tjholowaychuk> - [express]: <http://expressjs.com> - [AngularJS]: <http://angularjs.org> - [Gulp]: <http://gulpjs.com> +the signs used in the level will become the sign used in the game, so try to put more signs to confuse the player. (Just like me) - [PlDb]: <https://github.com/joemccann/dillinger/tree/master/plugins/dropbox/README.md> - [PlGh]: <https://github.com/joemccann/dillinger/tree/master/plugins/github/README.md> - [PlGd]: <https://github.com/joemccann/dillinger/tree/master/plugins/googledrive/README.md> - [PlOd]: <https://github.com/joemccann/dillinger/tree/master/plugins/onedrive/README.md> - [PlMe]: <https://github.com/joemccann/dillinger/tree/master/plugins/medium/README.md> - [PlGa]: <https://github.com/RahulHP/dillinger/blob/master/plugins/googleanalytics/README.md> \ No newline at end of file +<img src = "README_IMAGE/confuse.PNG" width = "300"> -- GitLab