Skip to content
Snippets Groups Projects
README.md 1.18 KiB
Newer Older
  • Learn to ignore specific revisions
  • Shrushti Warekar's avatar
    Shrushti Warekar committed
    # VulnVenture
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Description
    The main goal of this game is to educate about responsible disclosure.
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Project Structure
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    - `index.html`: Your game's HTML file.
    
    Venkatesh Mellacheruvu's avatar
    Venkatesh Mellacheruvu committed
    - `game.js`: The JavaScript file for running the Scenes.
    - `Scene1.js` : The Starting Scene.
    - `Scene2.js` : The Play Scene.
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    - `assets/`: A folder containing all game assets like images, sounds, etc.
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Installation
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    Follow these steps to get the game running on your local machine:
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Prerequisites
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    Ensure you have the following installed before proceeding with the setup:
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    - [Phaser.js](https://phaser.io/download)
    - [Python](https://www.python.org/downloads/)
    - A modern web browser capable of running HTML5, such as Google Chrome, Mozilla Firefox, or Microsoft Edge
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Clone the Repository
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    First, clone the repository to your local machine using Git:
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ```bash
    git clone https://git.cs.uni-paderborn.de/swarekar/vulnventure.git 
    cd vulnventure
    ```
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    *How to start the server*
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    1. Open the bash terminal 
    2. Navigate to your project directory.
    2. Execute:
     `python3 -m http.server`
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    *How to launch Web Interface*
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    1. Open a web browser to start the game
    2. Run:
     * http://localhost:8000 
     
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ## Roadmap
    
    Shrushti Warekar's avatar
    Shrushti Warekar committed
    ![Flowchart](images/Flowchart.png)