Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 2.74 KB

README.md

File metadata and controls

113 lines (76 loc) · 2.74 KB
Raw

Logo

PhotoSketch

Hand-drawn Sketch Game Prototyping App.
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

IMAGE ALT TEXT

An app that generates a 2D platform game based on a given hand-drawn sketch.

Built With

Getting Started

Prerequisites

Installation

After installing expo, you can proceed to clone the project:

$ git clone https://github.com/mfrashad/photoSketch.git

Install the dependencies, make sure you have a package manager such as npm or yarn

yarn install

To run the app, make sure your emulator is running or your phone is connected to your pc, then run:

$ expo start

Documentation

Currently the app only support the creation of 2D platform game.

Sketch Format

When drawing the sketch for the game, please follow the following color code:

  • Black: Starting point
  • Green: Ending Point
  • Blue: Obstacles/Ground/Wall
  • Red: Enemy
  • Yellow: Coin
  • Purple: Portal (Work in Progress)

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 / Clone the project (For members that have been given access)
  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

You can drop me a message on my Website.

Contributors

Thanks goes to all these people:

  • Chen Nuode
  • Muhammad Fathy Rashad