πŸƒβ€β™‚οΈOpen source, puzzle based adventure game in your browser

Overview

πŸƒβ€β™‚οΈ Rungeon

Rungeon is an open source, puzzle based adventure game.

My Skills

Repository version Repository contributors Repository license

πŸ“™ About

Rungeon features a series of puzzles in the form of stages, in which the user relies on their wits to 'escape'. The site offers a sense of customizability with a variety of themes sure to fit a user's preference. We're in an active state of development, always building, and preparing the next rungeon stage as you read!

πŸ’Ύ Installation

  1. Fork the repository fork

  2. Clone your repository under yourUsername/rungeon

git clone https://github.com/yourUsername/rungeon.git
  1. Move into the new folder
cd rungeon
  1. Install dependancies
npm install
  1. Start the local server
npm run start

(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

  • Rework stages to be contributing friendly
  • Add achievements
    • Easter Eggs
  • Add login system
  • 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)

Comments
  • RGB theme is no longer RGB

    RGB theme is no longer RGB

    The RGB theme doesn't actually make any of the stage content RGB. The selectors are there but there's obviously a problem.

    #index.theme-rgb .nav-link,
    #index.theme-rgb .stage .icon,
    #index.theme-rgb .doors i,
    #index.theme-rgb .links i,
    #index.theme-rgb #themePopup,
    #index.theme-rgb #themePopup #closeButton {
      animation: rgb 5s linear infinite !important;
    }
    
    good first issue scope: frontend rungeon: theme type: bug 
    opened by devkennyy 10
  • Achievements

    Achievements

    Todo

    • [x] Allow overflowing achievements to be scrolled by the entire page rather than the achievement container
    • [ ] OnHover descriptions (similar to GitHub's)
    • [ ] Add icons/pictures
    • [ ] Store achievements

    Description

    This PR is built atop the backend PR (#85) and could be the base of an achievement system.

    Changes

    Solves

    Closes #3

    opened by GruelingPine185 8
  • Updated Linting-Formatting

    Updated Linting-Formatting

    Description

    I'm hoping that this provides an adequate solution to #128 make ESLint format.

    In order to tackle this problem, I chose to integrate prettier and couple it with ESLint that is already present in the application. I also installed the eslint-config-prettier library to ensure that prettier and eslint work well together. I then made sure to add a new script npm run format that allows the developer to format all of the files within the application. I adjusted all potential errors so there shouldn't be any when running the format script. I made a small tweak to the ESLint rules in order to get it to stop yelling at everyone and coincide with prettier.

    Changes

    • added Prettier
    • added prettierignore to mimic gitIgnore
    • added prettierrc config file
    • adjusted ESLint rules to cohabitate with Prettier
    • added format script to run formatting for all files within application
    • proofread rungeon.html, files to delete / edit offending pieces of code that caused ESLint to yell

    Solves

    Closes #128

    opened by JScrips 7
  • Stage Remake

    Stage Remake

    Description

    In an effort to rid the codebase of it's intricacy, this PR addresses the following issues:

    • [x] Creating/modifying stages is not scalable or contributor friendly
    • [x] Excessive JS manipulation

    Todo

    • [x] Themes chosen on main page should carry over into game page or vice versa
    • [x] Remove all unnecessary code

    Changes

    Solves

    • #5
    • #31
    scope: frontend status: merge conflict 
    opened by GruelingPine185 7
  • Add a tick indication beside current theme

    Add a tick indication beside current theme

    This was lost in the stage-remake merge and is a change I think we should have. Simply change the text content of the theme title to include a checkmark emoji beside it. Don't forget to clear it when a new theme is set.

    scope: frontend rungeon: theme type: feature request 
    opened by devkennyy 6
  • Theme popup modifications.

    Theme popup modifications.

    image

    The bottom margin should be increased and the height should be increased by roughly 1 pixel. Overall, this needs to be more responsive in case we add more popups. Maybe we should remove all the icons on the page? Would love to hear suggestions.

    image

    good first issue 
    opened by devkennyy 6
  • fix: align content vertically

    fix: align content vertically

    Okay, I've aligned the content vertically by making the navbar position absolute instead of relative. This does mean that I had to override Bootstrap with an id.

    Closes #67

    The content doesn't need to be horizontally aligned. In your previous image, you were comparing the center of the content with the center of the navbar buttons. The actual center of the navbar includes the little drop-down arrow.

    Screen Shot 2022-07-17 at 12 18 05 PM

    So while It may look off center, in the code it's doing what it should.

    Screen Shot 2022-07-17 at 12 37 27 PM

    I can try to shift the navbar over if you want it more aesthetically pleasing. πŸ˜ƒ

    opened by Shabbyconnor 6
  • theme pop-up

    theme pop-up

    Description

    When clicking a theme the pop-up close.

    Changes

    1- Call toggleThemePopup in the setTheme function so when clicking a theme the pop-up close. 2- Remove the if statement that only remove de popup if has in the / or /index.html location.

    Solves

    Issue: https://github.com/devkennyy/rungeon/issues/95

    opened by Davisralves 4
  • Progress bar

    Progress bar

    Description

    Created a progress bar to display the progress through the stages

    Changes

    • Added progress bar
    • Added animation
    • Added visibility toggle button

    To-Do

    Fix the theme error?

    opened by Shabbyconnor 3
  • Add SEO beneficial tags

    Add SEO beneficial tags

    There are a few tags that are pleasing to search engines and crawlers. They are used to rank results to users. Right now, we don't have anything but the title tag. Let's fix that so that way the world will know Rungeon exists.

    good first issue scope: tools 
    opened by GruelingPine185 3
  • New stage(s)

    New stage(s)

    Description

    This PR is going to be a collection of at least one new stage. As the stage-remake branch is coming together quite well, I felt that it could use some new stages to go with it.

    • A new stage that uses a custom cursor to (in theory) act as a magnifying glass to help the user track down missing objects.

    To-Do

    • [ ] Resolve the CSS indexing issue that exposes other HTML elements
    • [ ] Determine the missing objects and generate them
    rungeon: stage status: work in progress 
    opened by GruelingPine185 2
  • Allow players to add custom levels in-game

    Allow players to add custom levels in-game

    That would be a really cool idea. Contributors and players could be able to create levels and add the to the pool of existing levels that other people created. This was just a thought I had...

    rungeon: stage type: feature request 
    opened by GruelingPine185 3
  • Add an alert if icons don't load

    Add an alert if icons don't load

    Some way to notify the user that the link for icons failed to load. The site is heavily based around icons and if they don't load, there's no site. Let them know they can refresh to try again.

    good first issue scope: UI 
    opened by devkennyy 4
  • Themes/styles are out of hand

    Themes/styles are out of hand

    As of now, Rungeon uses 6 different themes (not including the default theme). Certain elements are given colors and styling specific to themes and it creates problems. For example, when implementing new pages, I find myself switching between themes (or working in one that I wasn't the day before due to testing). This makes it difficult when dealing with CSS and colors for obvious reasons. Not to mention, the 404 page has its own theme and styling, which is very different from the game and what I'm currently working on on my fork.

    This also goes with the JS side of things. It took me a literal 10-15mins to find and fix the few broken links JS was manipulating in the public/main.js file. I can only imagine how long it'll take to create a new stage (for both myself and for new contributors). This codebase needs a complete makeover. Rungeon's future depends on it.

    Proposal

    • Stages should be organized in a manner that is both easy to read, write, and manipulate for both contributors and Rungeon. (I'm thinking more along the lines of JS objects or JSON to tackle this)
    • Better documentation/comments. Very Important.
    • Halt on all work on themes until a set style has been established and #49 is patched. We need a consistent development area.
    • Resolve CSS element stylings. For example, <a>...</a> are for links. Why are they styled as if they are buttons?

    These are a few things that stood out, but there are many more opportunities for improvement.

    See Also

    • #121
    • #117
    • #49
    • #114
    • #134
    scope: frontend rungeon: theme status: work in progress type: improvement 
    opened by GruelingPine185 7
Releases(v2.0.0)
  • v2.0.0(Aug 8, 2022)

    Notable Changes:

    Stage rework. Stages and the way the codebase works has been re-introduced to allow for a more friendly developer experience. View the commit to see the list of changes. (Shabbyconnor, GruelingPine185, staranbeer)

    There were quite a few problems with the way we were reading themes so we moved them to a single CSS file of classes. (GruelingPine185)

    Animated progress bar. This replaces the title progress bar and can be toggled in the navbar. (Shabbyconnor)

    Added a linter. ESlint is now there ~~to scream at you~~ for easy bug fixes. (GruelingPine185)

    jQuery. Because of the excessive DOM manipulation, we figured adding jQuery would make it alot less tedious (it does) (Shabbyconnor)

    Stages:

    Various bug fixes and improvements:

    Added default theme to theme list (GruelingPine185) Running instructions for easier usage (GruelingPine185) Close popup menu on side click (jesc70) Themes work on 404 page (GruelingPine185) Added a style guide and updated README Meta tags for more discoverability Updated themes colour pallets

    Future Changes: While I do have exams coming up, there are a few things I plan to implement in the near future:

    • Level system
    • Account system
    • More customization
    • Level editor

    πŸŽ‰ We hit 100 issues/pull requests, a very neat milestone. Thank you all so much for contributing!

    Source code(tar.gz)
    Source code(zip)
  • v1.2.0(Jul 19, 2022)

    Notable Changes:

    Change hosting service. The project is now deployed on Firebase but we still use Github to track issues and accept pull requests.

    Rungeon Domain. Check it out for yourself: rungeon.live

    Added simple backend. As of now, this doesn't actually do anything but we've got it for when we need it. (GruelingPine185)

    Navbar mid game. (Bram280)

    Various bug fixes and improvements:

    Tick indication beside active theme (vbov57) Various style fixes (Qreamville, GruelingPine185) Many theme popup modifications (Shabbyconnor) Fixed typos and grammatical errors (knight-95) Fixed navbar dropdown error (Shabbyconnor) Themes change button colours & navbar

    Thank you all so much for contributing!

    Source code(tar.gz)
    Source code(zip)
  • v1.1.0(Jul 14, 2022)

    Notable Changes:

    Complete stage rework. Stages are now controlled via an index, incremented and decremented according to the navigation buttons. (Andreu-G)

    Themes. You can now change how the pages look via a theme popup on the landing page. Current available themes:

    • serika
    • cobalt
    • hedge
    • passionfruit
    • rgb
    • dots

    No longer using Sass. Sass wasn't living up to what I had expected and only made contributing more complicated.

    Added Stages:

    • 4

    Various bug fixes and improvements:

    Cleaned code and comments (malikhuzafah) Centred stage text vertically (Shabbyconnor) Fixed favicon not showing (Andreu-G) Reset elements when returning to stage (ShaneButtCodeNL) Added a contributing guide

    Thank you all so much for contributing!

    Source code(tar.gz)
    Source code(zip)
VR puzzle game on the web.

Art Salad Not about salads. Art Jigsaw puzzles in VR. On the web. Free and open-source. Art Salad is a website that you can visit in immersive VR (wit

Felix Mariotto 15 Dec 29, 2022
A puzzle game for js13k 2022.

Dying Dreams ...is a puzzle game made for js13k competition (2022). Compiling Tools you need: TypeScript (mandatory) Closure compiler (optional) advzi

Jani NykΓ€nen 77 Dec 8, 2022
A daily print-and-play roguelike adventure you can play offline.

Chronicles of Stampadia A print-and-play roguelike with a new adventure every day! Play today's adventure | Read the manual | Learn how to play | Disc

Francesco Cottone 36 Oct 15, 2022
A sliding puzzle with a Rubik's cube-like feel.

Alok's Sliding Puzzle A sliding puzzle with a Rubik's cube-like feel. Play: https://www.quaxio.com/sliding_puzzle/puzzle.html Screenshot: Building loc

Alok Menghrajani 10 Jun 7, 2022
FCIV.NET is a open source strategy game loosely based on Freeciv

FCIV.NET FCIV.NET is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a

FCIV.NET 13 Nov 22, 2022
Reference for How to Write an Open Source JavaScript Library - https://egghead.io/series/how-to-write-an-open-source-javascript-library

Reference for How to Write an Open Source JavaScript Library The purpose of this document is to serve as a reference for: How to Write an Open Source

Sarbbottam Bandyopadhyay 175 Dec 24, 2022
An Open-Source Platform to certify open-source projects.

OC-Frontend This includes the frontend for Open-Certs. ?? After seeing so many open-source projects being monetized ?? without giving any recognition

Open Certs 15 Oct 23, 2022
Shikhar 4 Oct 9, 2022
This is a project for open source enthusiast who want to contribute to open source in this hacktoberfest 2022. πŸ’» πŸŽ―πŸš€

HACKTOBERFEST-2022-GDSC-IET-LUCKNOW Beginner-Hacktoberfest Need Your first pr for hacktoberfest 2k22 ? come on in About Participate in Hacktoberfest b

null 8 Oct 29, 2022
Michael Schneider 4 Oct 26, 2022
PokemonNFT started as Buildspace Project - "Create your own mini turn-based NFT browser game" - ROSE Emerald Paratime Testnet

Welcome to PokemonNFTGame ?? Buildspace Project - Create your own mini turn-based NFT browser game ✨ Demo Install npm install Usage npm run dev Blockc

Alberto Cruz Luis 7 Oct 3, 2022
JIT Compiler is a open source online code compiler. You can run more than 40+ most popular programming languages in your browser just-in-time using jitcompiler.

JIT Compiler is a open source online code compiler. You can run more than 40+ most popular programming languages in your browser just-in-time using jitcompiler.

Rajkumar Dusad 36 Jan 5, 2023
Free, open source game engine online

microStudio is a free, open source game engine online. It is also a platform to learn and practise programming. microStudio can be used for free at ht

Gilles 719 Dec 30, 2022
Open source API for the awesome Elden Ring game :)

Elden Ring API Description This repository holds the code for Elden Ring API. This consists of a RESTful API and GraphQL API of our beloved FromSoft g

Deliton Junior 137 Jan 6, 2023
An open-source server software for a certain anime game.

Open-Shen An open-source server software for a certain anime gaem. Based off the leaked Pancake and closed-source Bridge servers. You can find the Ope

Magix 68 Dec 10, 2022
Free open-source game cheat for Tanki Online.

shizoval Free open-source game cheat for Tanki Online. snusoedik#4769 Features AirBreak - air walk Clicker - auto use FAK/supplies/mines FPS Up - remo

null 16 Dec 24, 2022
Futuristic tank game. Pure JavaScript with ThreeJS. Open Source

Retro-futuristic tank game. Pure JavaScript with ThreeJS. Open Source SYNTHBLAST.COM Gameplay shoot tanks Run over all yellow pads to advance a level

Brian Risk 107 Dec 11, 2022
This is the open source version of the fan-made game Plants vs Zombies Travel.

Plants vs Zombies Travel β€” A Fan-Made PvZ Game! What's PvZ Travel? Plants vs Zombies Travel ("γ€Šζ€η‰©ε€§ζˆ˜εƒ΅ε°ΈοΌšζ—…θ‘Œγ€‹" in Chinese) is a fan-made PvZ Game, written

JiangNanGame 12 Dec 3, 2022
Slime jumper game is a simple game that requires you to escape from the enemies that come your way.

Slime Jumper What is this game? The slime jumper game is a game with a simple logic (but it was not so easy to do) where you have to escape from the e

Fatih 2 Mar 1, 2022