CodeEsc is a project motivated by a group of contributors who love puzzle solving with a competitive aspect to it. CodeEsc is a puzzle solving desktop application that was made to be played like a game from any PC that downloads it, it is a lightweight application that requires a computer just strong enough to run modern web pages on their browser!
CodeEsc features levels where you have to escape the room you are put into as fast as you can! Look around the room for items which you can interact with and read about while being timed for your speed. Not only is it a fun challenge for your brain, there is also a competitive aspect to it as once you are finished your run, you can submit it to the leaderboards to see how other people did on their first try!
This project is powered by Java while using the Java Swing library and JDBC to connect to our hosted MySql database. No matter where you complete our Escape Room puzzles from, you can be sure you’re always connected to the leaderboards if you want to compete.
Please follow the prerequisites and steps below to install and use CodeEsc.
Step 1: Make sure you have the latest version of JDK (Java Development Kit) installed. You can download JDK here
Step 2: Make sure you have internet access to run CodeEsc, as it requires connection to our online server for SQL database access.
Step 1: Once you have the above prerequisites completed, download any Java IDE of your choosing.
Step 2: Download the CodeEsc folder that is shown above in it's entirety, do not make any changes to it.
Step 3: Import the CodeEsc folder you downloaded in the last step as an existing project into your Java IDE.
Step 4. Run the project from your IDE by pressing the "Run Main" button. It's that simple!
Thank you for wanting to take the time out of your day to contribute to our project!
If you want to contribute then you are free to do so by using our pull request process. Please follow all the guidelines stated below to contribute, thank you!
Step 1. Fork the repository and then clone it.
Step 2. Create a new branch for where you will be making your changes.
Step 3. Make your changes, and make sure all the code you have written is well documented, clean, and readable.
Step 4. After finishing your changes, commit your changes with well formulated commit messages.
Step 5. Push your branch to the repository you forked.
Step 6. Open a pull request and describe the changes you have made in clean detail. We will then review your pull request, thank you!
Here at the CodeEsc project, we have a respectful and welcoming environment, thus every contributor must make participation in following the code of conduct we have listed below to upkeep our welcoming environment.
- Not plagiarizing any code in your contributions
- Using respectful and welcoming language
- Accepting constructive criticism in a positive manner
- Being kind and positive towards other contributors
Any negative or unwanted behaviors will not be welcome in this project. Thank you.