diff --git a/.gitignore b/.gitignore index 7efdcaf..1731d04 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,48 @@ -mono_crash.* -.idea -.DS_Store -*/Export/* - -# Godot-specific ignores +# Godot-specific ignores ------------------------------------------------------- .import/ export.cfg export_presets.cfg + +# Imported translations (automatically generated from CSV files) +*.translation + +# Mono-specific ignores .mono/ data_*/ +mono_crash.* + +# Jetbrain +.idea + +# Macos ------------------------------------------------------------------------ +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# My Export Folder ------------------------------------------------------------------ +*/Export/* + + diff --git a/readme source/game icon.png b/readme source/game icon.png new file mode 100644 index 0000000..fa8768e Binary files /dev/null and b/readme source/game icon.png differ diff --git a/readme source/game title.png b/readme source/game title.png new file mode 100644 index 0000000..593049e Binary files /dev/null and b/readme source/game title.png differ diff --git a/readme source/gameplay demo 1.gif b/readme source/gameplay demo 1.gif new file mode 100644 index 0000000..4b9cd02 Binary files /dev/null and b/readme source/gameplay demo 1.gif differ diff --git a/readme.md b/readme.md index 756247e..a12ab36 100644 --- a/readme.md +++ b/readme.md @@ -1,15 +1,3 @@ - - @@ -20,35 +8,33 @@ *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> -[![Contributors][contributors-shield]][contributors-url] -[![Forks][forks-shield]][forks-url] + [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] -[![LinkedIn][linkedin-shield]][linkedin-url] - +

- - Logo + + Main Logo -

project_title

+

Pac-Pin-Pong

- project_description + A fun local multiplayer game comprising Pacman, Pinball and Space Invader into one
- Explore the docs » + Lean about the game mechanic »

- View Demo + View Demo · - Report Bug + Report Bug · - Request Feature + Request Feature

@@ -85,11 +71,11 @@ ## About The Project -[![Product Name Screen Shot][product-screenshot]](https://example.com) +![game play demo]("readme source/gameplay%20demo%201.gif") Here's a blank template to get started: **To avoid retyping too much info. Do a search and replace with your text editor for the following:** -`LeeTeng2001`, `repo_name`, `twitter_handle`, `email`, `project_title`, `project_description` +`LeeTeng2001`, `Pac-Pin-Pong`, `twitter_handle`, `leeteng2001@gmail.com`, `Pac-Pin-Pong`, `project_description` ### Built With @@ -117,7 +103,7 @@ This is an example of how to list things you need to use the software and how to 1. Clone the repo ```sh - git clone https://github.com/LeeTeng2001/repo_name.git + git clone https://github.com/LeeTeng2001/Pac-Pin-Pong.git ``` 2. Install NPM packages ```sh @@ -138,7 +124,7 @@ _For more examples, please refer to the [Documentation](https://example.com)_ ## Roadmap -See the [open issues](https://github.com/LeeTeng2001/repo_name/issues) for a list of proposed features (and known issues). +See the [open issues](https://github.com/LeeTeng2001/Pac-Pin-Pong/issues) for a list of proposed features (and known issues). @@ -165,9 +151,9 @@ Distributed under the MIT License. See `LICENSE` for more information. ## Contact -Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email +Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - leeteng2001@gmail.com -Project Link: [https://github.com/LeeTeng2001/repo_name](https://github.com/LeeTeng2001/repo_name) +Project Link: [https://github.com/LeeTeng2001/Pac-Pin-Pong](https://github.com/LeeTeng2001/Pac-Pin-Pong) @@ -185,14 +171,14 @@ Project Link: [https://github.com/LeeTeng2001/repo_name](https://github.com/LeeT [contributors-shield]: https://img.shields.io/github/contributors/LeeTeng2001/repo.svg?style=for-the-badge -[contributors-url]: https://github.com/LeeTeng2001/repo_name/graphs/contributors +[contributors-url]: https://github.com/LeeTeng2001/Pac-Pin-Pong/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/LeeTeng2001/repo.svg?style=for-the-badge -[forks-url]: https://github.com/LeeTeng2001/repo_name/network/members +[forks-url]: https://github.com/LeeTeng2001/Pac-Pin-Pong/network/members [stars-shield]: https://img.shields.io/github/stars/LeeTeng2001/repo.svg?style=for-the-badge -[stars-url]: https://github.com/LeeTeng2001/repo_name/stargazers +[stars-url]: https://github.com/LeeTeng2001/Pac-Pin-Pong/stargazers [issues-shield]: https://img.shields.io/github/issues/LeeTeng2001/repo.svg?style=for-the-badge -[issues-url]: https://github.com/LeeTeng2001/repo_name/issues +[issues-url]: https://github.com/LeeTeng2001/Pac-Pin-Pong/issues [license-shield]: https://img.shields.io/github/license/LeeTeng2001/repo.svg?style=for-the-badge -[license-url]: https://github.com/LeeTeng2001/repo_name/blob/master/LICENSE.txt +[license-url]: https://github.com/LeeTeng2001/Pac-Pin-Pong/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/LeeTeng2001