📙 About

Rungeon is an open source puzzle game for the browser that challenges players to use their wits to escape from a variety of themed stages. With a constant flow of new stages being developed, there's always something fresh and exciting for players to explore.

💾 Installation

1. Fork the repository

2. Clone your repository under yourUsername/rungeon

git clone https://github.com/yourUsername/rungeon.git

2. Move into the new folder

cd rungeon

Visual Studio Code:

3. Install "Live Server" extension

4. Go live from the bottom of the window

5. Go to http://localhost:5500 in your browser

Other:

3. Install Node.js
4. Install http-server

npm install http-server -g

5. Run the server

http-server

(back to top)

🤝 Contributing

Refer to the contributing file for a beginner-friendly guide on how you can contribute.

• Suggest changes to existing code
• Improve upon the site
• Add new stages
• Create and solve issues
• Share the repo

(back to top)

🛣️ Roadmap

• [x] Rework stages to be contributing friendly
• [ ] Add achievements
  • [ ] Easter Eggs
• [ ] Multi-language support

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

(back to top)

📜 License

This content is licensed under the GNU Public GPL-3.0 license

(back to top)