Skip to content

Latest commit

 

History

History
298 lines (208 loc) · 10.7 KB

README.md

File metadata and controls

298 lines (208 loc) · 10.7 KB
Raw

Laravel Forge Site Deployment Status

Contributors Forks Stargazers Issues MIT License


Logo

HOPPY COIN

A Phaser 3 game built on the getting started tutorial.
Explore the code »

Play · 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

Product Name Screen Shot

I have always wanted to learn game development, even have RPG Maker collecting dust in Steam.

Finally, started with Phaser 3!

At first, I didn't know what I was doing but eventually got the hang of it.

For this project, I will try to add any mechanic I can think of.

Yes, even cancerous energy systems, abundant currencies, pay-to-win elements, and the infamous double rewards or unlocks after watching ads.

Let's see how far can this go.

So, without further ado, let's code and play!

(back to top)

Built With

  • Phaser
  • Laravel
  • JQuery
  • tailwindcss.com

(back to top)

Getting Started

Clone or download a copy of this project.

  • Clone the git repository via https, ssh or with the GitHub Windows or Mac clients.
  • Download as zip

Prerequisites

At least basic knowledge of HTML, Javascript, CSS and web server for Phaser.

Here are several options:

Installation

Local environment

I personally use Docker/laradock for my environment.

Install docker using Docker Desktop for Windows or install using any package manager you might be using for Linux and Mac.

  1. Clone or download laradock zip
git clone https://github.com/Laradock/laradock.git
  1. Go inside the laradock folder then copy env example to .env
cp .env.example .env
  1. Run your web server
docker-compose up -d nginx
  1. You can now access the game at localhost

GitHub Codespaces

When using Codespaces, after creating a new space, we can run this command to have a new environment ready.

cd public

docker run -p 80:80 -v $(pwd):/usr/share/nginx/html nginx

Roadmap

  • [] Add Changelog
  • [] Fix mobile side of stuff (Currently focusing on desktop)
  • [] Add more stages
  • [] Add more mechanics (In-app purchases(For educational purposes), Power ups, HP, Ads reward, multiplayer)
  • [] Add tutorial
  • [] Add a way to play old versions
  • [] Create new API instances for testing
  • [] Create new repo for the Laravel API
  • [] Add a little story to practice making scenes
  • [] Events (Seasonal and weekly)

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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

John Cosio - [email protected]

Project Link: https://github.com/sudoist/hoppy-coin

(back to top)

Acknowledgments

Thanks and credits for the resources used in this project.

References

Music

Backgrounds

(back to top)