/hampter

Primary LanguageC++GNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Hampter

Useless window to display an image of a hamster.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Hampter Screenshot

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • GCC

    sudo pacman -S gcc
  • wxWidgets

    sudo pacman -S wxgtk2
  • FFmpeg (for linux users only)

    sudo pacman -S ffmpeg

Please note that for the windows executable, there are no prerequisites. For the linux binary you will need FFmpeg and wxWidgets. You won't need GCC because the binary is pre-compiled.

Installation

  1. Clone the repo
    git clone https://github.com/cheezymousehouse825/hampter.git
  2. Enter the directory
    cd hampter
  3. Compile the program
    g++ main.cpp `wx-config --cxxflags --libs` -o hampter

(back to top)

Usage

Execute the program by running start.sh

./start.sh

(back to top)

Roadmap

  • Add More Dialogue
  • Add Sounds
  • [] Multiple Windows
    • [] Multiple Hamsters
    • [] Random Images
  • [] Make it Annoying
    • [] Impossible To Close
    • [] Plays Annoying Noises at Random Times

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  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

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Vaughn MacIntyre - @cheezymh825

Project Link: https://github.com/cheezymousehouse825/hampter

(back to top)

Acknowledgments

(back to top)